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.

CampoTipoDescrição
schema"vw.status/1"Payload schema and version
moduleobrigatóriostringName and version of the sending module, for example voidwatch-feed/0.5.2até 40 caracteres
onlineobrigatóriobooleanThe character is logged in
characterobrigatórioCharacter
character.nameobrigatóriostringCharacter nameaté 30 caracteres
character.vocationstringVocation, for example Elite Knightaté 30 caracteres
character.levelobrigatóriointeger≥ 1, ≤ 5000
character.expobrigatóriointegerTotal experience points≥ 0
posobrigatórioPosition
pos.xobrigatóriointegerMap x≥ 0, ≤ 65535
pos.yobrigatóriointegerMap y≥ 0, ≤ 65535
pos.zobrigatóriointegerFloor, 0 to 15; 7 is ground level≥ 0, ≤ 15
capintegerFree capacity, in oz≥ 0
staminaintegerStamina, in minutes≥ 0, ≤ 2520
expPerHourintegerExp per hour as the client measures it≥ 0
routestringThe loaded cavebot routeaté 80 caracteres
routeOnbooleanThe cavebot is running
labelstringThe 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
labelsMissingstring[]Route parts without a label. check and leave come from bot adapters before version 4até 4 itens
planPlanStateThe bot's plan: a command that acts when the bot reaches a label. An ended plan stays for two minutes
plan.idintegerThe command that started the plan
plan.kindobrigatório"refill" | "go_depot" | "load_route"
plan.routestringThe 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.messagestringaté 200 caracteres
plan.sinceintegerUnix seconds when the plan started
plan.untilintegerUnix seconds when the waiting step gives up as stuck
plan.endedintegerUnix seconds when the plan ended
routesstring[]Every route the bot can loadaté 100 itens
suppliesSupplyItem[]até 60 itens
supplies[].nameobrigatóriostringItem name, as the game writes itaté 60 caracteres
supplies[].haveobrigatóriointegerHow many the character carries, closed bags included where the game said≥ 0
supplies[].wantintegerHow many the bot keeps in stock; missing when the list comes from the use lines≥ 0
suppliesSourcestringbot: the bot's own supply list; used: every item the game's use lines namedaté 20 caracteres
tasksTaskItem[]até 10 itens
tasks[].nameobrigatóriostringItem or creature name, as the game writes itaté 60 caracteres
tasks[].haveobrigatóriointegerHow many the character has now≥ 0
tasks[].wantobrigatóriointegerHow many the bot keeps in stock, or the task goal≥ 0
tasks[].expintegerExp reward for the goal, if the server says≥ 0
tasks[].taskPointsintegerTask points for the goal, if the server has them≥ 0
taskPointsintegerThe task points balance, on servers with task points≥ 0
taskWeekTaskWeekTask points this week, on servers with a weekly cap
taskWeek.earnedobrigatóriointegerTask points earned this week≥ 0
taskWeek.capobrigatóriointegerThe most task points a week allows≥ 0
lootLootItem[]até 200 itens
loot[].nameobrigatóriostringItem nameaté 60 caracteres
loot[].countobrigatóriointegerLooted since the session started≥ 0
loot[].sellintegerNPC price per item, if the module knows it. The server fills it in otherwise≥ 0
usedUsedItem[]Supplies used since the loot counter startedaté 200 itens
used[].nameobrigatóriostringItem nameaté 60 caracteres
used[].countobrigatóriointegerUsed since the counter started≥ 0
used[].buyintegerNPC buy price per item, if the module knows it≥ 0
lootHoursnumberHours since the loot counter started≥ 0
lootSourcestringWhere the loot count comes from: corpse, the loot messages every server sends, or the id of an adapter such as an autolootaté 40 caracteres
skullsSkull[]Skulled players in viewaté 20 itens
skulls[].nameobrigatóriostringPlayer nameaté 30 caracteres
skulls[].skullobrigatório"white" | "red" | "black" | "yellow" | "green" | "orange"Skull colour
skulls[].distintegerSquares away from the character≥ 0, ≤ 100
blessedbooleanOnly on servers with blessings
pzbooleanThe character stands in a protection zone
pzLockbooleanThe character is PZ locked: it cannot enter a protection zone
outfitOutfitThe character's look, drawn on the map
outfit.typeobrigatóriointegerThe look type≥ 0, ≤ 10000
outfit.headinteger≥ 0, ≤ 255
outfit.bodyinteger≥ 0, ≤ 255
outfit.legsinteger≥ 0, ≤ 255
outfit.feetinteger≥ 0, ≤ 255
outfit.addonsinteger≥ 0, ≤ 3
skull"white" | "red" | "black" | "yellow" | "green" | "orange"The character's own skull, if it has one
playersInViewintegerOther players in view≥ 0, ≤ 500
redemptionbooleanOnly on servers with death redemption: it is active now
redemptionLeftintegerOnly on servers with redemption≥ 0
targetOnbooleanThe targeting bot is running
botConfigstringThe bot preset, for example vBot_4.8até 60 caracteres
targetProfilestringThe loaded targeting profileaté 80 caracteres
botProfileintegerThe bot settings profile, for example vBot's 1 to 5≥ 1, ≤ 20
adaptersAdapterState[]The adapters the module runs, and whether each is onaté 30 itens
adapters[].idobrigatóriostringAdapter id, for example orion-ots-tasks or botaté 40 caracteres
adapters[].versionstringaté 20 caracteres
adapters[].onobrigatóriobooleanFalse: the adapter stopped after errors, or the bot stopped attaching
adapters[].wantstringFor the bot adapter: the version the module ships. A lower version waits for a bot reloadaté 20 caracteres
addonsAddonState[]The addons in the data folder, and whether each runsaté 30 itens
addons[].idobrigatóriostringAddon id, for example exiva-map
addons[].versionstringThe module version the addon came withaté 20 caracteres
addons[].onobrigatóriobooleanLoaded now
addons[].errorstringWhy it is not loaded: installing, the download failed, or its last erroraté 200 caracteres
featuresstring[]What the module runs, for example status, captures and commands. The dashboard turns off what is not listed. Left out: everythingaté 20 itens
actionsstring[]The command actions this client can run now, for example toggle_cavebot. The dashboard offers only theseaté 40 itens
settingsChangeobjectA 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.