Smooth

A living object (a speaking item) says one of its lines in chat. Kind event · Area Game.Living.Object A living object (an item with its own mood and lines) talks in chat. TO SHOW IT 1. Look LivingObjectMessageEvent.message_id up in the speaking-item texts game data (SpeakingItemsTexts) to get the line. 2. Print <owner_name>: <line>, as the client does, with LivingObjectMessageEvent.owner_name as the speaker. 3. LivingObjectMessageEvent.timestamp dates the line in the chat header. Ignore every other member: the client never reads it. When you may send it Requires character_loaded inferred Related messages Unsolicited - nothing you send causes this the server makes a worn living object speak on its own; nothing requests it Fields #FieldTypeMeaningYou set it 1message_idint32Which line the object says. (speaking item text id) An id of the SpeakingItemsTexts game data; its textId is the localized line.never 2owner_namestringThe speaker shown before the line. The client prints <owner_name>: <line> and puts it in the chat header as the sender.never 3timestampint64When the line was said. Fills the chat header's time, the slot a channel message fills with its parsed date.never

A player on your map starts or stops offering to craft for others, with their craft skills. Kind event · Area Game.Job A player on your map offers (or stops offering) to craft for other players. The server sends it right after a player appears on the map, and when they toggle the option. WHAT TO DO WHEN YOU RECEIVE IT 1. Read JobMultiCraftStateEvent.player_skills (PlayerSkills): the player and their craft skills. 2. If JobMultiCraftStateEvent.enabled is true, record that player as an available crafter with those skills; if false, remove them. 3. SEND NOTHING BACK. When you may send it Requires roleplay_context inferred Related messages Unsolicited - nothing you send causes this sent when a player on the map is shown or toggles crafting for others Fields #FieldTypeMeaningYou set it 1player_skillsPlayerSkillsThe player and their craft skills. A PlayerSkills.never 2enabledboolTrue when the player offers to craft for others; false when they stop. False removes the player from the available crafters.never

The character's crafter directory settings, one entry per job. Kind event · Area Game.Job The character's crafter directory settings: for each job, the minimum level of the items it crafts for others and whether it crafts for free. WHAT TO DO WHEN YOU RECEIVE IT 1. For each element of JobCrafterDirectorySettingsEvent.settings, store JobCrafterDirectorySettings.min_level and JobCrafterDirectorySettings.free under its JobCrafterDirectorySettings.job_id, replacing what you had for that job. 2. SEND NOTHING BACK. To change a setting, the client sends JobCrafterDirectorySettingsRequest with one JobCrafterDirectorySettings. When you may send it Requires context_ready inferred Related messages Unsolicited - nothing you send causes this the server sends it with the character's job data, and after a settings change Fields #FieldTypeMeaningYou set it 1settingsrepeated JobCrafterDirectorySettingsOne settings entry per job. Elements are JobCrafterDirectorySettings.never

One job's crafter directory settings: the job, the minimum item level and free crafting. Kind struct · Area Game.Job One job's crafter directory settings. - JobCrafterDirectorySettings.job_id: the job. - JobCrafterDirectorySettings.min_level: the minimum level of the items the character agrees to craft for others with this job. - JobCrafterDirectorySettings.free: true when it crafts for free. The fourth declared int32 is never read nor written by the client: leave it at 0. Not sent on its own — a record carried by JobCrafterDirectorySettingsEvent.settings. proven Used by JobCrafterDirectorySettingsEvent Fields #FieldTypeMeaningYou set it 1min_levelint32The minimum level of the items crafted for others. Kept in the client's CrafterDirectory.minLevel.always 2job_idint32The job. The UI passes the job wrapper's id.always 3freeboolTrue when the character crafts for free. Kept in CrafterDirectory.free; set from the 'free craft' checkbox.always

