Fix checkRpItemsPosition
[ryzomcore.git] / ryzom / client / data / gamedev / interfaces_v3 / local_database.xml
blob1d3c3b5406a1dc113f71c4d582d13a5c16ae1488
1 <database_description>
2   <!-- Used because the skill points are locally updated (at buy phrase time)     -->
3   <branch name="USER"
4           bank="PLR">
5     <branch name="SKILL_POINTS_"
6             bank="PLR"
7             count="4">
8       <leaf name="VALUE"
9             type="I32" />
10     </branch>
11     <branch name="FACTION_POINTS_"
12             count="6">
13       <!-- game_share/pvp_clan.h (0 is BeginClans and size is EndClans-BeginClans+1 -->
14       <leaf name="VALUE"
15             type="I32" />
16     </branch>
17   </branch>
18   <!-- The Inventory Local DB -->
19   <branch name="INVENTORY"
20           bank="PLR">
21     <branch name="HAND">
22       <branch name=""
23               count="2">
24         <!-- 0 Right 1 Left -->
25         <leaf name="INDEX_IN_BAG"
26               type="I9" />
27         <!-- 0 nothing 1-256 index in bag from 0 to 255 -->
28       </branch>
29     </branch>
30     <branch name="BAG">
31       <branch name=""
32               count="500">
33         <!-- Common Item Data -->
34         <leaf name="SHEET"
35               type="I32" />
36         <leaf name="QUALITY"
37               type="I10" />
38         <leaf name="QUANTITY"
39               type="I10" />
40         <leaf name="CREATE_TIME"
41               type="I32" />
42         <leaf name="SERIAL"
43               type="I32" />
44         <leaf name="USER_COLOR"
45               type="I3" />
46         <leaf name="LOCKED"
47               type="I10" />
48         <leaf name="WEIGHT"
49               type="I16" />
50         <!-- weight. see DB_WEIGHT_SCALE-->
51         <leaf name="NAMEID"
52               type="I32" />
53         <!-- 0 or special name of item -->
54         <leaf name="INFO_VERSION"
55               type="I8" />
56         <leaf name="ENCHANT"
57               type="I10" />
58         <leaf name="RM_CLASS_TYPE"
59               type="I3" />
60         <leaf name="RM_FABER_STAT_TYPE"
61               type="I5" />
62         <leaf name="PREREQUISIT_VALID"
63               type="I1" />
64         <leaf name="PRICE"
65               type="I32" />
66         <leaf name="RESALE_FLAG"
67               type="I2" />
68         <!-- TBotChatResaleFlag -->
69         <leaf name="WORNED"
70               type="I1" />
71         <!-- true if item is worned (show a red cross) -->
72       </branch>
73     </branch>
74     <!-- MAX_INVENTORY_ANIMAL -->
75     <branch name="PACK_ANIMAL"
76             count="7">
77       <branch name=""
78               count="500">
79         <!-- Common Item Data -->
80         <leaf name="SHEET"
81               type="I32" />
82         <leaf name="QUALITY"
83               type="I10" />
84         <leaf name="QUANTITY"
85               type="I10" />
86         <leaf name="CREATE_TIME"
87               type="I32" />
88         <leaf name="SERIAL"
89               type="I32" />
90         <leaf name="USER_COLOR"
91               type="I3" />
92         <leaf name="LOCKED"
93               type="I10" />
94         <leaf name="WEIGHT"
95               type="I16" />
96         <!-- weight. see DB_WEIGHT_SCALE-->
97         <leaf name="NAMEID"
98               type="I32" />
99         <!-- 0 or special name of item -->
100         <leaf name="INFO_VERSION"
101               type="I8" />
102         <leaf name="ENCHANT"
103               type="I10" />
104         <leaf name="RM_CLASS_TYPE"
105               type="I3" />
106         <leaf name="RM_FABER_STAT_TYPE"
107               type="I5" />
108         <leaf name="PREREQUISIT_VALID"
109               type="I1" />
110         <leaf name="PRICE"
111               type="I32" />
112         <leaf name="RESALE_FLAG"
113               type="I2" />
114         <!-- TBotChatResaleFlag -->
115       </branch>
116     </branch>
117     <branch name="EQUIP">
118       <!-- jewelry + armor -->
119       <branch name=""
120               count="19">
121         <leaf name="INDEX_IN_BAG"
122               type="I9" />
123         <!-- same as hand -->
124       </branch>
125     </branch>
126     <branch name="HOTBAR">
127       <branch name=""
128               count="5">
129         <leaf name="INDEX_IN_BAG"
130               type="I9" />
131         <!-- same as hand -->
132       </branch>
133     </branch>
134     <branch name="TEMP">
135       <!-- used for harvest loot and bag full -->
136       <leaf name="TYPE"
137             type="I8" />
138       <!-- Type of temp inv see temp_inventory_mode in game_share -->
139       <branch name=""
140               count="16">
141         <!-- client/inventory_manager.h MAX_TEMPINV_ENTRIES and egs/player_inv_temp.h TempInvSize -->
142         <!-- Common Item Data -->
143         <leaf name="SHEET"
144               type="I32" />
145         <leaf name="QUALITY"
146               type="I10" />
147         <leaf name="QUANTITY"
148               type="I10" />
149         <leaf name="CREATE_TIME"
150               type="I32" />
151         <leaf name="SERIAL"
152               type="I32" />
153         <leaf name="USER_COLOR"
154               type="I3" />
155         <!-- No LOCKED state -->
156         <leaf name="WEIGHT"
157               type="I16" />
158         <!-- weight. see DB_WEIGHT_SCALE-->
159         <leaf name="NAMEID"
160               type="I32" />
161         <!-- 0 or special name of item -->
162         <leaf name="INFO_VERSION"
163               type="I8" />
164         <leaf name="ENCHANT"
165               type="I10" />
166         <leaf name="RM_CLASS_TYPE"
167               type="I3" />
168         <leaf name="RM_FABER_STAT_TYPE"
169               type="I5" />
170         <leaf name="PREREQUISIT_VALID"
171               type="I1" />
172       </branch>
173       <leaf name="ENABLE_TAKE"
174             type="I1" />
175       <!-- Used only in forage -->
176     </branch>
177     <branch name="SHARE">
178       <!-- used to share items between team members (up to 8 players) -->
179       <leaf name="SESSION"
180             type="I8" />
181       <!-- session id -->
182       <branch name=""
183               count="16">
184         <!-- Common Item Data -->
185         <leaf name="SHEET"
186               type="I32" />
187         <leaf name="QUALITY"
188               type="I10" />
189         <leaf name="QUANTITY"
190               type="I10" />
191         <leaf name="CREATE_TIME"
192               type="I32" />
193         <leaf name="SERIAL"
194               type="I32" />
195         <leaf name="USER_COLOR"
196               type="I3" />
197         <leaf name="WEIGHT"
198               type="I16" />
199         <!-- weight. see DB_WEIGHT_SCALE-->
200         <leaf name="NAMEID"
201               type="I32" />
202         <!-- 0 or special name of item -->
203         <leaf name="INFO_VERSION"
204               type="I8" />
205         <leaf name="ENCHANT"
206               type="I10" />
207         <leaf name="RM_CLASS_TYPE"
208               type="I3" />
209         <leaf name="RM_FABER_STAT_TYPE"
210               type="I5" />
211         <leaf name="PREREQUISIT_VALID"
212               type="I1" />
213         <!-- Additionnal info -->
214         <leaf name="NB_MEMBER"
215               type="I4" />
216         <!-- Number of team member who wants this item or phrase -->
217         <leaf name="WANTED"
218               type="I1" />
219         <!-- Does the player wants this item or phrase ? -->
220         <leaf name="CHANCE"
221               type="I7" />
222         <!-- Chance in percentage the player has to obtain this item -->
223       </branch>
224       <branch name="TM_"
225               count="8">
226         <!-- all the team members -->
227         <leaf name="NAME"
228               type="TEXT" />
229         <leaf name="VALID"
230               type="I1" />
231         <!-- is the team member has validated its own selection ? -->
232       </branch>
233     </branch>
234     <branch name="ROOM">
235       <leaf name="SESSION"
236             type="I16" />
237       <leaf name="BULK_MAX"
238             type="I32" />
239       <leaf name="MONEY"
240             type="I64" />
241       <branch name=""
242               count="1000">
243         <!-- Common Item Data -->
244         <leaf name="SHEET"
245               type="I32" />
246         <leaf name="QUALITY"
247               type="I10" />
248         <leaf name="QUANTITY"
249               type="I10" />
250         <leaf name="CREATE_TIME"
251               type="I32" />
252         <leaf name="SERIAL"
253               type="I32" />
254         <leaf name="USER_COLOR"
255               type="I3" />
256         <leaf name="LOCKED"
257               type="I10" />
258         <leaf name="WEIGHT"
259               type="I16" />
260         <!-- weight. see DB_WEIGHT_SCALE-->
261         <leaf name="NAMEID"
262               type="I32" />
263         <!-- 0 or special name of item -->
264         <leaf name="INFO_VERSION"
265               type="I8" />
266         <leaf name="ENCHANT"
267               type="I10" />
268         <!-- 0=not enchanted, 1=enchanted nbcharge 0, 10=e. nbcharge 9 -->
269         <leaf name="RM_CLASS_TYPE"
270               type="I3" />
271         <leaf name="RM_FABER_STAT_TYPE"
272               type="I5" />
273         <leaf name="PREREQUISIT_VALID"
274               type="I1" />
275         <leaf name="RESALE_FLAG"
276               type="I2" />
277       </branch>
278     </branch>
279     <leaf name="MONEY"
280           type="I64" />
281   </branch>
282   <!-- gift from animator (dm) to player -->
283   <branch name="DM_GIFT"
284           bank="PLR">
285     <leaf name="TEXT"
286           type="I32" />
287     <!-- caption of the gift window -->
288   </branch>
289   <!-- player trade & gift to bot -->
290   <branch name="EXCHANGE">
291     <leaf name="TEXT"
292           type="I32" />
293     <leaf name="ID"
294           type="I8" />
295     <leaf name="BEGUN"
296           type="I1" />
297     <leaf name="ACCEPTED"
298           type="I1" />
299     <leaf name="MONEY"
300           type="I64" />
301     <branch name="GIVE">
302       <branch name=""
303               count="10"> <!-- Change in database.xml, player_trade.lua and NbExchangeSlots on server-->
304         <!-- Common Item Data --> 
305         <leaf name="SHEET"
306               type="I32" />
307         <leaf name="QUALITY"
308               type="I10" />
309         <leaf name="QUANTITY"
310               type="I10" />
311         <leaf name="CREATE_TIME"
312               type="I32" />
313         <leaf name="SERIAL"
314               type="I32" />
315         <leaf name="USER_COLOR"
316               type="I3" />
317         <!-- <leaf name="LOCKED"                        type="I10"/> No longer needed -->
318         <leaf name="WEIGHT"
319               type="I16" />
320         <!-- weight. see DB_WEIGHT_SCALE-->
321         <leaf name="NAMEID"
322               type="I32" />
323         <!-- 0 or special name of item -->
324         <leaf name="INFO_VERSION"
325               type="I8" />
326         <leaf name="ENCHANT"
327               type="I10" />
328         <leaf name="RM_CLASS_TYPE"
329               type="I3" />
330         <leaf name="RM_FABER_STAT_TYPE"
331               type="I5" />
332         <leaf name="PREREQUISIT_VALID"
333               type="I1" />
334       </branch>
335     </branch>
336     <branch name="RECEIVE">
337       <branch name=""
338               count="10"> <!-- Change in database.xml, player_trade.lua and NbExchangeSlots on server-->
339         <!-- Common Item Data -->
340         <leaf name="SHEET"
341               type="I32" />
342         <leaf name="QUALITY"
343               type="I10" />
344         <leaf name="QUANTITY"
345               type="I10" />
346         <leaf name="CREATE_TIME"
347               type="I32" />
348         <leaf name="SERIAL"
349               type="I32" />
350         <leaf name="USER_COLOR"
351               type="I3" />
352         <!-- <leaf name="LOCKED"                        type="I10"/> No longer needed -->
353         <leaf name="WEIGHT"
354               type="I16" />
355         <!-- weight. see DB_WEIGHT_SCALE-->
356         <leaf name="NAMEID"
357               type="I32" />
358         <!-- 0 or special name of item -->
359         <leaf name="INFO_VERSION"
360               type="I8" />
361         <leaf name="ENCHANT"
362               type="I10" />
363         <leaf name="RM_CLASS_TYPE"
364               type="I3" />
365         <leaf name="RM_FABER_STAT_TYPE"
366               type="I5" />
367         <leaf name="PREREQUISIT_VALID"
368               type="I1" />
369       </branch>
370     </branch>
371   </branch>
372   <!-- NB this is not a copy of the server db, but the concatenation of all ascensor pages -->
373   <branch name="ASCENSOR">
374     <branch name=""
375             count="512">
376       <leaf name="ICON"
377             type="I64" />
378       <leaf name="NAME"
379             type="I32" />
380     </branch>
381   </branch>
382   <!-- NB this is not a copy of the server db, but the concatenation of all items pages -->
383   <branch name="TRADING">
384     <branch name=""
385             count="1024">
386       <!-- Common Item Data -->
387       <leaf name="SHEET"
388             type="I32" />
389       <leaf name="QUALITY"
390             type="I10" />
391       <leaf name="QUANTITY"
392             type="I10" />
393       <leaf name="CREATE_TIME"
394               type="I32" />
395       <leaf name="SERIAL"
396               type="I32" />
397       <!-- No LOCKED state -->
398       <leaf name="USER_COLOR"
399             type="I3" />
400       <leaf name="WEIGHT"
401             type="I16" />
402       <!-- weight. see DB_WEIGHT_SCALE-->
403       <leaf name="NAMEID"
404             type="I32" />
405       <!-- 0 or special name of item -->
406       <leaf name="INFO_VERSION"
407             type="I8" />
408       <leaf name="ENCHANT"
409             type="I10" />
410       <leaf name="RM_CLASS_TYPE"
411             type="I3" />
412       <leaf name="RM_FABER_STAT_TYPE"
413             type="I5" />
414       <leaf name="PREREQUISIT_VALID"
415             type="I1" />
416       <!-- Special Trade -->
417       <leaf name="PRICE"
418             type="I32" />
419       <leaf name="PRICE_RETIRE"
420             type="I32" />
421       <leaf name="RESALE_TIME_LEFT"
422             type="I16" />
423       <leaf name="VENDOR_NAMEID"
424             type="I32" />
425       <!-- name id of player vendor -->
426       <leaf name="FACTION_TYPE"
427             type="I4" />
428       <!-- game_share/pvp_clan.h -->
429       <leaf name="FACTION_POINT_PRICE"
430             type="I32" />
431       <!-- 0 for standard behaviour -->
432       <!-- 1 if the sheet id is the one of an item, and if we got a plan for that item in the slot -->
433       <!-- 2 if the slot is for a skill. In this case the sheet ID must be interpreted as an enum for that skill -->
434       <!-- These values are defined as an enum in game_share/trade_slot_type.h -->
435       <leaf name="SLOT_TYPE"
436             type="I2" />
437       <!-- see TBotChatSellerType -->
438       <leaf name="SELLER_TYPE"
439             type="I2" />
440     </branch>
441   </branch>
442   <!-- NB this is not a copy of the server db, but the concatenation of all items pages -->
443   <!--
444         <branch name="ITEMS_FOR_MISSIONS">
445                 <branch name="" count="512">
446                         -->
447   <!--<leaf name="SHEET"                  type="I32"/>
448                         <leaf name="QUALITY"            type="I16"/>
449                         <leaf name="WEIGHT"                     type="I16"/>
450                         <leaf name="NAMEID"                     type="I32"/>
451                         <leaf name="INFO_VERSION"       type="I8"/>
452                         -->
453   <!-- the same than for TRADING:x:SLOT_type -->
454   <!--
455                         <leaf name="SLOT_TYPE"                  type="I2"/>
456                         <leaf name="LOGIC_TEXT_ID"      type="I32"/>
457                         <leaf name="DESC_TEXT_ID"      type="I32"/>
458                 </branch>
459         </branch>-->
460   <!-- NB this is not a copy of the server db, but the concatenation of all mission -->
461   <branch name="CHOOSE_MISSIONS">
462     <branch name=""
463             count="512">
464       <leaf name="ICON"
465             type="I32" />
466       <leaf name="TEXT"
467             type="I32" />
468       <leaf name="DETAIL_TEXT"
469             type="I32" />
470       <leaf name="PREREQ_STATE"
471             type="I8" />
472     </branch>
473   </branch>
474   <branch name="CHARACTER_INFO"
475           bank="PLR">
476     <branch name="CAREER"
477             count="16">
478       <branch name="JOB"
479               count="8">
480         <leaf name="JOB_CAP"
481               type="I12" />
482         <!-- (0,no) (10-250,valid more later) -->
483         <leaf name="STATUS"
484               type="I1" />
485         <!-- Bit 1 is the Frozen State. 1 for frozen -->
486         <leaf name="BEGIN_FREEZE_TIME"
487               type="I32" />
488         <!-- Valide if STATUS (Frozen State) is 1 (frozen), in SERVER TICKS TIME, can unfreeze if gamecycle > FREEZE_TIME -->
489         <leaf name="END_FREEZE_TIME"
490               type="I32" />
491         <!-- Valide if STATUS (Frozen State) is 1 (frozen), in SERVER TICKS TIME, can unfreeze if gamecycle > FREEZE_TIME -->
492       </branch>
493     </branch>
494   </branch>
495   <!-- context menu -->
496   <branch name="TARGET"
497           bank="PLR">
498     <branch name="CONTEXT_MENU"
499             bank="PLR"
500             atom="1">
501       <leaf name="PROGRAMMES"
502             type="I32" />
503       <!-- options for missions in the context menu -->
504       <branch name="MISSIONS_OPTIONS"
505               bank="PLR">
506         <branch name=""
507                 count="8"
508                 atom="1">
509           <leaf name="TITLE"
510                 type="I32" />
511           <!-- a text ID of 0 means there's no action. Text ID are reseted when a new character is targeted -->
512           <leaf name="PLAYER_GIFT_NEEDED"
513                 type="I1" />
514           <!-- want a player gift ? -->
515           <leaf name="PRIORITY"
516                 type="I2" />
517           <!-- priority of the option : the higher it is, the higher the option will be displayed in the menu -->
518         </branch>
519       </branch>
520       <!-- A NPC may offer to view a webpage -->
521       <leaf name="WEB_PAGE_URL"
522             type="I32" />
523       <!-- a text ID of 0 means there's no WebPage -->
524       <leaf name="WEB_PAGE_TITLE"
525             type="I32" />
526       <!-- a text ID of 0 means there's no WebPage -->
527       <!-- A NPC may offer to view an outpost -->
528       <leaf name="OUTPOST"
529             type="I32" />
530       <!-- outpost this bot give access to (sheet id inside) -->
531       <!-- Mission rings -->
532       <branch name="MISSION_RING">
533         <branch name=""
534                 count="4">
535           <leaf name="TITLE"
536                 type="I32" />
537           <!-- a text ID of 0 means there's no action. Text ID are reseted when a new character is targeted -->
538           <leaf name="ID"
539                 type="I32" />
540           <!-- the id of the action if selected -->
541         </branch>
542       </branch>
543     </branch>
544   </branch>
545   <!-- R2 specific -->
546   <branch name="R2">
547     <branch name="PLOT_ITEMS">
548       <!-- IMPORTANT : update the define in r2ed_scenario.xml if you change this value -->
549       <branch name=""
550               count="32"
551               atom="">
552         <leaf name="SHEET"
553               type="I32" />
554       </branch>
555     </branch>
556     <branch name="AVAILABLE_PLOT_ITEMS">
557       <!-- IMPORTANT : update the define in r2ed_scenario.xml if you change this value -->
558       <branch name=""
559               count="200"
560               atom="">
561         <leaf name="SHEET"
562               type="I32" />
563       </branch>
564     </branch>
565     <branch name="REFERENCE_PLOT_ITEMS">
566       <!-- IMPORTANT : update the define in r2ed_scenario.xml if you change this value -->
567       <branch name=""
568               count="200"
569               atom="">
570         <leaf name="SHEET"
571               type="I32" />
572       </branch>
573     </branch>
574     <branch name="CURR_PLOT_ITEM">
575       <leaf name="SHEET"
576             type="I32" />
577     </branch>
578     <!-- DM GIFT -->
579     <branch name="DM_GIFT">
580       <branch name=""
581               count="8"
582               atom="">
583         <leaf name="SHEET"
584               type="I32" />
585         <leaf name="QUANTITY"
586               type="I32" />
587       </branch>
588     </branch>
589   </branch>
590 </database_description>