Dados de status
O corpo de POST /api/v1/status, esquema vw.status/1. Envie com a frequência que a resposta indicar: a cada 2 s enquanto alguém assiste ao personagem, a cada 30 s no resto do tempo. Campos que você não conhece ficam de fora; o painel mostra o que recebe.
| Campo | Tipo | Descrição |
|---|---|---|
schema | "vw.status/1" | Payload schema and version |
moduleobrigatório | string | Name and version of the sending module, for example voidwatch-feed/0.5.2até 40 caracteres |
onlineobrigatório | boolean | The character is logged in |
characterobrigatório | Character | |
character.nameobrigatório | string | Character nameaté 30 caracteres |
character.vocation | string | Vocation, for example Elite Knightaté 30 caracteres |
character.levelobrigatório | integer | ≥ 1, ≤ 5000 |
character.expobrigatório | integer | Total experience points≥ 0 |
posobrigatório | Position | |
pos.xobrigatório | integer | Map x≥ 0, ≤ 65535 |
pos.yobrigatório | integer | Map y≥ 0, ≤ 65535 |
pos.zobrigatório | integer | Floor, 0 to 15; 7 is ground level≥ 0, ≤ 15 |
cap | integer | Free capacity, in oz≥ 0 |
stamina | integer | Stamina, in minutes≥ 0, ≤ 2520 |
expPerHour | integer | Exp per hour as the client measures it≥ 0 |
route | string | The loaded cavebot routeaté 80 caracteres |
routeOn | boolean | The cavebot is running |
label | string | The route label the bot is ataté 40 caracteres |
phase | "hunting" | "to_city" | "in_city" | "to_resp" | "parked" | "stopped" | "unknown" | "town" | "at_check" | "leaving" | Where the character is in its route, from the labels hunt, refill, city and resp: unknown when a label is missing. town, at_check and leaving come from bot adapters before version 4 |
labelsMissing | string[] | Route parts without a label. check and leave come from bot adapters before version 4até 4 itens |
plan | PlanState | The bot's plan: a command that acts when the bot reaches a label. An ended plan stays for two minutes |
plan.id | integer | The command that started the plan |
plan.kindobrigatório | "refill" | "go_depot" | "load_route" | |
plan.route | string | The route a switch loadsaté 80 caracteres |
plan.stateobrigatório | "running" | "done" | "stuck" | "cancelled" | "taken_over" | "failed" | |
plan.step | "hunt" | "city" | "depot" | "switch" | What the running plan waits for |
plan.message | string | até 200 caracteres |
plan.since | integer | Unix seconds when the plan started |
plan.until | integer | Unix seconds when the waiting step gives up as stuck |
plan.ended | integer | Unix seconds when the plan ended |
routes | string[] | Every route the bot can loadaté 100 itens |
supplies | SupplyItem[] | até 60 itens |
supplies[].nameobrigatório | string | Item name, as the game writes itaté 60 caracteres |
supplies[].haveobrigatório | integer | How many the character carries, closed bags included where the game said≥ 0 |
supplies[].want | integer | How many the bot keeps in stock; missing when the list comes from the use lines≥ 0 |
suppliesSource | string | bot: the bot's own supply list; used: every item the game's use lines namedaté 20 caracteres |
tasks | TaskItem[] | até 10 itens |
tasks[].nameobrigatório | string | Item or creature name, as the game writes itaté 60 caracteres |
tasks[].haveobrigatório | integer | How many the character has now≥ 0 |
tasks[].wantobrigatório | integer | How many the bot keeps in stock, or the task goal≥ 0 |
tasks[].exp | integer | Exp reward for the goal, if the server says≥ 0 |
tasks[].taskPoints | integer | Task points for the goal, if the server has them≥ 0 |
taskPoints | integer | The task points balance, on servers with task points≥ 0 |
taskWeek | TaskWeek | Task points this week, on servers with a weekly cap |
taskWeek.earnedobrigatório | integer | Task points earned this week≥ 0 |
taskWeek.capobrigatório | integer | The most task points a week allows≥ 0 |
loot | LootItem[] | até 200 itens |
loot[].nameobrigatório | string | Item nameaté 60 caracteres |
loot[].countobrigatório | integer | Looted since the session started≥ 0 |
loot[].sell | integer | NPC price per item, if the module knows it. The server fills it in otherwise≥ 0 |
used | UsedItem[] | Supplies used since the loot counter startedaté 200 itens |
used[].nameobrigatório | string | Item nameaté 60 caracteres |
used[].countobrigatório | integer | Used since the counter started≥ 0 |
used[].buy | integer | NPC buy price per item, if the module knows it≥ 0 |
lootHours | number | Hours since the loot counter started≥ 0 |
lootSource | string | Where the loot count comes from: corpse, the loot messages every server sends, or the id of an adapter such as an autolootaté 40 caracteres |
skulls | Skull[] | Skulled players in viewaté 20 itens |
skulls[].nameobrigatório | string | Player nameaté 30 caracteres |
skulls[].skullobrigatório | "white" | "red" | "black" | "yellow" | "green" | "orange" | Skull colour |
skulls[].dist | integer | Squares away from the character≥ 0, ≤ 100 |
blessed | boolean | Only on servers with blessings |
pz | boolean | The character stands in a protection zone |
pzLock | boolean | The character is PZ locked: it cannot enter a protection zone |
outfit | Outfit | The character's look, drawn on the map |
outfit.typeobrigatório | integer | The look type≥ 0, ≤ 10000 |
outfit.head | integer | ≥ 0, ≤ 255 |
outfit.body | integer | ≥ 0, ≤ 255 |
outfit.legs | integer | ≥ 0, ≤ 255 |
outfit.feet | integer | ≥ 0, ≤ 255 |
outfit.addons | integer | ≥ 0, ≤ 3 |
skull | "white" | "red" | "black" | "yellow" | "green" | "orange" | The character's own skull, if it has one |
playersInView | integer | Other players in view≥ 0, ≤ 500 |
redemption | boolean | Only on servers with death redemption: it is active now |
redemptionLeft | integer | Only on servers with redemption≥ 0 |
targetOn | boolean | The targeting bot is running |
botConfig | string | The bot preset, for example vBot_4.8até 60 caracteres |
targetProfile | string | The loaded targeting profileaté 80 caracteres |
botProfile | integer | The bot settings profile, for example vBot's 1 to 5≥ 1, ≤ 20 |
adapters | AdapterState[] | The adapters the module runs, and whether each is onaté 30 itens |
adapters[].idobrigatório | string | Adapter id, for example orion-ots-tasks or botaté 40 caracteres |
adapters[].version | string | até 20 caracteres |
adapters[].onobrigatório | boolean | False: the adapter stopped after errors, or the bot stopped attaching |
adapters[].want | string | For the bot adapter: the version the module ships. A lower version waits for a bot reloadaté 20 caracteres |
addons | AddonState[] | The addons in the data folder, and whether each runsaté 30 itens |
addons[].idobrigatório | string | Addon id, for example exiva-map |
addons[].version | string | The module version the addon came withaté 20 caracteres |
addons[].onobrigatório | boolean | Loaded now |
addons[].error | string | Why it is not loaded: installing, the download failed, or its last erroraté 200 caracteres |
features | string[] | What the module runs, for example status, captures and commands. The dashboard turns off what is not listed. Left out: everythingaté 20 itens |
actions | string[] | The command actions this client can run now, for example toggle_cavebot. The dashboard offers only theseaté 40 itens |
settingsChange | object | A change from the Settings tab of the Voidwatch window: {rev, values}. The values follow the rules of the Clients page. A bad value never refuses the status: settingsSaved in the reply says why |
Exemplo
{
"schema": "vw.status/1",
"module": "voidwatch-feed/0.5.2",
"online": true,
"character": {
"name": "Franz Kafka",
"vocation": "Royal Paladin",
"level": 589,
"exp": 3380000000
},
"pos": {
"x": 32376,
"y": 31779,
"z": 7
},
"cap": 8568,
"stamina": 2502,
"expPerHour": 14998739,
"route": "[afk] fu.exodar HH",
"routeOn": true,
"label": "hunt",
"routes": [
"[afk] fu.exodar HH",
"UD & HH Left"
],
"supplies": [
{
"name": "great spirit potion",
"have": 3498,
"want": 4000
}
],
"tasks": [
{
"name": "hellhound",
"have": 578,
"want": 1000
}
],
"loot": [
{
"name": "fire sword",
"count": 192
}
],
"lootHours": 2.4,
"skulls": []
}Versões
O nome do esquema traz a versão. Um campo novo mantém a versão; um campo alterado ou removido ganha uma nova, e a antiga continua funcionando por pelo menos seis meses.