How many of one item sit in one of the character's storages, so a single stack can be reported per location. Kind struct · Area Game.Common The record's name is Ankama's: the client's type-name table spells InventoryQuantity (see the reverse-engineering notes). Both MEMBERS and ObjectStorageKind with all of its values are still our descriptive labels, derived from proven client behaviour: no oracle names them. The BEHAVIOUR below is proven; those spellings are not. ObjectItem carries a repeated list of these, which is how one stack is reported as, say, 3 in the inventory and 20 in the bank at the same time. The client sums nothing for you: it switches on storage and folds each count into a separate counter. AN ENTRY WHOSE STORAGE IS UNSPECIFIED IS SILENTLY DROPPED by the client, so do not treat the list as exhaustive of the item's true total. Not sent on its own — it is only ever reached as an element of ObjectItem.storage_quantities. proven Used by ObjectItem ObjectQuantityEvent Fields #FieldTypeMeaningYou set it 1quantityint32How many units of the item are held in the storage named beside it. WE CHOSE THIS NAME. Proven as the count the client folds into one of three tooltip counters.never 4storageObjectStorageKindWhich of the character's storages this count belongs to. WE CHOSE THIS NAME. See ObjectStorageKind.never

One follower's look and its position in the line of followers. Kind struct · Area Game.Common 1. IndexedEntityLook.look: the follower's EntityLook. 2. IndexedEntityLook.index: its position in the line. 3. Ignore the other int32 and the decoy_3Type member. Not sent on its own — a record carried by FollowingCharactersOption.following_characters_looks, never sent on its own. proven Used by FollowingCharactersOption Fields #FieldTypeMeaningYou set it 1lookEntityLookThe follower's appearance. See EntityLook.never 4indexint32The follower's position in the line.never

A character on the map: account, alignment, gender, account role, restrictions and look options. Kind struct · Area Game.Common The character half of NamedActor. HOW TO READ IT 1. Humanoid.account_id identifies the player's ACCOUNT (not the character: the character is the actor id of ActorPositionInformation). 2. Humanoid.alignment_information, Humanoid.gender and Humanoid.hierarchy (ROLE_PLAYER for an ordinary player) describe the character and its account. 3. Humanoid.restrictions lists what the character may not do or undergo (Restriction). 4. Humanoid.options is a list of HumanOption: guild, alliance, title, ornament, emote in progress, speed... Apply every option; an option absent from the list is OFF. 5. Humanoid.mutant_information is set when the character is transformed into a monster. 6. Ignore the empty decoy_3Type member. Not sent on its own — a record carried by NamedActor.humanoid_information, never sent on its own. proven Used by NamedActor Fields #FieldTypeMeaningYou set it 1optionsrepeated HumanOptionThe character's look options: guild, alliance, title, ornament, emote, speed... A list of HumanOption; an option missing from the list is off.never 2account_idint64The player's account id (not the character id). Observed: 177228328never 3hierarchyHierarchyThe account's role: ROLE_PLAYER for an ordinary player, or a staff role. Observed: ROLE_PLAYER A Hierarchy. Invented name: absent from beta's Humanoid; named after its type.never 4mutant_informationMutantInformationSet when the character is transformed into a monster. See MutantInformation.never 5restrictionsrepeated RestrictionWhat the character may not do or undergo right now. A list of Restriction; values not named.never 6alignment_informationAlignmentInformationThe character's alignment and level. See AlignmentInformation.never 7genderGenderThe character's gender. A Gender: MALE or FEMALE.never

One look option of a character on the map: guild, alliance, title, ornament, emote, speed, followers... Kind struct · Area Game.Common One element of Humanoid.options. Exactly one branch of option is set. HOW TO READ IT 1. guild_information: the character's guild (id, name, level, emblem). 2. alliance_information (AllianceOption): its alliance and whether it can be attacked. 3. title_option (TitleOption) / ornament_option (OrnamentOption): the title and ornament shown with the name. 4. emote_option (EmoteOption): an emote the character is playing right now. 5. object_use_option (ObjectUseOption) / skill_use_option (SkillUseOption): an item or an interactive element the character is busy using, and until when. 6. followers (FollowingCharactersOption): the looks of the characters following it. 7. speed_multiplier: the character's movement speed factor (1 = normal). Not sent on its own — a record carried by Humanoid.options, never sent on its own. proven Used by Humanoid Fields #FieldTypeMeaningYou set it 1title_optionTitleOptionSet when the character shows a title. See TitleOption.never 2object_use_optionObjectUseOptionSet while the character is using an item. See ObjectUseOption.never 3speed_multiplierint32The character's movement speed factor. Observed: 1 1 is the normal speed.never 4alliance_informationAllianceOptionSet when the character is in an alliance. See AllianceOption.never 5skill_use_optionSkillUseOptionSet while the character is using an interactive element. See SkillUseOption.never 6ornament_optionOrnamentOptionSet when the character shows an ornament. See OrnamentOption.never 7followersFollowingCharactersOptionSet when characters follow this one: their looks. See FollowingCharactersOption.never 8emote_optionEmoteOptionSet while the character plays an emote. See EmoteOption.never 9guild_informationtype not documented yetSet when the character is in a guild: the guild's id, name, level and emblem. A GuildInformation record (no signature yet).never

