| blob | 3fb15e9a24bbfe1f8828955b2003659808cdc390 |
1 <client_messages_description>
2 <branch name="TARGET">
3 <leaf name="PARTY" />
4 <leaf name="INVENTORY" />
5 <leaf name="FOLLOW"
6 sendto="AIS"
7 format=""
8 description="The client follows its target" />
9 <leaf name="NO_FOLLOW"
10 sendto="AIS"
11 format=""
12 description="The client stop following its target" />
13 </branch>
14 <branch name="CONNECTION">
15 <leaf name="USER_CHAR" />
16 <leaf name="NO_USER_CHAR" />
17 <leaf name="USER_CHARS"
18 description="The EGS send existing characters of player to client" />
19 <leaf name="CREATE_CHAR"
20 description="The client creates a character, type is $u32, and name is $s" />
21 <leaf name="SELECT_CHAR" />
22 <leaf name="DELETE_CHAR"
23 sendto="EGS"
24 format="u8"
25 description="The client delete a character, slot of character is $u8" />
26 <leaf name="RENAME_CHAR"
27 format="u8 s s"
28 description="The client rename a character, $u8 : slot of character $s : name $s : surname" />
29 <leaf name="ENTER"
30 sendto="EGS"
31 format=""
32 description="The client leave create/select interface and enter in game, at this point, the FE association uid = sid is made" />
33 <leaf name="READY"
34 description="The client is ready to enter the world" />
35 <leaf name="TIME_DATE_SYNCHRO"
36 description="The WOS send to client the tiem and date of server: server tick $u32 ryzom time $f ryzom day $u32" />
37 <leaf name="ASK_NAME"
38 description="Ask server if a name is not already present" />
39 <leaf name="VALID_NAME"
40 format="u8"
41 description="Server answer yes or no the name is already affected for a player" />
42 <leaf name="CREATE_CHAR_ERROR"
43 description="Server refuse character creation and fill and send to client a boolean structure with false for all parameters refused" />
44 <leaf name="RECONNECT"
45 description="Client quits the game and returns to the select character menu" />
46 <leaf name="SERVER_RECONNECT_OK"
47 description="Server acknowledges reconnection request" />
48 <leaf name="SHARD_ID" />
49 <leaf name="SERVER_QUIT_OK"
50 description="EGS send a force quit command to client" />
51 <leaf name="SERVER_QUIT_ABORT"
52 description="EGS send to client a msg to indicate a quit game command has been aborted" />
53 <leaf name="CLIENT_QUIT_REQUEST"
54 sendto="EGS"
55 format="b u32 u16"
56 description="client want to quit" />
57 <leaf name="MAIL_AVAILABLE" />
58 <leaf name="GUILD_MESSAGE_AVAILABLE" />
59 <leaf name="PERMANENT_BAN" />
60 <leaf name="UNBAN" />
61 <leaf name="FAR_TP"
62 description="EGS tells the client to connect elsewhere" />
63 <leaf name="RET_MAINLAND"
64 description="client quits a ring session" />
65 </branch>
66 <leaf name="DB_UPD_PLR" />
67 <leaf name="DB_UPD_INV"
68 description="EGS sends an inventory update to the client" />
69 <branch name="DB_INIT">
70 <leaf name="PLR" />
71 <leaf name="INV" />
72 </branch>
73 <branch name="DB_GROUP">
74 <leaf name="UPDATE_BANK" />
75 <leaf name="INIT_BANK" />
76 <leaf name="RESET_BANK" />
77 </branch>
78 <leaf name="POSITION"
79 sendto="GPMS"
80 format="s32 s32 s32 f"
81 usecycle="yes"
82 description="the client moves to ($i32,$i32,$i32) with heading $f" />
83 <branch name="HARVEST">
84 <leaf name="DEPOSIT"
85 sendto="EGS"
86 format="u16"
87 description="the client shearch a deposit for harvest/digging (param = skill used)" />
88 <leaf name="CORPSE" />
89 <leaf name="INTERRUPT" />
90 <leaf name="CLOSE_TEMP_INVENTORY"
91 description="the server force the client to close the temp inventory" />
92 </branch>
93 <leaf name="TRAINING"
94 sendto="EGS"
95 format=""
96 description="the client starts a training action" />
97 <branch name="JOB">
98 <leaf name="SET_JOB_STATUS"
99 sendto="EGS"
100 format="u8 u8"
101 description="player want change one of his job status (job, status)" />
102 <leaf name="SWAP_JOB_STATUS"
103 sendto="EGS"
104 format="u8 u8"
105 description="player want change one of his job status( job freezed, job actived)" />
106 </branch>
107 <branch name="CASTING">
108 <leaf name="BEGIN" />
109 <leaf name="INTERRUPT" />
110 </branch>
111 <branch name="FABER">
112 <leaf name="OPEN"
113 sendto="EGS"
114 format="" />
115 <leaf name="CLOSE"
116 sendto="EGS"
117 format="" />
118 <leaf name="EXECUTE"
119 sendto="EGS"
120 format="" />
121 <leaf name="SET_NUM_ITEM"
122 sendto="EGS"
123 format="u8" />
124 <leaf name="START_CREATE"
125 sendto="EGS"
126 format="u32" />
127 <leaf name="START_REPAIR"
128 sendto="EGS"
129 format="u16 u16" />
130 <leaf name="START_REFINE"
131 sendto="EGS"
132 format="u16 u16" />
133 <leaf name="SET_MP_QUALITY"
134 sendto="EGS"
135 format="u8 u8" />
136 <leaf name="SET_MP_REFINE"
137 sendto="EGS"
138 format="u32 u8" />
139 <!-- <leaf name="ADD_MP" sendto="EGS" format="u16 u16 u16 u8"/> -->
140 <!-- <leaf name="REMOVE_MP" sendto="EGS" format="u8 u16"/> -->
141 <leaf name="SET_TOOL"
142 sendto="EGS"
143 format="u16 u16" />
144 <leaf name="RESET_TOOL"
145 sendto="EGS"
146 format="" />
147 <leaf name="INTERRUPT" />
148 </branch>
149 <branch name="COMBAT">
150 <leaf name="ENGAGE"
151 sendto="EGS"
152 format="" />
153 <leaf name="DISENGAGE"
154 sendto="EGS"
155 format="" />
156 <leaf name="DEFAULT_ATTACK"
157 sendto="EGS"
158 format="" />
159 <leaf name="ENGAGE_FAILED" />
160 <leaf name="VALIDATE_MELEE"
161 sendto="EGS"
162 format="u8"
163 description="the client validate or invalidate the melee combat (check position and orientation), validation flag $u8" />
164 <leaf name="PARRY"
165 sendto="EGS"
166 format=""
167 description="the client toggle chooses parry as his defense mode" />
168 <leaf name="DODGE"
169 sendto="EGS"
170 format=""
171 description="the client toggle chooses dodge as his defense mode" />
172 <leaf name="PROTECTED_SLOT"
173 sendto="EGS"
174 format="u8"
175 description="the client select a new slot to defend (or none)" />
176 <leaf name="FLYING_HP_DELTA"
177 description="add a flying text to an entity (u32 entity, u32 rgba, s16 delta)" />
178 <leaf name="FLYING_TEXT_ISE"
179 description="add a flying text to an entity (u32 entity, u32 rgba, u8 effect, s32 param)" />
180 <leaf name="FLYING_TEXT"
181 description="add a flying text to an entity (u32 entity, u8 type)" />
182 </branch>
183 <branch name="STRING">
184 <leaf name="TELL"
185 sendto="IOS"
186 format="s uc"
187 description="the client sends a tell to the character $e : $s" />
188 <leaf name="FAR_TELL"
189 description="the client receive a far tell from a player on another shard" />
190 <leaf name="CHAT"
191 sendto="IOS"
192 format="uc"
193 description="the client sends the chat message : $s" />
194 <leaf name="CHAT_TEAM"
195 sendto="IOS"
196 format="uc"
197 description="the client sends the chat message to his team: $s" />
198 <leaf name="ADD_DYN_STR" />
199 <leaf name="FILTER"
200 sendto="IOS"
201 format="u8"
202 description="the client adds/removes the chat filter $u8" />
203 <leaf name="CHAT_MODE"
204 sendto="IOS"
205 format="u8 u64"
206 description="the client selects the chat mode $u8 $64. second param is 0 or the dynamic chat Id (an eid)" />
207 <leaf name="CHAT2"
208 description="a npc send a predef message to the client : $s" />
209 <leaf name="TELL2"
210 description="a npc send a predef message to the client : $s" />
211 <leaf name="DYN_STRING"
212 description="system send a dyn string to the client system chat: $u32" />
213 <leaf name="DYN_STRING_GROUP"
214 description="system send a dyn string to the client gived group chat: $u32 $u16" />
215 <leaf name="AFK_TXT"
216 sendto="IOS"
217 format="uc"
218 description="the client sets an afk custom text" />
219 </branch>
220 <branch name="STUN">
221 <leaf name="STUN" />
222 <leaf name="WAKE_UP" />
223 </branch>
224 <branch name="SENTENCE">
225 <leaf name="EXECUTE"
226 sendto="EGS"
227 format="u8 s32" />
228 <leaf name="CANCEL"
229 sendto="EGS"
230 format="s32 u8" />
231 <leaf name="CANCEL_CURRENT"
232 sendto="EGS"
233 format="" />
234 <leaf name="CANCEL_ALL"
235 sendto="EGS"
236 format="" />
237 <leaf name="CLEAR"
238 sendto="EGS"
239 format="" />
240 <leaf name="MEMORIZE" />
241 <leaf name="FORGET"
242 sendto="EGS"
243 format="u8 s32" />
244 <leaf name="EVALUATE" />
245 <leaf name="ADD_BRICK"
246 sendto="EGS"
247 format="u16 u8 u8"
248 description="the client add brick (family $u16/index $u8/slot u8) in sentence" />
249 <leaf name="REMOVE_BRICK"
250 sendto="EGS"
251 format="u8" />
252 <leaf name="START" />
253 <leaf name="STOP" />
254 </branch>
255 <branch name="TEAM">
256 <leaf name="JOIN"
257 sendto="EGS"
258 format="" />
259 <leaf name="LEAVE"
260 sendto="EGS"
261 format="" />
262 <leaf name="INVITATION" />
263 <leaf name="JOIN_PROPOSAL"
264 sendto="EGS"
265 format="" />
266 <!--<leaf name="JOIN_PROPOSAL"/>-->
267 <leaf name="JOIN_PROPOSAL_DECLINE"
268 sendto="EGS"
269 format="" />
270 <leaf name="KICK"
271 sendto="EGS"
272 format="u8" />
273 <leaf name="SET_SUCCESSOR"
274 sendto="EGS"
275 format="u8" />
276 <!-- Sharing system -->
277 <leaf name="SHARE_OPEN"
278 format=""
279 description="the server wants the share interface to be opened" />
280 <leaf name="SHARE_VALID_ITEM"
281 sendto="EGS"
282 format="u8 u8"
283 description="the client wants an item or phrase (item/phrase index, session id)" />
284 <leaf name="SHARE_INVALID_ITEM"
285 sendto="EGS"
286 format="u8 u8"
287 description="the client do not wants an item or phrase anymore (item/phrase index, session id)" />
288 <leaf name="SHARE_VALID"
289 sendto="EGS"
290 format="u8"
291 description="the client wants to validate its selection (session id)" />
292 <leaf name="SHARE_INVALID"
293 format=""
294 description="the server invalidate the client selection" />
295 <leaf name="SHARE_CLOSE"
296 format=""
297 description="the server wants the share interface to be closed" />
298 <!-- Contact List -->
299 <leaf name="CONTACT_INIT"
300 format=""
301 description="the server initialize the 2 contacts lists (net_manager.cpp to see the message format)" />
302 <leaf name="CONTACT_ADD"
303 sendto="EGS"
304 format="uc u8"
305 description="the client wants to add a contact ($uc name $u8 list)" />
306 <leaf name="CONTACT_DEL"
307 sendto="EGS"
308 format="u32 u8"
309 description="the client wants to delete a contact ($u32 contactId $u8 list)" />
310 <leaf name="CONTACT_MOVE"
311 sendto="EGS"
312 format="u32 u8"
313 description="the client wants to move a contact from one list to the other ($u32 contactId $u8 listSrc)" />
314 <leaf name="CONTACT_CREATE"
315 format=""
316 description="the server create a contact" />
317 <leaf name="CONTACT_STATUS"
318 format=""
319 description="the server give the status of a contact" />
320 <leaf name="CONTACT_REMOVE"
321 format=""
322 description="the server removes a contact" />
323 </branch>
324 <branch name="ITEM">
325 <leaf name="DROP"
326 sendto="EGS"
327 format="u16 u16 u16" />
328 <leaf name="PICK_UP" />
329 <!-- this is directly treated in messages to send to EGS -->
330 <leaf name="PICK_UP_CLOSE"
331 sendto="EGS"
332 format="" />
333 <leaf name="SWAP"
334 sendto="EGS"
335 format="u16 u16 u16 u16 u16 u16" />
336 <leaf name="ACTIVATE_SHEATH"
337 sendto="EGS"
338 format="u8" />
339 <leaf name="HARVEST"
340 sendto="EGS"
341 format="u16 u16"
342 description="the client want harvest a founded Raw material(slot, quantity)" />
343 <leaf name="HARVEST_CLOSE"
344 sendto="EGS"
345 format="" />
346 <leaf name="GIVE"
347 sendto="EGS"
348 format="u16 u16 u16"
349 description="the client give an item to target (inventory, slot, quantity)" />
350 <leaf name="DESTROY"
351 sendto="EGS"
352 format="u16 u16 u16"
353 usecycle="no"
354 description="destroy the content of an inventory slot params : inventory, slot,quantity" />
355 <leaf name="EQUIP"
356 sendto="EGS"
357 format="u16 u16 u16"
358 description="the client equip character (equiped inventory, equiped inventory slot, bag slot)" />
359 <leaf name="UNEQUIP"
360 sendto="EGS"
361 format="u16 u16"
362 description="the client unequip character (equiped inventory, equiped inventory slot)" />
363 <leaf name="TEMP_TO_BAG"
364 sendto="EGS"
365 format="u16"
366 description="the client pick an item from temp inventory (temp inventory slot)" />
367 <leaf name="ALL_TEMP"
368 sendto="EGS"
369 format=""
370 description="the client pick all items from temp inventory" />
371 <leaf name="NO_TEMP"
372 sendto="EGS"
373 format=""
374 description="the client drop all items from temp inventory" />
375 <leaf name="ENCHANT"
376 sendto="EGS"
377 format="u8 u16"
378 description="the client wants to enchant the right hand item with the current one (inventory, slot)" />
379 <leaf name="OPEN_ROOM_INVENTORY"
380 sendto=""
381 description="EGS wants to open the user inventory" />
382 <leaf name="CLOSE_ROOM_INVENTORY"
383 sendto=""
384 description="EGS wants to close the user inventory" />
385 <leaf name="USE_ITEM"
386 sendto="EGS"
387 format="u16"
388 description="client wants to use teleport in the specified bag slot or consume an item to trigger its effect" />
389 <leaf name="STOP_USE_XP_CAT"
390 sendto="EGS"
391 format="b"
392 description="client wants to stop using xp catalyser" />
393 </branch>
394 <branch name="TP">
395 <leaf name="RESPAWN"
396 sendto="EGS"
397 format=""
398 description="teleport the player to his respawn point" />
399 <leaf name="BOT"
400 sendto="EGS"
401 format="s"
402 description="teleport the player near the bot" />
403 <leaf name="WANTED"
404 sendto="EGS"
405 format="s32 s32 s32" />
406 <leaf name="DEST" />
407 <leaf name="DEST_WITH_SEASON" />
408 <leaf name="ACK"
409 sendto="EGS"
410 format="" />
411 <leaf name="CORRECT" />
412 </branch>
413 <branch name="DEATH">
414 <leaf name="RESPAWN_POINT"
415 sendto="EGS"
416 format=""
417 description="server set the respawn points with a bool to know if the client needs to reset all known points first" />
418 <leaf name="ASK_RESPAWN"
419 sendto="EGS"
420 format="u16"
421 description="client wants to respawn somewhere (index of the respawn location wanted)" />
422 <leaf name="RESPAWN"
423 sendto="EGS"
424 format=""
425 description="server teleport the client to the respawn point choosen" />
426 </branch>
427 <branch name="ANIMALS">
428 <leaf name="BEAST"
429 sendto="EGS"
430 format="u8 u8"
431 description="client send a beast order(beast u8, order u8)" />
432 <leaf name="MOUNT_ABORT"
433 description="server refuse the client mount command" />
434 </branch>
435 <!--
436 <branch name="TRADE">
437 <leaf name="NEXT_PAGE_ITEM" sendto="EGS" format="u16" description="Client ask for the next trade page"/>
438 <leaf name="NEXT_PAGE_MISSION" sendto="EGS" format="u16" description="Client ask for the next mission page"/>
439 <leaf name="NEXT_PAGE_MISSION_ITEM" sendto="EGS" format="u16" description="Client ask for the next mission item page"/>
440 <leaf name="BUY" sendto="EGS" format="u16 u8"/>
441 <leaf name="CHOOSE_ITEM_AS_MISSION_REWARD" sendto="EGS" format="u8" description="client want to do a mission to get a specific item"/>
442 <leaf name="QUERY_PRICE" sendto="EGS" format="u16 u8" description="Client ask the sell price of an item to current shopkeeper, first param is botchat session, second is index of item in the inventory"/>
443 <leaf name="BUY_PRICE"/>
444 <leaf name="SELL" sendto="EGS" format="u8 u8" description="Client sell item in bag and quantity"/>
445 </branch>
446 -->
447 <branch name="EXCHANGE">
448 <leaf name="INVITATION" />
449 <leaf name="CLOSE_INVITATION"
450 description="message sent to the client to force his invitation popup to close" />
451 <leaf name="PROPOSAL"
452 sendto="EGS"
453 format="" />
454 <leaf name="ACCEPT_INVITATION"
455 sendto="EGS"
456 format="" />
457 <leaf name="DECLINE_INVITATION"
458 sendto="EGS"
459 format="" />
460 <leaf name="VALIDATE"
461 sendto="EGS"
462 format="u8" />
463 <leaf name="INVALIDATE"
464 sendto="EGS" />
465 <leaf name="END"
466 sendto="EGS"
467 format="" />
468 <leaf name="SEEDS"
469 sendto="EGS"
470 format="u64" />
471 <leaf name="ADD"
472 sendto="EGS"
473 format="u16 u16 u16 u16"
474 description="add an item from the bag(inventory_src index_in_bag index_in_exchange quantity)" />
475 <leaf name="REMOVE"
476 sendto="EGS"
477 format="u16"
478 description="remove an item from the exchange" />
479 </branch>
480 <branch name="DEBUG">
481 <leaf name="WHERE"
482 sendto="EGS"
483 format=""
484 description="client ask server send his server position" />
485 <leaf name="WHO"
486 sendto="EGS"
487 format="s"
488 description="client ask list of all clients connected to server" />
489 <leaf name="REPLY_WHERE"
490 description="server send to client his server position" />
491 <leaf name="SERVICES"
492 sendto="EGS"
493 format="" />
494 <leaf name="CMD"
495 format="b s s s"
496 description="the client wants to execute command : $b $s $s $s" />
497 <leaf name="PING"
498 sendto="EGS"
499 format="u32"
500 description="the client send a ping with tick game time of emission" />
501 <leaf name="COUNTER" />
502 </branch>
503 <!-- ****OUT OF DATE COMMANDS****
504 <branch name="CHEAT">
505 <leaf name="GOD" sendto="EGS" format="" description="the client want to be unkillable."/>
506 <leaf name="CREATE_ITEM_IN_BAG" sendto="EGS" format="u32 u16 u16" description="the client ask to create item in hand sheetId (u32) , quantity (u16) and quality (u16)"/>
507 <leaf name="XP" sendto="EGS" format="u32 s s" description="the client want gain some XP(u32) in skill(s) and speciality(s)."/>
508 <leaf name="MONEY" sendto="EGS" format="s32 s32 s32 s32" description="the client ask to earn some money (s32)(s32)(s32)(s32)."/>
509 <leaf name="LEARN_ALL_BRICKS" sendto="EGS" format="" description="the client ask to learn all bricks"/>
510 <leaf name="SET_TIME" sendto="EGS" format="f" description="the client set RyzomTime f Time"/>
511 <leaf name="SET_DAY" sendto="EGS" format="u32" description="the client set RyzomDay"/>
512 <leaf name="CREATE_CHARACTER" sendto="EGS" format="s u32 u32 u32 u16" description="the client send create character commande ( s name, u32 race, u32 sex, u32 role and u16 level)."/>
513 <leaf name="LEARN_BRICK" sendto="EGS" format="u32 u16" description="the client ask learn bricks for role (u32) at level(u16)"/>
514 <leaf name="LEARN_ALL_FABER_PLANS" sendto="EGS" format="" description="the client want to learn all faber plans"/>
515 <leaf name="ADMIN" sendto="" format="s s" description="the client asks EGS to execute the command $s with arg $s"/>
516 </branch>
517 -->
518 <!-- Msg from Commands -->
519 <branch name="COMMAND">
520 <leaf name="EMOTE"
521 sendto="EGS"
522 format="u32 u16"
523 description="client send the emote (behaviour, phrase id) to play." />
524 <leaf name="CUSTOM_EMOTE"
525 sendto="EGS"
526 format="u32 uc"
527 description="client send the custom emote (behaviour, custom text) to play." />
528 <leaf name="WHERE"
529 sendto="EGS"
530 format=""
531 description="client send the where command" />
532 <leaf name="ADMIN"
533 sendto="EGS"
534 format="b s s"
535 description="client asks EGS to execute the command $s with arg $s" />
536 <leaf name="ADMIN_OFFLINE"
537 sendto="EGS"
538 format="s s s"
539 description="client asks EGS to execute on character $s (online or offline) the command $s with arg $s" />
540 <leaf name="REMOTE_ADMIN"
541 sendto="EGS"
542 format="u32 s"
543 description="server send the client a remote command" />
544 <leaf name="REMOTE_ADMIN_ANSWER"
545 sendto="EGS"
546 format="u32 s s"
547 description="client send the answer of the remote command" />
548 <leaf name="SIT"
549 sendto="EGS"
550 format="b"
551 description="client send to the server the sitting state" />
552 <leaf name="AFK"
553 sendto="EGS"
554 format="b"
555 description="AFK command is sent to EGS" />
556 <leaf name="SELFKILL"
557 sendto="EGS"
558 format=""
559 description="client asks EGS to kill self" />
560 <leaf name="RANDOM"
561 sendto="EGS"
562 format="s16 s16"
563 description="client asks EGS to roll a dice and tell result around" />
564 <leaf name="GUILDMOTD"
565 sendto="EGS"
566 format="s"
567 description="client asks EGS to set the guild message of the day" />
568 <leaf name="AUTOPACT"
569 sendto="EGS"
570 format="u8"
571 description="client want set AUTOPACT to TRUE or FALSE" />
572 </branch>
573 <!-- MP Exotic Price Evaluation (discontinued) -->
574 <branch name="MP_EVAL">
575 <leaf name="SET_MP"
576 sendto="EGS"
577 format="u32"
578 description="the client set the sheet id of the MP exotic brick knowledge to eval" />
579 <leaf name="SET_MP_LEVEL"
580 sendto="EGS"
581 format="u8"
582 description="the client set the exact level of the MP to eval" />
583 <leaf name="SET_MARKET"
584 sendto="EGS"
585 format="u32"
586 description="the client set the sheet id of the market knowledge 's brick" />
587 <leaf name="EXECUTE"
588 sendto="EGS"
589 format=""
590 description="the client validate the evaluation" />
591 </branch>
592 <!-- bot chat -->
593 <branch name="BOTCHAT">
594 <leaf name="NEXT_PAGE_ITEM"
595 sendto="EGS"
596 format="u16"
597 description="Client ask for the next trade page" />
598 <leaf name="NEXT_PAGE_MISSION"
599 sendto="EGS"
600 format="u16"
601 description="Client ask for the next mission page" />
602 <!-- trade -->
603 <leaf name="START_TRADE_ITEM"
604 sendto="EGS"
605 format="u16"
606 description="start bot chat trade item with the given session id" />
607 <leaf name="START_TRADE_TELEPORT"
608 sendto="EGS"
609 format="u16"
610 description="start bot chat trade teleport with the given session id" />
611 <leaf name="START_TRADE_FACTION"
612 sendto="EGS"
613 format="u16"
614 description="start bot chat trade of faction items with the given session id" />
615 <leaf name="START_TRADE_SKILL"
616 sendto="EGS"
617 format="u16"
618 description="start bot chat skills with the given session id" />
619 <leaf name="START_TRADE_PACT"
620 sendto="EGS"
621 format="u16"
622 description="start bot chat pacts with the given session id" />
623 <leaf name="START_TRADE_ACTION"
624 sendto="EGS"
625 format="u16"
626 description="start bot chat actions with the given session id" />
627 <leaf name="BUY"
628 sendto="EGS"
629 format="u16 u16"
630 description="Client buy object. param1: index in list. Param2: quantity" />
631 <leaf name="SELL"
632 sendto="EGS"
633 format="u8 u16 u16 u32"
634 description="Client sell item in: 1/ inventory id INVENTORIES::EInventory 2/ index 3/ quantity 4/ resale price" />
635 <leaf name="DESTROY_ITEM"
636 sendto="EGS"
637 format="u16 u16"
638 description="Client destroy an item in sell store. param1: index in list. Param2: quantity" />
639 <leaf name="REFRESH_TRADE_LIST"
640 sendto="EGS"
641 format=""
642 description="Client want refresh trade list from current Bot" />
643 <!-- trade filters -->
644 <leaf name="SET_FILTERS"
645 sendto="EGS"
646 format="u32 u32 u32 u32 u8 u8 u8 u8"
647 description="Client Set filter for trade list: 1/MinQuality 2/MaxQuality 3/MinPrice 4/MaxPrice 5/MinClass 6/MaxClass 7/ItemPart 8/ItemType, NoFilter = 0 ~0 0 ~0 0 0 RM_FABER_TYPE::Unknown values ITEM_TYPE::UNDEFINED" />
648 <!-- missions -->
649 <leaf name="START_CHOOSE_MISSION"
650 sendto="EGS"
651 format="u16"
652 description="start bot chat mission choice with the given session id" />
653 <leaf name="START_DYNAMIC_MISSION"
654 sendto="EGS"
655 format=""
656 description="start bot chat dynamic mission with the given session id" />
657 <leaf name="CONTINUE_MISSION"
658 sendto="EGS"
659 format="u8"
660 description="the user completed the mission, with no gift required" />
661 <leaf name="VALIDATE_PLAYER_GIFT"
662 sendto="EGS"
663 format=""
664 description="the user validate the gift he just made (server aknowledged the gift to be a valid one)" />
665 <leaf name="PICK_MISSION"
666 sendto="EGS"
667 format="u8"
668 description="message sent when a mission is accepted (from the static mission list)" />
669 <leaf name="DM_CHOICE"
670 sendto="EGS"
671 format="u8 u8 u8"
672 description="the three choices for dynamic mission selection" />
673 <leaf name="DM_ACCEPT"
674 sendto="EGS"
675 format=""
676 description="accept current dynamic mission" />
677 <!-- news -->
678 <leaf name="START_NEWS"
679 sendto="EGS"
680 format=""
681 description="start bot chat new page" />
682 <!-- guild -->
683 <leaf name="START_CREATE_GUILD"
684 sendto="EGS"
685 format=""
686 description="start bot chat page to create a guild" />
687 <!-- the bot chat window has been closed -->
688 <leaf name="END"
689 sendto="EGS"
690 format=""
691 description="end chat with a bot sent to EGS" />
692 <leaf name="FORCE_END"
693 description="force the end of the bot chat on the client side" />
694 <!-- duty related messages -->
695 <leaf name="START_CHOOSE_DUTY"
696 sendto="EGS"
697 format="u16"
698 description="client ask EGS for duty list ( param is session id )" />
699 <leaf name="NEXT_PAGE_DUTY"
700 sendto="EGS"
701 format="u16"
702 description="client ask EGS for next duty page ( param is session id )" />
703 <leaf name="DUTY_APPLY"
704 sendto="EGS"
705 format="u8"
706 description="client apply for a duty (param is the GLOBAL index of the duty)" />
707 <leaf name="DUTY_CANCEL_APPLY"
708 sendto="EGS"
709 format=""
710 description="client cancel apply for a duty" />
711 <!-- guild options related messages -->
712 <leaf name="START_TRADE_GUILD_OPTIONS"
713 sendto="EGS"
714 format="u16"
715 description="client ask EGS for guild option list ( param is session id )" />
716 <leaf name="BUY_GUILD_OPTION"
717 sendto="EGS"
718 format="u8"
719 description="client buy a guild option (param is the GLOBAL index of the option)" />
720 <leaf name="START_GUILD_RESEARCH"
721 sendto="EGS"
722 format="u16"
723 description="client ask EGS for a guild research list ( param is session id )" />
724 <leaf name="DESTROY_BUILDING"
725 sendto="EGS"
726 format=""
727 description="client destroy the building of his ZC" />
728 <leaf name="DYNCHAT_OPEN"
729 description="server wants to dynamically chat with the client (Bot UID, Bot Name, Vector of DynString)" />
730 <leaf name="DYNCHAT_CLOSE"
731 description="server wants to close dynamic chat (Bot UID)" />
732 <leaf name="DYNCHAT_SEND"
733 sendto="EGS"
734 format="u32 u8"
735 description="client answer to the server dynamic dialog (Bot UID, Answer Nb)" />
736 </branch>
737 <branch name="JOURNAL">
738 <leaf name="INIT_COMPLETED_MISSIONS"
739 description="a vector of text ids is sent to init the mission journal (vector(uint32) )" />
740 <leaf name="UPDATE_COMPLETED_MISSIONS"
741 description="a text id is sent to add a mission title to the mission journal (uint32)" />
742 <leaf name="MISSION_ABANDON"
743 sendto="EGS"
744 format="u8"
745 description="the client wants to abandon a mission (mission same as in database)" />
746 <leaf name="GROUP_MISSION_ABANDON"
747 sendto="EGS"
748 format="u8"
749 description="the client wants to abandon a team mission (mission same as in database)" />
750 <leaf name="ADD_COMPASS"
751 description="EGS adds a compass target for no list missions. Params X, Y, name. If the client already has the name, the coords are replaced" />
752 <leaf name="ADD_COMPASS_BOT"
753 description="Same for bots. Params X, Y, name, bot_datasetid" />
754 <leaf name="REMOVE_COMPASS"
755 description="EGS adds a compass target for no list missions. Params name" />
756 <leaf name="REMOVE_COMPASS_BOT"
757 description="Same for bots. Params name, bot_dataseetid" />
758 </branch>
759 <!-- String Manager related message -->
760 <branch name="STRING_MANAGER">
761 <leaf name="SET_LANGUAGE"
762 description="The client send the language code to use for this session." />
763 <leaf name="PHRASE_SEND"
764 description="The IOS send the prepared phrase to the client." />
765 <leaf name="STRING_RQ"
766 description="the client ask the string manager for an unknow string" />
767 <leaf name="STRING_RESP"
768 description="The IOS return the requested string yo the client." />
769 <leaf name="RELOAD_CACHE"
770 description="The IOS send it's initial cache time stamp or a new one at run time." />
771 </branch>
772 <!-- Guilds related message -->
773 <branch name="GUILD">
774 <leaf name="CREATE"
775 sendto="EGS"
776 format="uc u64 uc"
777 description="client wants to create a guild (name of new guild, guild icon descriptor, description of the guild)" />
778 <leaf name="ABORT_CREATION"
779 description="server forces the end of a guild create session" />
780 <leaf name="OPEN_GUILD_WINDOW"
781 sendto=""
782 format=""
783 description="the client just entered a guild, EGS ask the client to open the guild window" />
784 <leaf name="INVITATION"
785 sendto="EGS"
786 format="" />
787 <leaf name="ACCEPT_INVITATION"
788 sendto="EGS"
789 format="" />
790 <leaf name="REFUSE_INVITATION"
791 sendto="EGS"
792 format="" />
793 <leaf name="JOIN_PROPOSAL"
794 description="invitation sent to client (uint32 textId)" />
795 <leaf name="SET_GRADE"
796 sendto="EGS"
797 format="u16 u8 u8"
798 description="client change a member grade p1 is the member, p2 is the grade ( see GUILD_GRADES enum ), p3 is the state counter" />
799 <leaf name="SET_LEADER"
800 sendto="EGS"
801 format="u16 u8"
802 description="client leader in its guild wants to set the new leader specifying the name of the new leader p1 is the member, p2 is the state counter" />
803 <leaf name="KICK_MEMBER"
804 sendto="EGS"
805 format="u16 u8"
806 description="client (lead,ho,of) wants to kick member specifying its index. Last param is the counter" />
807 <leaf name="TELEPORT"
808 sendto="EGS"
809 format="u16"
810 description="client wants to teleport somewhere in guild flats" />
811 <leaf name="ASCENSOR"
812 description="Server requests the launch of ascensor interface" />
813 <leaf name="FIRST_ASCENSOR_PAGE"
814 sendto="EGS"
815 format="u16"
816 description="Client ask for the first ascensor page specifying the session id" />
817 <leaf name="NEXT_ASCENSOR_PAGE"
818 sendto="EGS"
819 format="u16"
820 description="Client ask for the next ascensor page specifying the session id" />
821 <leaf name="LEAVE_ASCENSOR"
822 description="Server requests the closing of ascensor interface" />
823 <leaf name="QUIT"
824 sendto="EGS"
825 format=""
826 description="Client wants to quit its guild" />
827 <!-- About the player -->
828 <leaf name="SET_PLAYER_TITLE"
829 sendto="EGS"
830 format="u8"
831 description="the client inform the server it has changed its character title (u8=new title(ECharacterTitle))" />
832 <leaf name="UPDATE_PLAYER_TITLE"
833 description="the server update some reserved titles" />
834 <leaf name="USE_FEMALE_TITLES"
835 format="b"
836 description="The EGS sends to client whether female titles are used" />
837 <!-- guild inventory management -->
838 <leaf name="PUT_MONEY"
839 sendto="EGS"
840 format="u64 u16"
841 description="put money in guild warehouse" />
842 <leaf name="TAKE_MONEY"
843 sendto="EGS"
844 format="u64 u16"
845 description="take money from guild warehouse" />
846 <leaf name="OPEN_INVENTORY"
847 sendto=""
848 format=""
849 description="open the guild inventory" />
850 <leaf name="CLOSE_INVENTORY"
851 sendto=""
852 format=""
853 description="close the guild inventory" />
854 </branch>
855 <branch name="OUTPOST">
856 <leaf name="GIVEUP_OUTPOST"
857 sendto="EGS"
858 format="u32"
859 description="Give up an outpost (outpostSHEET)" />
860 <!-- Select an outpost from a BotObject -->
861 <leaf name="SELECT"
862 sendto="EGS"
863 format="u32"
864 description="Select an outpost to display its state (outpostSHEET). = Fill OUTPOST_SELECTED DB" />
865 <leaf name="UNSELECT"
866 sendto="EGS"
867 format=""
868 description="Unselect any outpost display" />
869 <!-- War declaration -->
870 <leaf name="DECLARE_WAR_START"
871 sendto="EGS"
872 format="u32 u8"
873 description="The User try to Declare War to the outpost (outpostSHEET, startHourForAttackPeriod)" />
874 <leaf name="DECLARE_WAR_ACK"
875 description="The server answer to the client (bool ok, uint32 textId, uint32 resultStartAttackTime)" />
876 <leaf name="DECLARE_WAR_VALIDATE"
877 sendto="EGS"
878 format="u32 u8 u32"
879 description="The user confirms its Declare war (outpostSHEET, startHourForAttackPeriod, resultStartAttackTimeForCheck). NB: still can fail = sysinfo" />
880 <!-- Defender Setup -->
881 <leaf name="SET_DEF_PERIOD"
882 sendto="EGS"
883 format="u32 u8"
884 description="The defender changes the defense period of one of its Outpost (outpostSHEET, start hour for defense period)" />
885 <!-- squads management -->
886 <leaf name="SET_SQUAD"
887 sendto="EGS"
888 format="u32 u8 u8"
889 description="Set a training squad in a slot (outpostSHEET, slot, squadNUMBER_IN_SQUAD_SHOP_DB)" />
890 <leaf name="SET_SQUAD_SPAWN"
891 sendto="EGS"
892 format="u32 u8 u8"
893 description="Set spawn zone of a training squad (outpostSHEET, slot, spawn_index)" />
894 <leaf name="INSERT_SQUAD"
895 sendto="EGS"
896 format="u32 u8"
897 description="Insert a (default) training squad BEFORE the slot (outpostSHEET, slot)" />
898 <leaf name="REMOVE_SQUAD"
899 sendto="EGS"
900 format="u32 u8"
901 description="Remove a training squad in a slot (outpostSHEET, slot)" />
902 <leaf name="SET_SQUAD_CAPITAL"
903 sendto="EGS"
904 format="u32 u32"
905 description="Set the War Capital of the outpost (outpostSHEET, money)" />
906 <!-- pvp and engagement -->
907 <leaf name="CHOOSE_SIDE"
908 description="participate or not in outpost, choose side if participate (b playerGuildInConflict, b playerGuildIsAttacker, u32 defNameId, u32 attNameId)" />
909 <leaf name="SIDE_CHOSEN"
910 sendto="EGS"
911 format="b u8"
912 description="user chooses to participate or not in outpost conflict and on which side" />
913 <leaf name="BANISH_PLAYER"
914 sendto="EGS"
915 format=""
916 description="user want to banish the player he's targeting" />
917 <leaf name="BANISH_GUILD"
918 sendto="EGS"
919 format=""
920 description="user want to banish the guild of the player he's targeting" />
921 <!-- buildings management -->
922 <leaf name="BUY_BUILDING"
923 sendto="EGS"
924 format="u8 u8 u8"
925 description="Buy a new building (version, outpostnb, line)" />
926 <leaf name="DESTROY_BUILDING"
927 sendto="EGS"
928 format="u8 u8 u8 u8"
929 description="Destroy a building (version, outpostnb, list, line)" />
930 </branch>
931 <!-- SBricks related message -->
932 <branch name="PHRASE">
933 <!-- if the dest known sentence is memorized on server (memorized or DefaultAction/NextAction) it should be unmemorized -->
934 <leaf name="DELETE"
935 sendto="EGS"
936 format="u16"
937 description="the client delete a Known phrase" />
938 <leaf name="LEARN" />
939 <!-- "the client learn a phrase, replacing old one" (phraseId $u16 / phraseDesc $CSPhraseCom)-->
940 <leaf name="MEMORIZE" />
941 <!-- "the client Memorize a known phrase (MemoryTypeId $u8/ MemorySlotId $u8/ PhraseId $u16/ Phrase Desc $CSPhraseCom)" -->
942 <leaf name="FORGET"
943 sendto="EGS"
944 format="u8 u8"
945 description="the client forget a Memorized phrase (MemoryTypeId / MemorySlotId)" />
946 <leaf name="EXECUTE"
947 sendto="EGS"
948 format="u8 u8"
949 description="the client execute a Memorized phrase (MemoryTypeId / MemorySlotId)" />
950 <leaf name="EXECUTE_CYCLIC"
951 sendto="EGS"
952 format="u8 u8"
953 description="the client execute set a cyclic Memorized phrase (MemoryTypeId / MemorySlotId)" />
954 <leaf name="EXECUTE_FABER" />
955 <!-- FaberPlanSheetId u32/ MemoryTypeId u8/ MemorySlotId u8 / vector<CItemFaberMsg> listOfMpSelectedForFaber -->
956 <!-- Impulse ServerToClient -->
957 <leaf name="DOWNLOAD" />
958 <!-- the server upload all Known Phrases and All Memorized Phrases to the client: vector<CSPhraseSlot> / vector<CSPhraseMemorySlot> -->
959 <!-- BotChat -->
960 <leaf name="BUY"
961 sendto="EGS"
962 format="u8 u16"
963 description="the client buy a botChat phrase (indexInBotChat, phraseId)" />
964 <leaf name="CONFIRM_BUY" />
965 <!-- server To client: confirm the buy of phraseId (phraseId $u16 / ok $bool) -->
966 <leaf name="BUY_SHEET"
967 sendto="EGS"
968 format="u32 u16"
969 description="the client buy a botChat phrase (phrase SheetId, phraseId). Nb: can be a charac phrase" />
970 <!-- Link -->
971 <leaf name="CANCEL_LINK"
972 sendto="EGS"
973 format="u8 u8"
974 description="the client cancel a link $link_id/$counter" />
975 <!-- Cancel phrases -->
976 <leaf name="CANCEL_TOP"
977 sendto="EGS"
978 format=""
979 description="the client cancel it's top phrase" />
980 <leaf name="CANCEL_ALL"
981 sendto="EGS"
982 format=""
983 description="the client cancel all its phrases" />
984 <leaf name="CRISTALIZE"
985 sendto="EGS"
986 format="u8 u8"
987 description="the client cristalize a Memorized phrase (MemoryTypeId / MemorySlotId)" />
988 <leaf name="EXEC_CYCLIC_ACK"
989 description="server send an ack on cyclic phrase execution :$b $u8" />
990 <leaf name="EXEC_NEXT_ACK"
991 description="server send an ack on 'next' phrase execution :$b $u8" />
992 </branch>
993 <branch name="ITEM_INFO">
994 <leaf name="GET"
995 sendto="EGS"
996 format="u16"
997 description="the client ask for a special item info in a inventory slot: inventoryId(u8HIGH)/slotId(u8LOW)" />
998 <leaf name="SET"
999 description="Server answer to the previous message. A CItemInfos class is filled" />
1000 <leaf name="REFRESH_VERSION"
1001 description="Like set but contains only the version, no info required" />
1002 </branch>
1003 <branch name="MISSION_PREREQ">
1004 <leaf name="GET"
1005 sendto="EGS"
1006 format="u8"
1007 description="the client ask for prerequisit infos: slotId" />
1008 <leaf name="SET"
1009 description="Server answer to the previous message. A CPrerequisitInfos class is filled" />
1010 </branch>
1011 <branch name="MISSION">
1012 <leaf name="ENTER_CRITICAL"
1013 sendto="EGS"
1014 format="b"
1015 description="client answer yes/no to enter request (bool)" />
1016 <leaf name="ASK_ENTER_CRITICAL"
1017 description="EGS ask player if he wants to enter a mission critical part, player must answer wihtin 1 minute" />
1018 <leaf name="CLOSE_ENTER_CRITICAL"
1019 description="EGS tell client to close the 'enter critical' proposal window" />
1020 <leaf name="WAKE"
1021 sendto="EGS"
1022 format="u8"
1023 description="client wakes up for mission $u8 (mission same as in database)" />
1024 <leaf name="GROUP_WAKE"
1025 sendto="EGS"
1026 format="u8"
1027 description="client wakes up for group mission $u8 (mission same as in database)" />
1028 </branch>
1029 <branch name="DUEL">
1030 <leaf name="ASK"
1031 sendto="EGS"
1032 format=""
1033 description="client wants to duel its target" />
1034 <leaf name="ACCEPT"
1035 sendto="EGS"
1036 format=""
1037 description="client accept a duel" />
1038 <leaf name="REFUSE"
1039 sendto="EGS"
1040 format=""
1041 description="client refuses a duel" />
1042 <leaf name="ABANDON"
1043 sendto="EGS"
1044 format=""
1045 description="client abandon a duel" />
1046 <leaf name="INVITATION"
1047 description="invitation sent to client (uint32 textId)" />
1048 <leaf name="CANCEL_INVITATION"
1049 description="cancel invitation popup (no param)" />
1050 </branch>
1051 <branch name="PVP_CHALLENGE">
1052 <leaf name="ASK"
1053 sendto="EGS"
1054 format=""
1055 description="client wants to duel its target" />
1056 <leaf name="ACCEPT"
1057 sendto="EGS"
1058 format=""
1059 description="client accept a duel" />
1060 <leaf name="REFUSE"
1061 sendto="EGS"
1062 format=""
1063 description="client refuses a duel" />
1064 <leaf name="ABANDON"
1065 sendto="EGS"
1066 format=""
1067 description="client abandon a duel" />
1068 <leaf name="INVITATION"
1069 description="invitation sent to client (uint32 textId)" />
1070 <leaf name="CANCEL_INVITATION"
1071 description="cancel invitation popup (no param)" />
1072 </branch>
1073 <!-- ****OUT OF DATE COMMANDS****
1074 <branch name="PVP_VERSUS">
1075 <leaf name="CLAN" sendto="EGS" format="u8" description="player choose a clan for this pvp zone, u8 = clan number, 0 = neutral, 1 clan 1, 2 clan 2" />
1076 <leaf name="CHOOSE_CLAN" description="server ask to client choose a clan for pvp versus area where character enter: EGSPD::CPeople::TPeople clan1, clan2" />
1077 </branch>
1078 -->
1079 <branch name="PVP">
1080 <leaf name="PVP_TAG"
1081 sendto="EGS"
1082 format="u8"
1083 description="client want set PVP_TAG to TRUE or FALSE" />
1084 <leaf name="SET_NEUTRAL_ALLEGIANCE"
1085 sendto="EGS"
1086 format="u8"
1087 description="client want set allegiance to neutral from indetermined status (u8 = PVP_CLAN::TPVPClan (game_share/pvp_clan.h))" />
1088 <leaf name="SET_NEUTRAL_ALLEGIANCE_GUILD"
1089 sendto="EGS"
1090 format="u8"
1091 description="client want set allegiance to neutral from indetermined status for his GUILD (u8 = PVP_CLAN::TPVPClan (game_share/pvp_clan.h))" />
1092 </branch>
1093 <branch name="PVP_FACTION">
1094 <leaf name="PUSH_FACTION_WAR"
1095 format="u8 u8"
1096 description="a new faction war starts" />
1097 <leaf name="POP_FACTION_WAR"
1098 format="u8 u8"
1099 description="a faction ends" />
1100 <leaf name="FACTION_WARS"
1101 description="a faction ends" />
1102 </branch>
1103 <branch name="ENCYCLOPEDIA">
1104 <leaf name="UPDATE"
1105 description="server update the encyclopedia (see msg_encyclopedia.cpp in game_share for the message format)" />
1106 <leaf name="INIT"
1107 description="server sends the whole encyclopedia to the client" />
1108 </branch>
1109 <branch name="USER">
1110 <leaf name="BARS"
1111 format="u8 s16 s16 s16 s16"
1112 description="server update the players Bars (fast message) $msgNumber $hp $sap $sta $focus" />
1113 <leaf name="POPUP"
1114 format="u32 u32"
1115 description="server display an important info message on the client (u32 titleDynString u32 textDynString)" />
1116 </branch>
1117 <branch name="EVENT">
1118 <leaf name="SET_ITEM_CUSTOM_TEXT"
1119 sendto="EGS"
1120 format="u32 u32 uc"
1121 description="set the cursom of the item in inventory $inventory in slot $slot to $text" />
1122 <leaf name="DUMMY"
1123 description="stupid server....." />
1124 </branch>
1125 <branch name="TOTEM">
1126 <leaf name="BUILD"
1127 sendto="EGS"
1128 format=""
1129 description="client has built a totem" />
1130 <leaf name="DUMMY"
1131 description="stupid server....." />
1132 </branch>
1133 <branch name="MODULE_GATEWAY">
1134 <leaf name="FEOPEN"
1135 description="The fe gateway route is open" />
1136 <leaf name="GATEWAY_MSG"
1137 description="the fe module gateway transport send a message to the client transport peer" />
1138 <leaf name="FECLOSE"
1139 description="The fe gateway route is closed" />
1140 </branch>
1141 <branch name="SEASON">
1142 <leaf name="SET" />
1143 <leaf name="DUMMY"
1144 description="stupid server....." />
1145 </branch>
1146 <branch name="DM_GIFT">
1147 <leaf name="BEGIN"
1148 sendto="EGS"
1149 format="" />
1150 <!-- signal the server that a dm gift is about to occur with the current target -->
1151 <leaf name="VALIDATE"
1152 sendto="EGS"
1153 format="u32 u8 u32 u8 u32 u8 u32 u8 u32 u8 u32 u8 u32 u8 u32 u8" />
1154 <!-- send 8 slots of the DM gift (u32 sheet, u8 quantity) -->
1155 </branch>
1156 <branch name="RING_MISSION">
1157 <leaf name="MISSION_RING_SELECT"
1158 sendto="EGS"
1159 format="u32"
1160 description="client choose an action in ring mission (u8 = actionId)" />
1161 <leaf name="DSS_DOWN" />
1162 </branch>
1163 <branch name="NPC_ICON">
1164 <leaf name="GET_DESC"
1165 description="client to server request" />
1166 <leaf name="SET_DESC"
1167 description="server response" />
1168 <leaf name="SVR_EVENT_MIS_AVL"
1169 description="server had an event that might change mission availability" />
1170 <leaf name="SET_TIMER"
1171 description="server sets a new timer period" />
1172 </branch>
1173 </client_messages_description>