690 lines
17 KiB
TypeScript
690 lines
17 KiB
TypeScript
// Code generated from schemas/protocol.json. DO NOT EDIT.
|
|
export interface Protocol {
|
|
catalog?: ContentCatalog;
|
|
catalogChange?: ContentChange;
|
|
catalogPreview?: ContentPreview;
|
|
catalogResult?: ContentResult;
|
|
craftRequest?: CraftRequest;
|
|
craftResult?: CraftResult;
|
|
intent: Intent;
|
|
snapshot: Snapshot;
|
|
}
|
|
|
|
export interface ContentCatalog {
|
|
combat?: CombatContent;
|
|
crafting?: CraftingContent;
|
|
effectSets?: EffectSet[];
|
|
gathering?: GatheringContent;
|
|
items: ItemDefinition[];
|
|
requirementSets?: RequirementSet[];
|
|
stats: ContentStatsRules;
|
|
titles: TitleDefinition[];
|
|
version: number;
|
|
}
|
|
|
|
export interface CombatContent {
|
|
attacks: CombatAttack[];
|
|
loot: LootTable[];
|
|
mobs: MobDefinition[];
|
|
spawns: MobSpawn[];
|
|
}
|
|
|
|
export interface CombatAttack {
|
|
cooldown: number;
|
|
delivery: string;
|
|
description: string;
|
|
dexteritySpeed?: number;
|
|
duration: number;
|
|
effect: string;
|
|
id: string;
|
|
interval: number;
|
|
multiplier: number;
|
|
name: string;
|
|
radius: number;
|
|
range: number;
|
|
speed: number;
|
|
stamina: number;
|
|
stat: string;
|
|
strengthSpeed?: number;
|
|
}
|
|
|
|
export interface LootTable {
|
|
description: string;
|
|
entries: LootEntry[];
|
|
id: string;
|
|
name: string;
|
|
}
|
|
|
|
export interface LootEntry {
|
|
amount: number;
|
|
chance: number;
|
|
group: string;
|
|
item: string;
|
|
weight: number;
|
|
}
|
|
|
|
export interface MobDefinition {
|
|
aggroRange: number;
|
|
attackId: string;
|
|
behavior: string;
|
|
damage: number;
|
|
defence: number;
|
|
description: string;
|
|
hp: number;
|
|
id: string;
|
|
leashRange: number;
|
|
level: number;
|
|
lootId: string;
|
|
model: string;
|
|
name: string;
|
|
scalePerDay: number;
|
|
speed: number;
|
|
xp: number;
|
|
}
|
|
|
|
export interface MobSpawn {
|
|
biomes: string[];
|
|
count: number;
|
|
description: string;
|
|
id: string;
|
|
minPlayerDistance: number;
|
|
mobId: string;
|
|
name: string;
|
|
radius: number;
|
|
respawn: number;
|
|
x: number;
|
|
z: number;
|
|
}
|
|
|
|
export interface CraftingContent {
|
|
materials: CraftMaterial[];
|
|
professions: GatheringSkill[];
|
|
recipes: CraftRecipe[];
|
|
rules: CraftRules;
|
|
}
|
|
|
|
export interface CraftMaterial {
|
|
description: string;
|
|
id: string;
|
|
name: string;
|
|
}
|
|
|
|
export interface GatheringSkill {
|
|
baseXp: number;
|
|
description: string;
|
|
id: string;
|
|
maxLevel: number;
|
|
name: string;
|
|
xpPerLevel: number;
|
|
}
|
|
|
|
export interface CraftRecipe {
|
|
description: string;
|
|
id: string;
|
|
inputs: { [key: string]: number };
|
|
level: number;
|
|
name: string;
|
|
outputs: { [key: string]: number };
|
|
profession: string;
|
|
revision: number;
|
|
stats: { [key: string]: number };
|
|
titles: string[];
|
|
xp: number;
|
|
}
|
|
|
|
export interface CraftRules {
|
|
baseFailure: number;
|
|
baseLoss: number;
|
|
cooldown: number;
|
|
lossDecay: number;
|
|
maxFailure: number;
|
|
maxQualityBias: number;
|
|
minFailure: number;
|
|
minLoss: number;
|
|
overLevelDecay: number;
|
|
qualityPerLevel: number;
|
|
underLevelGrowth: number;
|
|
}
|
|
|
|
export interface EffectSet {
|
|
description: string;
|
|
id: string;
|
|
modifiers: StatModifier[];
|
|
name: string;
|
|
}
|
|
|
|
export interface StatModifier {
|
|
flat: number;
|
|
percent: number;
|
|
skill?: string;
|
|
stat: string;
|
|
}
|
|
|
|
export interface GatheringContent {
|
|
biomeHistory?: BiomeDefinition[];
|
|
biomes: BiomeDefinition[];
|
|
consumables: GatheringConsumable[];
|
|
resources: ResourceDefinition[];
|
|
skills: GatheringSkill[];
|
|
}
|
|
|
|
export interface BiomeDefinition {
|
|
color: string;
|
|
description: string;
|
|
id: string;
|
|
name: string;
|
|
resources?: string[] | null;
|
|
revision?: number;
|
|
weight: number;
|
|
}
|
|
|
|
export interface GatheringConsumable {
|
|
description: string;
|
|
id: string;
|
|
modifiers: StatModifier[];
|
|
name: string;
|
|
seconds: number;
|
|
}
|
|
|
|
export interface ResourceDefinition {
|
|
amount: number;
|
|
biomes: string[];
|
|
density: number;
|
|
description: string;
|
|
id: string;
|
|
model: string;
|
|
name: string;
|
|
output: string;
|
|
requiredLevel: number;
|
|
respawnSeconds: number;
|
|
seconds: number;
|
|
skillId: string;
|
|
xp: number;
|
|
}
|
|
|
|
export interface ItemDefinition {
|
|
attackId?: string;
|
|
craftPool?: CraftStat[];
|
|
craftRolls?: number;
|
|
description: string;
|
|
dropChance: number;
|
|
id: string;
|
|
modifiers: StatModifier[];
|
|
name: string;
|
|
requirements: ItemRequirements;
|
|
slot: string;
|
|
weight: number;
|
|
}
|
|
|
|
export interface CraftStat {
|
|
max: number;
|
|
min: number;
|
|
percent: boolean;
|
|
stat: string;
|
|
weight: number;
|
|
}
|
|
|
|
export interface ItemRequirements {
|
|
level: number;
|
|
stats: { [key: string]: number };
|
|
titles: string[];
|
|
}
|
|
|
|
export interface RequirementSet {
|
|
description: string;
|
|
id: string;
|
|
name: string;
|
|
requirements: ContentRequirement[];
|
|
}
|
|
|
|
export interface ContentRequirement {
|
|
atLeast: number;
|
|
metric: string;
|
|
}
|
|
|
|
export interface ContentStatsRules {
|
|
base: { [key: string]: number };
|
|
coefficients: { [key: string]: { [key: string]: number } };
|
|
version: number;
|
|
}
|
|
|
|
export interface TitleDefinition {
|
|
description: string;
|
|
effects: TitleEffects;
|
|
id: string;
|
|
name: string;
|
|
requirements: ContentRequirement[];
|
|
scope: string;
|
|
}
|
|
|
|
export interface TitleEffects {
|
|
damage: number;
|
|
modifiers: StatModifier[];
|
|
moveSpeed: number;
|
|
}
|
|
|
|
export interface ContentChange {
|
|
attack?: CombatAttackDraft;
|
|
biome?: BiomeDefinitionDraft;
|
|
consumable?: GatheringConsumableDraft;
|
|
craftMaterial?: CraftMaterialDraft;
|
|
craftProfession?: GatheringSkillDraft;
|
|
craftRecipe?: CraftRecipeDraft;
|
|
craftRules?: CraftRules;
|
|
effectSet?: EffectSetDraft;
|
|
effectSetIds?: string[];
|
|
expectedVersion: number;
|
|
gatheringSkill?: GatheringSkillDraft;
|
|
id: string;
|
|
item?: ItemDraft;
|
|
loot?: LootTableDraft;
|
|
mob?: MobDefinitionDraft;
|
|
op: string;
|
|
reason: string;
|
|
requirementSet?: RequirementSetDraft;
|
|
requirementSetIds?: string[];
|
|
resource?: ResourceDefinitionDraft;
|
|
spawn?: MobSpawnDraft;
|
|
stats?: ContentStatsRules;
|
|
targetId?: string;
|
|
title?: TitleDraft;
|
|
}
|
|
|
|
export interface CombatAttackDraft {
|
|
cooldown: number;
|
|
delivery: string;
|
|
description: string;
|
|
dexteritySpeed?: number;
|
|
duration: number;
|
|
effect: string;
|
|
id?: string;
|
|
interval: number;
|
|
multiplier: number;
|
|
name: string;
|
|
radius: number;
|
|
range: number;
|
|
speed: number;
|
|
stamina: number;
|
|
stat: string;
|
|
strengthSpeed?: number;
|
|
}
|
|
|
|
export interface BiomeDefinitionDraft {
|
|
color: string;
|
|
description: string;
|
|
id?: string;
|
|
name: string;
|
|
resources?: string[] | null;
|
|
revision?: number;
|
|
weight: number;
|
|
}
|
|
|
|
export interface GatheringConsumableDraft {
|
|
description: string;
|
|
id?: string;
|
|
modifiers: StatModifier[];
|
|
name: string;
|
|
seconds: number;
|
|
}
|
|
|
|
export interface CraftMaterialDraft {
|
|
description: string;
|
|
id?: string;
|
|
name: string;
|
|
}
|
|
|
|
export interface GatheringSkillDraft {
|
|
baseXp: number;
|
|
description: string;
|
|
id?: string;
|
|
maxLevel: number;
|
|
name: string;
|
|
xpPerLevel: number;
|
|
}
|
|
|
|
export interface CraftRecipeDraft {
|
|
description: string;
|
|
id?: string;
|
|
inputs: { [key: string]: number };
|
|
level: number;
|
|
name: string;
|
|
outputs: { [key: string]: number };
|
|
profession: string;
|
|
revision?: number;
|
|
stats: { [key: string]: number };
|
|
titles: string[];
|
|
xp: number;
|
|
}
|
|
|
|
export interface EffectSetDraft {
|
|
description: string;
|
|
id?: string;
|
|
modifiers: StatModifier[];
|
|
name: string;
|
|
}
|
|
|
|
export interface ItemDraft {
|
|
attackId?: string;
|
|
craftPool?: CraftStat[];
|
|
craftRolls?: number;
|
|
description: string;
|
|
dropChance: number;
|
|
id?: string;
|
|
modifiers: StatModifier[];
|
|
name: string;
|
|
requirements: ItemRequirements;
|
|
slot: string;
|
|
weight: number;
|
|
}
|
|
|
|
export interface LootTableDraft {
|
|
description: string;
|
|
entries: LootEntry[];
|
|
id?: string;
|
|
name: string;
|
|
}
|
|
|
|
export interface MobDefinitionDraft {
|
|
aggroRange: number;
|
|
attackId: string;
|
|
behavior: string;
|
|
damage: number;
|
|
defence: number;
|
|
description: string;
|
|
hp: number;
|
|
id?: string;
|
|
leashRange: number;
|
|
level: number;
|
|
lootId: string;
|
|
model: string;
|
|
name: string;
|
|
scalePerDay: number;
|
|
speed: number;
|
|
xp: number;
|
|
}
|
|
|
|
export interface RequirementSetDraft {
|
|
description: string;
|
|
id?: string;
|
|
name: string;
|
|
requirements: ContentRequirement[];
|
|
}
|
|
|
|
export interface ResourceDefinitionDraft {
|
|
amount: number;
|
|
biomes: string[];
|
|
density: number;
|
|
description: string;
|
|
id?: string;
|
|
model: string;
|
|
name: string;
|
|
output: string;
|
|
requiredLevel: number;
|
|
respawnSeconds: number;
|
|
seconds: number;
|
|
skillId: string;
|
|
xp: number;
|
|
}
|
|
|
|
export interface MobSpawnDraft {
|
|
biomes: string[];
|
|
count: number;
|
|
description: string;
|
|
id?: string;
|
|
minPlayerDistance: number;
|
|
mobId: string;
|
|
name: string;
|
|
radius: number;
|
|
respawn: number;
|
|
x: number;
|
|
z: number;
|
|
}
|
|
|
|
export interface TitleDraft {
|
|
description: string;
|
|
effects: TitleEffects;
|
|
id?: string;
|
|
name: string;
|
|
requirements: ContentRequirement[];
|
|
scope: string;
|
|
}
|
|
|
|
export interface ContentPreview {
|
|
basedOnVersion: number;
|
|
proposedVersion: number;
|
|
resolved: ContentChange;
|
|
}
|
|
|
|
export interface ContentResult {
|
|
id: string;
|
|
version: number;
|
|
}
|
|
|
|
export interface CraftRequest {
|
|
characterId: string;
|
|
id: string;
|
|
ingredients: { [key: string]: number };
|
|
profession: string;
|
|
}
|
|
|
|
export interface CraftResult {
|
|
consumed: { [key: string]: number };
|
|
created: string[];
|
|
id: string;
|
|
message: string;
|
|
recipe?: KnownRecipe;
|
|
success: boolean;
|
|
valid: boolean;
|
|
}
|
|
|
|
export interface KnownRecipe {
|
|
discoveredAt: number;
|
|
recipe: CraftRecipe;
|
|
}
|
|
|
|
export interface Intent {
|
|
op: string;
|
|
seq: number;
|
|
slot: string;
|
|
target: string;
|
|
x: number;
|
|
z: number;
|
|
}
|
|
|
|
export interface Snapshot {
|
|
chunkKeys: string[];
|
|
chunks: Chunk[];
|
|
entities: Entity[];
|
|
gatherRisks?: { [key: string]: GatheringRisk };
|
|
message: string;
|
|
projectileVisuals?: ProjectileVisual[];
|
|
self: Character;
|
|
tick: number;
|
|
type: string;
|
|
unavailableResources: string[];
|
|
version: number;
|
|
world: WorldInfo;
|
|
}
|
|
|
|
export interface Chunk {
|
|
biome: string;
|
|
color?: string;
|
|
heights: number[];
|
|
key: string;
|
|
resolution: number;
|
|
resources: Entity[];
|
|
size: number;
|
|
x: number;
|
|
z: number;
|
|
}
|
|
|
|
export interface Entity {
|
|
hp: number;
|
|
id: string;
|
|
kind: string;
|
|
maxHp: number;
|
|
model?: string;
|
|
name: string;
|
|
position: Vec3;
|
|
radius?: number;
|
|
requiredLevel?: number;
|
|
resourceId?: string;
|
|
skillId?: string;
|
|
state: string;
|
|
}
|
|
|
|
export interface Vec3 {
|
|
x: number;
|
|
y: number;
|
|
z: number;
|
|
}
|
|
|
|
export interface GatheringRisk {
|
|
allowed: boolean;
|
|
damage: number;
|
|
destruction: number;
|
|
failure: number;
|
|
negative: number;
|
|
seconds: number;
|
|
}
|
|
|
|
export interface ProjectileVisual {
|
|
at: number;
|
|
destination: Vec3;
|
|
id: string;
|
|
outcome: string;
|
|
phase: string;
|
|
position: Vec3;
|
|
projectileId: string;
|
|
speed: number;
|
|
}
|
|
|
|
export interface Character {
|
|
ack: number;
|
|
allocatedStats: { [key: string]: number };
|
|
attack?: CombatAttack;
|
|
carryWeight: number;
|
|
consumables?: GatheringConsumable[];
|
|
craftedStacks?: CraftedStack[];
|
|
crafting?: { [key: string]: CraftProgress };
|
|
discoveredRecipes?: { [key: string]: KnownRecipe };
|
|
entity: Entity;
|
|
equipment: { [key: string]: string };
|
|
experience: number;
|
|
experienceToNextLevel: number;
|
|
gatherAttempt: number;
|
|
gathering?: { [key: string]: SkillProgress };
|
|
gatheringEffects?: TimedGatheringEffect[];
|
|
hasKeystone: boolean;
|
|
healthChoices: number;
|
|
inventory: { [key: string]: number };
|
|
items: ItemInstance[];
|
|
kills: number;
|
|
level: number;
|
|
mana: number;
|
|
manaChoices: number;
|
|
pendingVitalChoices: number;
|
|
playedSeconds: number;
|
|
remainingSeconds: number;
|
|
skills: { [key: string]: number };
|
|
stackNames?: { [key: string]: string };
|
|
stamina: number;
|
|
statPoints: number;
|
|
stats: { [key: string]: StatValue };
|
|
titles: TitleAward[];
|
|
}
|
|
|
|
export interface CraftedStack {
|
|
id: string;
|
|
item: string;
|
|
provenance: CraftProvenance;
|
|
quantity: number;
|
|
}
|
|
|
|
export interface CraftProvenance {
|
|
at: number;
|
|
characterId: string;
|
|
crafterName: string;
|
|
level: number;
|
|
profession: string;
|
|
recipeId: string;
|
|
recipeRevision: number;
|
|
worldId: string;
|
|
}
|
|
|
|
export interface CraftProgress {
|
|
id: string;
|
|
level: number;
|
|
lossPercent: number;
|
|
name: string;
|
|
xp: number;
|
|
xpToNextLevel: number;
|
|
}
|
|
|
|
export interface SkillProgress {
|
|
effectiveLevel: number;
|
|
experience: StatValue;
|
|
level: number;
|
|
levelValue: StatValue;
|
|
name: string;
|
|
speed: StatValue;
|
|
xp: number;
|
|
xpToNextLevel: number;
|
|
yield: StatValue;
|
|
}
|
|
|
|
export interface StatValue {
|
|
base: number;
|
|
final: number;
|
|
flat: number;
|
|
percent: number;
|
|
}
|
|
|
|
export interface TimedGatheringEffect {
|
|
expiresAt: number;
|
|
modifiers: StatModifier[];
|
|
name: string;
|
|
source: string;
|
|
}
|
|
|
|
export interface ItemInstance {
|
|
attack?: CombatAttack;
|
|
definitionId: string;
|
|
description: string;
|
|
equippable: boolean;
|
|
id: string;
|
|
modifiers: StatModifier[];
|
|
name: string;
|
|
provenance?: CraftProvenance;
|
|
requirementMessage: string;
|
|
requirements: ItemRequirements;
|
|
slot: string;
|
|
weight: number;
|
|
}
|
|
|
|
export interface TitleAward {
|
|
description: string;
|
|
earnedAt: string;
|
|
effects: TitleEffects;
|
|
id: string;
|
|
name: string;
|
|
scope: string;
|
|
worldId: string;
|
|
}
|
|
|
|
export interface WorldInfo {
|
|
ageSeconds: number;
|
|
bossHp: number;
|
|
bossInSeconds: number;
|
|
bossMaxHp: number;
|
|
capacity: number;
|
|
collapseInSeconds: number;
|
|
id: string;
|
|
kind?: string;
|
|
online: number;
|
|
phase: string;
|
|
radius: number;
|
|
safeRadius: number;
|
|
seed: number;
|
|
}
|