The haven bag theme packs the account owns. Kind event · Area Game.HavenBag Lists the haven bag theme packs the account owns. WHAT TO DO WHEN YOU RECEIVE IT 1. Replace your list of owned packs with HavenBagPackListEvent.packs_id. Ignore a -1 entry, as the client does. 2. SEND NOTHING BACK. The declared list of int64 is never read by the client: ignore it. When you may send it Requires context_ready inferred Related messages Unsolicited - nothing you send causes this the server sends it with the character's login data Fields #FieldTypeMeaningYou set it 2packs_idrepeated int32The ids of the haven bag theme packs owned. A -1 entry is dropped by the client.never

The looks of the characters following a character (its followers), by position. Kind struct · Area Game.Common 1. Draw one follower per IndexedEntityLook in FollowingCharactersOption.following_characters_looks, at its index in the line. 2. Ignore the int64 member: the client never reads it. Not sent on its own — a record carried by HumanOption.followers, never sent on its own. proven Used by HumanOption Fields #FieldTypeMeaningYou set it 1following_characters_looksrepeated IndexedEntityLookThe followers' looks, each with its position. A list of IndexedEntityLook.never

Who a fight result line is about: the fighter id, whether it is alive, and its kind. Kind struct · Area Game.Fight Identifies the fighter of one FightResultListEntry. HOW TO READ IT 1. FighterListEntry.fighter_id is the fighter's id: compare it with your character id to find your own line. 2. FighterListEntry.alive is false for a fighter that died in the fight (the result screen shows a death icon on its line). 3. Exactly one member of FighterListEntry.complement is set and tells the kind: - FighterListEntry.player_list_entry: a player character (level, experience, PvP); - FighterListEntry.mutant_list_entry: a mutant (level only); - FighterListEntry.tax_collector_list_entry: a tax collector (its alliance). None set: a monster or companion; look its name up by id in the game data. Not sent on its own — it is only ever FightResultListEntry.fighter_list_entry. proven Used by FightResultListEntry Fields #FieldTypeMeaningYou set it 2aliveboolTrue when the fighter is still alive at the end of the fight. The result screen shows a death icon when it is false.never 5fighter_idint64The fighter's id. Compare with your character id to find your own result line.never 1tax_collector_list_entryTaxCollectorListEntrySet for a tax collector: the alliance it belongs to. See TaxCollectorListEntry.never 3player_list_entryPlayerListEntrySet for a player character: its level and experience/PvP data. See PlayerListEntry.never 4mutant_list_entryMutantListEntrySet for a mutant: its level. See MutantListEntry.never

What one fighter won: kamas, and the loot of each defeated monster. Kind struct · Area Game.Fight What one fighter won. HOW TO READ IT 1. FightReward.kamas is the kamas won. 2. Walk FightReward.loots: one FightLoot per source of loot (each defeated monster that dropped something), with its items and alterations. To list everything won, add up the items of every group, merging identical items by summing their quantities. Not sent on its own — it is only ever FightResultListEntry.rewards. proven Used by FightResultListEntry Fields #FieldTypeMeaningYou set it 1lootsrepeated FightLootThe loot groups: one per monster that dropped something. Name ours. Elements are FightLoot.never 2kamasint64The kamas this fighter won. Named after beta's FightLoot.kamas. Shown as the kamas earned on the result screen.never

One fighter's line of the fight result: who it is, how the fight ended for it and what it won. Kind struct · Area Game.Fight One line of the fight result, for one fighter. HOW TO READ IT 1. FightResultListEntry.fighter_list_entry says who the line is about: the fighter id, whether it is still alive, and whether it is a player, a mutant or a tax collector. 2. To find YOUR line, compare FighterListEntry.fighter_id with your character id. 3. FightResultListEntry.outcome is how the fight ended for that fighter (FightOutcome: lost or won). Lines whose outcome is not a victory go to the losers' side of the result screen. 4. FightResultListEntry.rewards is what the fighter won: kamas and loot. One declared int32 (beta's wave) is never read by the client: ignore it. Not sent on its own — it is only ever an element of FightEndEvent.results. proven Used by FightEndEvent Fields #FieldTypeMeaningYou set it 1outcomeFightOutcomeHow the fight ended for this fighter. A FightOutcome; the result screen puts every non-victory line on the losers' side.never 2fighter_list_entryFighterListEntryWho this line is about: id, alive flag and the kind of fighter. See FighterListEntry.never 3rewardsFightRewardWhat this fighter won: kamas and the loot of each defeated monster. See FightReward.never

The experience or the arena data of a player's fight result line. Kind struct · Area Game.Fight One element of PlayerListEntry.additional. Exactly one member of FightResultAdditionalData.additional_data is set: - FightResultAdditionalData.experience_data: the experience gauge of the character (ExperienceData); - FightResultAdditionalData.pvp_data: its arena league (PvpData). Not sent on its own — it is only ever an element of PlayerListEntry.additional. proven Used by PlayerListEntry Fields #FieldTypeMeaningYou set it 1experience_dataExperienceDataThe character's experience gauge for this fight. See ExperienceData.never 2pvp_dataPvpDataThe character's arena data. See PvpData.never

How the fight ended for a fighter or a team: lost, won, and so on. Kind enum · Area Game.Fight How a fight ended for one fighter or one team. Two values are named: RESULT_LOST and RESULT_VICTORY. Treat every other value as "not a victory" - the client does: its result screen files every line that is not RESULT_VICTORY with the losers. Beta also declares RESULT_DRAW, RESULT_TAX and RESULT_DEFENDER_GROUP; no client code tells them apart, so they keep their obfuscated names. Not sent on its own — an enum carried by FightResultListEntry.outcome and NamedPartyTeamWithOutcome.outcome. proven Used by FightResultListEntry NamedPartyTeamWithOutcome Values ValueNumberMeaning RESULT_LOST0The fighter or team lost. The client files the team's name as the losers. RESULT_VICTORY2The fighter or team won. The client files the team's name as the winners.

The loot one defeated monster dropped for a fighter: items and alterations. Kind struct · Area Game.Fight The loot of one source, usually one defeated monster. HOW TO READ IT 1. FightLoot.monster_id is the monster that dropped it (0: no monster). Look it up in the monster game data; an item that is in that monster's drop table with a condition is a conditional drop. 2. FightLoot.objects are the items won (Loot: item id and quantity). 3. FightLoot.alterations are the alterations won (Loot: the id is an alteration id; the quantity is not used). The fourth member, a list of job experience records, is never read by the client: ignore it. Not sent on its own — it is only ever an element of FightReward.loots. proven Used by FightReward Fields #FieldTypeMeaningYou set it 1alterationsrepeated LootThe alterations won from this source. Name ours. Elements are Loot whose id is an alteration id.never 3objectsrepeated LootThe items won from this source. Named after beta's FightLoot.objects, the item list. Elements are Loot: item id and quantity.never 4monster_idint32The monster that dropped this loot; 0 for none. Name ours. Looked up with MonstersDataRoot.GetMonsterById.never

A player's experience in a fight result: the total, the level's bounds and what the fight earned. Kind struct · Area Game.Fight The experience gauge of a character at the end of the fight. HOW TO READ IT 1. ExperienceData.experience is the character's total experience AFTER the fight. 2. The current level spans ExperienceData.experience_level_floor (the gauge's low end) to ExperienceData.experience_next_level_floor (its high end). 3. ExperienceData.experience_fight_delta is the experience this fight earned. The total before the fight is experience - experience_fight_delta (the client animates the gauge from max(floor, that value) to experience). 4. Print the gain only when ExperienceData.show_experience_fight_delta is true; the client prints "+ N" then, and "0" otherwise. Unnamed members: one int32 the client copies and never reads, and three bools (one copied into a flag bit nothing tests, two never read). Ignore them. Not sent on its own — it is only ever FightResultAdditionalData.experience_data. proven Used by FightResultAdditionalData Fields #FieldTypeMeaningYou set it 3experienceint64The character's total experience after the fight.never 4experience_level_floorint64The experience at which the character's current level starts. The low end of the result screen's XP gauge.never 6experience_next_level_floorint64The experience at which the next level starts. The high end of the result screen's XP gauge.never 8experience_fight_deltaint64The experience this fight earned. Shown as the XP gain; experience - delta is the total before the fight.never 9show_experience_fight_deltaboolWhether to show the experience this fight earned. When false the client prints "0" instead of the gain.never

Why a repeated craft stopped. Kind enum · Area Game.Exchange Carried by ExchangeItemAutoCraftStoppedEvent.reason. Four values, none named: the client does not branch on them (beta: OK, USER, MISSING_RESSOURCE, IMPOSSIBLE_MODIFICATION). Not sent on its own — an enum carried by ExchangeItemAutoCraftStoppedEvent.reason, never sent on its own. inferred Used by ExchangeItemAutoCraftStoppedEvent No fields you may set.

Put an item into (positive quantity) or take it out of (negative) the co-op smithmagic slot. Kind request · Area Game.Exchange Put an item into, or take it out of, the co-op smithmagic window. HOW TO SEND IT 1. Set ExchangeObjectUseInWorkshopRequest.object_uid to the item's id. 2. Set ExchangeObjectUseInWorkshopRequest.quantity: positive to put that many in, negative to take that many back (the client sends minus the stack size to empty the slot). 3. Leave the declared record and enum at their defaults: the client never writes them. In the solo smithmagic window the same action becomes an object move instead (the exchange's object move request). When you may send it Requires exchange_open inferred Raised by: a user action in the co-op smithmagic window: filling a slot with an item (SmithMagicCoopUi.DoFillSlot) or emptying it (SmithMagicCoopUi.UnFillSlot) proven Related messages Nothing answers it - send it and move on the exchange's object events report the change, as for any item moved in the exchange Fields #FieldTypeMeaningYou set it 1object_uidint32The item to put in or take out. An item uid from your inventory.always 2quantityint32How many: positive to put in, negative to take back. The client sends minus the stack size to empty the slot.always

Changes the price of one of your lots already on sale in the auction house. Kind request · Area Game.Exchange HOW TO CHANGE THE PRICE OF A LOT ON SALE 1. Open the auction house in sell mode (ExchangeBidSellerStartedEvent). The lots you already have on sale are listed there. 2. Send this request for the lot to change: - object_uid = the uid of the lot ON SALE (the uid the house lists for your sale), not an inventory stack; - quantity = that lot's size (1, 10, 100...), unchanged; - price = the NEW price of the whole lot, in kamas. 3. To reprice several lots, send one request per lot: the official client's bulk change does exactly that, skipping the lots whose price does not change. Selling a NEW lot is ExchangeObjectMovePricedRequest, not this request: the two share the same three members and only the window action tells them apart. When you may send it Requires context_ready inferred Raised by: the player confirms a new price in the auction-house sell window: the modify popup of one sale (AuctionHouseSell.OnConfirmModifyObject) or the bulk price change of several sales (AuctionHouseSell.OnConfirmModifyMultipleItems, one request per sale) proven Related messages Reply not yet recovered: the server's confirmation was not in the capture (only the request was), so which auction-house event carries the new price is not recorded here yet. Fields #FieldTypeMeaningYou set it 1quantityint32The lot's size (1, 10, 100...), as it is on sale. Observed: 1required 2object_uidint32The lot on sale to reprice: its uid in the auction house. Observed: 769056required 3priceint64The new asking price of the whole lot, in kamas. (kamas) Observed: 2150required

A repeated craft (count above 1, or -1) stopped; the reason says why. Kind event · Area Game.Exchange A repeated craft stopped. WHAT TO DO WHEN YOU RECEIVE IT 1. Stop expecting craft results for this run; read ExchangeItemAutoCraftStoppedEvent.reason (ExchangeItemAutoCraftStoppedEvent.ExchangeReplayStopReason). Its values are not named (beta: OK, USER, MISSING_RESSOURCE, IMPOSSIBLE_MODIFICATION). 2. You may set a new count (ExchangeCraftCountRequest) and craft again. 3. SEND NOTHING BACK. When you may send it Requires exchange_open inferred Related messages Unsolicited - nothing you send causes this the server stops a repeated craft Fields #FieldTypeMeaningYou set it 1reasonExchangeReplayStopReasonWhy the repeated craft stopped. A ExchangeItemAutoCraftStoppedEvent.ExchangeReplayStopReason; values not named.never

The crafter's job gained a level during the craft. The client ignores it. Kind event · Area Game.Exchange Sent when crafting levels up the crafter's job. The current client has no handler for it: you may ignore it. Its members are not named: two int32 (beta has one, crafter_job_level) and a decoy record. The client reads none of them, so nothing proves which int32 is the level. When you may send it Requires exchange_open inferred Related messages Unsolicited - nothing you send causes this a craft made the crafter's job gain a level No fields you may set.

How many times to craft the current recipe in an open workshop (-1: until the resources run out). Kind request · Area Game.Exchange Set how many times the recipe in the workshop is crafted when you press craft (ExchangeReadyRequest). HOW TO SEND IT 1. Put the recipe in first (ExchangeSetCraftRecipeRequest). 2. Set ExchangeCraftCountRequest.count: - N >= 1: craft N times. The craft window never sends less than 1 nor more than the number of crafts your ingredients allow (it clamps the value to [1, max craftable] before sending); - -1: repeat until the resources run out. The smithmagic window's Merge all sends this. 3. Leave the other declared member (an enum) at 0: the client never writes it. 4. The server confirms the count; then send ExchangeReadyRequest to craft. A repeated craft ends with ExchangeItemAutoCraftStoppedEvent. When you may send it Requires exchange_open inferred Raised by: a user action: changing the craft quantity in the craft window (CraftUi.ChangeCraftQuantity: the +/- buttons, ctrl/shift for bigger steps, or typing in the quantity box), or Merge all in the smithmagic window (SmithMagicUi.ClickOnMergeAll) proven Related messages You will then receive ExchangeCraftCountModifiedEvent observed — about 30ms later with the count in force (100 after a Max click); 1 observation Fields #FieldTypeMeaningYou set it 2countint32How many times to craft; -1 to repeat until the resources run out. The craft window sends 1 .. max craftable (clamped). SmithMagicUi's Merge all sends -1.always

The server's answer to ExchangeCraftCountRequest: the craft count now in force. Kind event · Area Game.Exchange The craft count the server will use, in answer to ExchangeCraftCountRequest. WHAT TO DO WHEN YOU RECEIVE IT 1. Replace the count you track with ExchangeCraftCountModifiedEvent.count: it is the value in force, which may differ from what you asked. The official client writes it back into the craft window's quantity box. 2. Craft with ExchangeReadyRequest when you are ready. 3. SEND NOTHING BACK. When you may send it Requires exchange_open inferred Related messages Arrives after ExchangeCraftCountRequest Fields #FieldTypeMeaningYou set it 1countint32The craft count in force: how many times the recipe will be crafted. The value the server accepted for ExchangeCraftCountRequest.count.never

You lost one emote: remove it from the emotes you know. Kind event · Area Game.Emote One emote was taken away from the emotes you know: the counterpart of EmoteAddedEvent. WHAT TO DO WHEN YOU RECEIVE IT 1. Remove EmoteRemovedEvent.emote_id from your set of known emotes. 2. Stop sending EmotePlayRequest with that id: the server refuses it (EmotePlayErrorEvent). 3. SEND NOTHING BACK. The official client also removes the emote's aura item from the inventory when the emote carries an aura, disables shortcut-bar slots holding that emote, and prints the localized line ui.common.emoteRemoved with the emote's name. When you may send it Requires character_loaded inferred Related messages Unsolicited - nothing you send causes this the server sends it when the character loses an emote (an expired or removed one); nothing requests it Fields #FieldTypeMeaningYou set it 1emote_idint32The emote lost. (emote id) An id of the emoticons game data, as listed by EmotesEvent.never