-
Notifications
You must be signed in to change notification settings - Fork 81
/
Copy pathdf.item.xml
2469 lines (2079 loc) · 109 KB
/
df.item.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<data-definition>
-- Unused: ArmorRole
<bitfield-type type-name='item_body_component_flag' base-type='uint32_t'> bay12: ITEM_BODY_COMPONENT_FLAG_*
<flag-bit name='unbutchered'/>
<flag-bit name='plant'/>
<flag-bit name='silk'/>
<flag-bit name='leather'/>
<flag-bit name='bone'/>
<flag-bit name='shell'/>
<flag-bit name='wood'/>
<flag-bit name='soap'/>
<flag-bit name='tooth'/>
<flag-bit name='horn'/>
<flag-bit name='pearl'/>
<flag-bit name='rottable'/>
<flag-bit name='skull'/>
<flag-bit name='use_blood_color'/>
<flag-bit name='hair_wool'/>
<flag-bit name='yarn'/>
<flag-bit name='must_rot_body'/>
<flag-bit name='must_refresh_texture'/>
</bitfield-type>
<enum-type type-name='job_item_vector_id' base-type='int16_t'> bay12: ItemArrayType
<enum-attr name='other' type-name='items_other_id'
default-value='ANY' use-key-name='true'/>
<enum-item name='ANY'/>
-- 1
<enum-item name='IN_PLAY'/>
<enum-item name='ANY_ARTIFACT'/>
<enum-item name='WEAPON'/>
<enum-item name='ANY_WEAPON'/>
<enum-item name='ANY_SPIKE'/>
<enum-item name='ANY_TRUE_ARMOR'/>
<enum-item name='ANY_ARMOR_HELM'/>
<enum-item name='ANY_ARMOR_SHOES'/>
<enum-item name='SHIELD'/>
<enum-item name='ANY_ARMOR_GLOVES'/>
-- 11
<enum-item name='ANY_ARMOR_PANTS'/>
<enum-item name='QUIVER'/>
<enum-item name='SPLINT'/>
<enum-item name='ORTHOPEDIC_CAST'/>
<enum-item name='CRUTCH'/>
<enum-item name='BACKPACK'/>
<enum-item name='AMMO'/>
<enum-item name='WOOD'/>
<enum-item name='BOULDER'/>
<enum-item name='ROCK'/>
-- 21
<enum-item name='ANY_REFUSE'/>
<enum-item name='ANY_GOOD_FOOD'/>
<enum-item name='ANY_AUTO_CLEAN'/>
<enum-item name='ANY_EXTRACTABLE'/>
<enum-item name='ANY_BUTCHERABLE'/>
<enum-item name='ANY_FURNITURE'/>
<enum-item name='ANY_CAGE_OR_TRAP'/>
<enum-item name='ANY_EDIBLE_RAW'/>
<enum-item name='ANY_EDIBLE_CARNIVORE'/>
<enum-item name='ANY_EDIBLE_BONECARN'/>
-- 31
<enum-item name='ANY_EDIBLE_VERMIN'/>
<enum-item name='ANY_EDIBLE_VERMIN_BOX'/>
<enum-item name='ANY_CAN_ROT'/>
<enum-item name='ANY_MURDERED'/>
<enum-item name='ANY_DEAD_DWARF'/>
<enum-item name='ANY_GOES_IN_CHEST'/>
<enum-item name='ANY_GOES_IN_CABINET'/>
<enum-item name='ANY_GOES_IN_WEAPONRACK'/>
<enum-item name='ANY_GOES_IN_ARMORSTAND'/>
<enum-item name='DOOR'/>
-- 41
<enum-item name='FLOODGATE'/>
<enum-item name='HATCH_COVER'/>
<enum-item name='GRATE'/>
<enum-item name='CAGE'/>
<enum-item name='FLASK'/>
<enum-item name='WINDOW'/>
<enum-item name='GOBLET'/>
<enum-item name='INSTRUMENT'/>
<enum-item name='TOY'/>
SKIPPED: TOOL
-- 50
<enum-item name='BUCKET'/>
<enum-item name='BARREL'/>
<enum-item name='CHAIN'/>
<enum-item name='ANIMALTRAP'/>
<enum-item name='BED'/>
<enum-item name='TRACTION_BENCH'/>
<enum-item name='CHAIR'/>
<enum-item name='COFFIN'/>
<enum-item name='TABLE'/>
<enum-item name='STATUE'/>
-- 60
SKIPPED: SLAB
<enum-item name='QUERN'/>
<enum-item name='MILLSTONE'/>
<enum-item name='BOX'/>
<enum-item name='BIN'/>
<enum-item name='ARMORSTAND'/>
<enum-item name='WEAPONRACK'/>
<enum-item name='CABINET'/>
<enum-item name='ANVIL'/>
<enum-item name='CATAPULTPARTS'/>
-- 69
<enum-item name='BALLISTAPARTS'/>
<enum-item name='SIEGEAMMO'/>
<enum-item name='TRAPPARTS'/>
<enum-item name='ANY_WEBS'/>
<enum-item name='PIPE_SECTION'/>
<enum-item name='ANY_ENCASED'/>
<enum-item name='ANY_IN_CONSTRUCTION'/>
<enum-item name='DRINK'/>
<enum-item name='ANY_DRINK'/>
<enum-item name='LIQUID_MISC'/>
-- 79
<enum-item name='POWDER_MISC'/>
<enum-item name='ANY_COOKABLE'/>
<enum-item name='ANY_GLASSABLE'/>
<enum-item name='VERMIN'/>
<enum-item name='PET'/>
<enum-item name='ANY_CRITTER'/>
<enum-item name='COIN'/>
<enum-item name='GLOB'/>
-- 87 -> 125
<enum-item name='ANY_RECENTLY_DROPPED'/>
<enum-item name='ANY_MELT_DESIGNATED'/>
<enum-item comment='TEMP_SAVE, should never actually be used'/>
-- 90
<enum-item name='TRAPCOMP'/>
<enum-item name='BAR'/>
-- 92
<enum-item name='SMALLGEM'/>
<enum-item name='BLOCKS'/>
<enum-item name='ROUGH'/>
<enum-item name='CORPSE'/>
<enum-item name='FIGURINE'/>
<enum-item name='AMULET'/>
<enum-item name='SCEPTER'/>
<enum-item name='CROWN'/>
<enum-item name='RING'/>
<enum-item name='EARRING'/>
-- 102
<enum-item name='BRACELET'/>
<enum-item name='GEM'/>
<enum-item name='CORPSEPIECE'/>
<enum-item name='REMAINS'/>
<enum-item name='MEAT'/>
<enum-item name='FISH'/>
<enum-item name='FISH_RAW'/>
LATER: EGG
<enum-item name='SEEDS'/>
<enum-item name='PLANT'/>
-- 111
<enum-item name='SKIN_TANNED'/>
<enum-item name='PLANT_GROWTH'/>
<enum-item name='THREAD'/>
<enum-item name='CLOTH'/>
<enum-item name='TOTEM'/>
<enum-item name='PANTS'/>
<enum-item name='CHEESE'/>
<enum-item name='FOOD'/>
<enum-item name='BALLISTAARROWHEAD'/>
<enum-item name='ARMOR'/>
-- 121
<enum-item name='SHOES'/>
<enum-item name='HELM'/>
<enum-item name='GLOVES'/>
<enum-item name='TOOL'/>
<enum-item name='SLAB'/>
<enum-item name='EGG'/>
<enum-item name='POSSIBLE_CONTAINER'/>
<enum-item name='ANY_CORPSE'/>
<enum-item name='BOOK'/>
<enum-item name='FOOD_STORAGE'/>
-- 131
<enum-item name='INSTRUMENT_STATIONARY'/>
<enum-item name='SHEET'/>
<enum-item name='BRANCH'/>
<enum-item name='BAG'/>
<enum-item name='MAGICAL'/>
</enum-type>
<struct-type type-name='item_kill_info' original-name='item_profile_combat_killst'>
<compound name='targets' comment='not actually a compound, do NOT replace with kill_profilest!'>
-- Important
<stl-vector name="events" type-name='int32_t' ref-target='history_event'/>
-- Misc
<stl-vector name="killed_race" type-name='int16_t' ref-target='creature_raw'/>
<stl-vector name="killed_caste" type-name='int16_t' ref-target='caste_raw' aux-value='$$._parent.killed_race[$._key]'/>
<stl-vector name="killed_underground_region" type-name='int32_t' ref-target='world_underground_region'/>
<stl-vector name="killed_region" type-name='int32_t' ref-target='world_region'/>
<stl-vector name="killed_site" type-name='int32_t' ref-target='world_site'/>
<stl-vector name='killed_undead'>
<bitfield type-name='undead_flags'/>
</stl-vector>
<stl-vector name="killed_count" type-name='int32_t'/>
</compound>
-- Wielders
<stl-vector name="slayers" type-name='int32_t' ref-target='historical_figure'/>
<stl-vector name="slayer_kill_counts" type-name='int32_t'/> naming weight 1
</struct-type>
<struct-type type-name='item_history_info' original-name='item_profile_combatst'>
<pointer name='kills' type-name='item_kill_info'/>
<int32_t name='attack_counter' comment='increments by 1 each time the item is fired, thrown or used in an attack'/> naming weight 0.001
<int32_t name='defence_counter' comment='increments by 1 each time the item is used in an attempt to block or parry'/> naming weight 0.01
</struct-type>
<struct-type type-name='item_profilest'>
<pointer name='combat' type-name='item_history_info'/>
</struct-type>
<struct-type type-name='item_stockpile_ref' original-name='stockpile_item_infost'>
<int32_t name='id' ref-target='building'/>
<int16_t name='x'/>
<int16_t name='y'/>
</struct-type>
<class-type type-name='itemimprovement' original-name='itemimprovementst'>
<int16_t name='mat_type' ref-target='material' aux-value='$$.mat_index'/>
<int32_t name='mat_index'/>
<int32_t name='maker' ref-target='historical_figure'/>
<int32_t name='masterpiece_event' ref-target='history_event'/>
<enum base-type='int16_t' name='quality' type-name='item_quality'/>
<enum base-type='int32_t' name="skill_rating" type-name='skill_rating'
comment='at the moment of creation'/>
<int32_t name='age_counter'/>
<virtual-methods>
<vmethod name='getImage'><pointer type-name='item'/>
<ret-type><pointer type-name='art_image'/></ret-type>
</vmethod>
<vmethod name='getColorAndShape'>
<pointer name='colors'><stl-vector type-name='int16_t'/></pointer>
<pointer name='shapes'><stl-vector type-name='int16_t'/></pointer>
<pointer name='item' type-name='item'/>
</vmethod>
<vmethod name='clone'>
<ret-type><pointer type-name='itemimprovement'/></ret-type>
</vmethod>
<vmethod name='write_file'> <pointer name='file' type-name='file_compressorst'/> </vmethod>
<vmethod name='read_file'>
<pointer name='file' type-name='file_compressorst'/>
<enum name='loadversion' type-name='save_version'/>
</vmethod>
<vmethod ret-type='improvement_type' name='getType'/>
<vmethod ret-type='bool' name='isDecoration' comment='displayed_improvement'/>
<vmethod is-destructor='true'/>
<vmethod ret-type='int32_t' name='getDyeValue'>
<pointer type-name='caravan_state' name='caravan'/>
</vmethod>
<vmethod name='setShape'>
<int32_t name='shape' ref-target='descriptor_shape'/>
</vmethod>
</virtual-methods>
</class-type>
<class-type type-name='itemimprovement_art_imagest' inherits-from='itemimprovement'>
<compound name='image'> not a compound
<int32_t name='id' ref-target='art_image_chunk'/>
<int16_t name='subid' ref-target='art_image' aux-value='$$.id'/>
<int32_t name='civ_id' ref-target='historical_entity' since='v0.34.01'/>
<int32_t name='site_id' ref-target='world_site' since='v0.34.01'/>
</compound>
</class-type>
<bitfield-type type-name='itemimprovement_covered_flag' base-type='uint32_t'> bay12: ITEMIMPROVEMENT_COVERED_FLAG_*
<flag-bit name='glazed'/>
</bitfield-type>
<class-type type-name='itemimprovement_coveredst' inherits-from='itemimprovement'>
<bitfield name='cover_flags' base-type='uint32_t' type-name='itemimprovement_covered_flag'/>
<int32_t name='shape' ref-target='descriptor_shape'/>
</class-type>
<class-type type-name='itemimprovement_rings_hangingst' inherits-from='itemimprovement'/>
<class-type type-name='itemimprovement_bandsst' inherits-from='itemimprovement'>
<int32_t name='shape' ref-target='descriptor_shape'/>
</class-type>
<class-type type-name='itemimprovement_spikesst' inherits-from='itemimprovement'/>
<class-type type-name='itemimprovement_itemspecificst' inherits-from='itemimprovement'>
<enum base-type='int32_t' type-name='itemimprovement_specific_type' name='type'/>
</class-type>
<class-type type-name='itemimprovement_threadst' inherits-from='itemimprovement'>
<compound name='dye'> not a compound
<int16_t name='mat_type' ref-target='material' aux-value='$$.mat_index'/>
<int32_t name='mat_index'/>
<int32_t name='dyer' ref-target='historical_figure'/>
<enum base-type='int16_t' name='quality' type-name='item_quality'/>
<enum base-type='int16_t' name="skill_rating" type-name='skill_rating'
comment='at the moment of creation'/>
<int32_t name='age_counter'/>
</compound>
</class-type>
<class-type type-name='itemimprovement_clothst' inherits-from='itemimprovement'/>
<class-type type-name='itemimprovement_sewn_imagest' inherits-from='itemimprovement'>
none of these are actual compounds - beware of potential alignment/padding issues
<compound name='image'> not a compound
<int32_t name='id' ref-target='art_image_chunk'/>
<int16_t name='subid' ref-target='art_image' aux-value='$$.id'/>
<int32_t name='civ_id' ref-target='historical_entity' since='v0.34.01'/>
<int32_t name='site_id' ref-target='world_site' since='v0.34.01'/>
</compound>
<compound name='cloth'> not a compound
<int32_t name='maker_hf' ref-target='historical_figure'/>
<enum base-type='int16_t' name='quality' type-name='item_quality'/>
<enum base-type='int16_t' name="skill_rating" type-name='skill_rating'
comment='at the moment of creation'/>
</compound>
<compound name='dye'> not a compound
<int16_t name='mat_type' ref-target='material' aux-value='$$.mat_index'/>
<int32_t name='mat_index'/>
<int32_t name='dyer' ref-target='historical_figure'/>
<enum base-type='int16_t' name='quality' type-name='item_quality'/>
<enum base-type='int16_t' name="skill_rating" type-name='skill_rating'
comment='at the moment of creation'/>
<int32_t name='age_counter'/>
</compound>
</class-type>
<class-type type-name='itemimprovement_pagesst' inherits-from='itemimprovement'>
<int32_t name='count'/>
<stl-vector name='contents' type-name='int32_t' ref-target='written_content'/>
</class-type>
<class-type type-name='itemimprovement_illustrationst' inherits-from='itemimprovement'>
<compound name='image'> not a compound
<int32_t name='id' ref-target='art_image_chunk'/>
<int16_t name='subid' ref-target='art_image' aux-value='$$.id'/>
<int32_t name='civ_id' ref-target='historical_entity' since='v0.34.01'/>
<int32_t name='site_id' ref-target='world_site' since='v0.34.01'/>
</compound>
<int32_t name='page_number' since='v0.34.01'/> bay12: III_PAGE_* for several special negative values
</class-type>
<class-type type-name='itemimprovement_instrument_piecest' inherits-from='itemimprovement'>
<stl-string name='type' comment='instrument_piece.type'/>
</class-type>
<class-type type-name='itemimprovement_writingst' inherits-from='itemimprovement'>
<stl-vector name='contents' type-name='int32_t' ref-target='written_content'/>
</class-type>
<class-type type-name='itemimprovement_image_setst' inherits-from='itemimprovement'>
<int32_t name='image_set_id' init-value='-1' ref-target='image_set'/>
</class-type>
<enum-type type-name='food_ingredient_type' base-type='int16_t'> bay12: FoodIngredient
<enum-item name='MINCED'/>
</enum-type>
<struct-type type-name='food_ingredientst'>
<enum name='mixtype' base-type='int16_t' type-name='food_ingredient_type'/>
<enum base-type='int16_t' name='item_type' type-name='item_type'/>
<int16_t name='item_subtype' init-value='-1'/>
<int16_t name='mat_type' ref-target='material' aux-value='$$.mat_index'/>
<int32_t name='mat_index' init-value='-1'/>
<int32_t name='maker' ref-target='historical_figure'/>
<enum base-type='int16_t' name='quality' type-name='item_quality'/>
<int32_t name='skill_level'/>
<int32_t name='masterpiece_event' ref-target='history_event'/>
</struct-type>
<bitfield-type type-name='item_flags' base-type='uint32_t'> bay12: ITEMFLAG_*
<flag-bit name='on_ground' comment='Item on ground'/>
<flag-bit name='in_job' comment='Item currently being used in a job'/>
<flag-bit name='hostile' comment='Item owned by hostile'/>
<flag-bit name='in_inventory' comment='Item in a creature, workshop or container inventory'/>
<flag-bit name='removed' comment='completely invisible and with no position'/>
<flag-bit name='in_building' comment='Part of a building (including mechanisms, bodies in coffins)'/>
<flag-bit name='container' comment='Set on anything that contains or contained items?'/>
<flag-bit name='dead_dwarf' comment='Dwarfs dead body or body part'/>
<flag-bit name='rotten' comment='Rotten food'/>
<flag-bit name='spider_web' comment='Thread in spider web'/>
<flag-bit name='construction' comment='Material used in construction'/>
<flag-bit name='encased' comment='Item encased in ice or obsidian'/>
<flag-bit comment='unused'/>
<flag-bit name='murder' comment='Implies murder - used in fell moods'/>
<flag-bit name='foreign' comment='Item is imported'/>
<flag-bit name='trader' comment='Item ownwed by trader'/>
<flag-bit name='owned' comment='Item is owned by a dwarf'/>
<flag-bit name='garbage_collect' comment='Marked for deallocation by DF it seems'/>
<flag-bit name='artifact' comment='Artifact'/>
<flag-bit name='forbid' comment='Forbidden item'/>
<flag-bit name='already_uncategorized' comment='bay12: NONGLOBAL_DELETE'/>
<flag-bit name='dump' comment='Designated for dumping'/>
<flag-bit name='on_fire' comment='Indicates if item is on fire, Will Set Item On Fire if Set!'/>
<flag-bit name='melt' comment='Designated for melting, if applicable'/>
<flag-bit name='hidden' comment='Hidden item'/>
<flag-bit comment='unused'/>
<flag-bit name='use_recorded' comment='transient in unit.used_items update'/>
<flag-bit name='artifact_mood' comment='created by mood/named existing item'/>
<flag-bit name='temps_computed' comment='melting/boiling/ignite/etc. points'/>
<flag-bit name='weight_computed'/>
<flag-bit name='top_open'/>
<flag-bit name='from_worldgen' comment='bay12: DO_NOT_RETAIN_IN_CREATION_ZONE'/>
</bitfield-type>
<bitfield-type type-name='item_flags2' base-type='uint32_t'> bay12: ITEMFLAG2_*
<flag-bit name='has_rider' comment='vehicle with a rider'/>
<flag-bit name='forbid_on_unretire'/>
<flag-bit name='grown'/>
<flag-bit name='location_reserved' comment='possibly book/written-content-related'/>
<flag-bit name='utterly_destroyed'/>
<flag-bit name='might_contain_artifact'/>
</bitfield-type>
-- Unused: ITEMFLAG_CIV_*
<struct-type type-name='item_powerst'>
<int32_t name='interaction_index' init-value='-1'/>
<int32_t name='interaction_source_index' init-value='-1'/>
<int32_t name='delay' init-value='0'/>
</struct-type>
<struct-type type-name='item_magicalst'>
<stl-vector name='power' pointer-type='item_powerst'/>
</struct-type>
-- Unused: ItemNukeResolve
<struct-type type-name='itinfost'>
<enum base-type='int16_t' name='item_type' type-name='item_type'/>
<int16_t name='item_subtype' refers-to='(item-subtype-target $$._parent.item_type $)'/>
<int16_t name='mattype' ref-target='material' aux-value='$$.matindex'/>
<int32_t name='matindex'/>
<int8_t name="on" comment='1 if new, -1 if added'/>
</struct-type>
<class-type type-name='item' original-name='itemst'
instance-vector='$global.world.items.all' key-field='id'>
<compound name='pos' type-name='coord'/>
<bitfield name='flags' type-name='item_flags'/>
<bitfield name='flags2' type-name='item_flags2' since='v0.34.08'/>
<uint32_t name='age'/>
<int32_t name='id'/>
<stl-vector name='specific_refs' pointer-type='specific_ref'/>
<stl-vector name='general_refs' pointer-type='general_ref'/>
<int32_t name='world_data_id' ref-target='world_object_data' since='v0.34.01'/>
<int32_t name='world_data_subid' init-value='-1' since='v0.34.01'/>
<int8_t name='stockpile_countdown' comment='-1 per 50 frames; then check if needs moving'/>
<int8_t name='stockpile_delay' comment='used to reset countdown; randomly varies'/>
<int32_t name='base_uniform_score' comment='temporary_32'/>
<int16_t name='walkable_id' comment='temporary_16; from map_block.walkable'/>
<uint16_t name='spec_heat'/>
<uint16_t name='ignite_point'/>
<uint16_t name='heatdam_point'/>
<uint16_t name='colddam_point'/>
<uint16_t name='boiling_point'/>
<uint16_t name='melting_point'/>
<uint16_t name='fixed_temp'/>
<compound name='weight' type-name='massst' comment='if flags.weight_computed'/>
<virtual-methods>
<vmethod ret-type='item_type' name='getType'/>
<vmethod ret-type='int16_t' name='getSubtype'/>
<vmethod ret-type='int16_t' name='getMaterial'/>
<vmethod ret-type='int32_t' name='getMaterialIndex'/>
<vmethod name='setSubtype'> <int16_t/> </vmethod>
<vmethod name='setMaterial'> <int16_t/> </vmethod>
<vmethod name='setMaterialIndex'> <int32_t/> </vmethod>
<vmethod ret-type='int16_t' name='getActualMaterial'
comment='returns an actual material type, never a race'/>
<vmethod ret-type='int32_t' name='getActualMaterialIndex'
comment='returns an actual material index, never a caste'/>
<vmethod ret-type='int16_t' name='getRace'
comment='only if the object is made of a "specific creature mat"'/>
-- 10
<vmethod ret-type='int16_t' name='getCaste'
comment='only if the object is made of a "specific creature mat"'/>
<vmethod ret-type='int16_t' name='getPlantID'
comment='only if the object is made of a plant material'/>
<vmethod ret-type='int32_t' name='getGrowthPrint' since='v0.40.01'/>
<vmethod name='setGrowthPrint' since='v0.40.01'><int32_t name='print'/></vmethod>
<vmethod ret-type='int32_t' name='getDimension' since='v0.40.01'/>
<vmethod ret-type='int32_t' name='getTotalDimension' comment='get_item_search_contribution'/>
<vmethod name='setDimension'> <int32_t name='amount'/> </vmethod>
<vmethod ret-type='bool' name='subtractDimension'> <int32_t name='amount'/> </vmethod>
<vmethod ret-type='bool' name='isFoodStorage'/>
<vmethod ret-type='bool' name='isTrackCart'/>
-- 20
<vmethod ret-type='bool' name='isWheelbarrow'/>
<vmethod ret-type='int32_t' name='getVehicleID'/>
<vmethod ret-type='bool' name='isCrafted'/>
<vmethod name='getStockpile'>
<ret-type><pointer type-name='item_stockpile_ref'/></ret-type>
</vmethod>
<vmethod ret-type='bool' name='containsPlaster'/>
<vmethod ret-type='bool' name='isPlaster'/>
<vmethod ret-type='bool' name='getColorOverride'> <int16_t name='bg'/> </vmethod>
<vmethod name='getHistoryInfo'>
<ret-type><pointer type-name='item_profilest'/></ret-type>
</vmethod>
<vmethod ret-type='bool' name='hasToolUse'> <enum base-type='int16_t' type-name='tool_uses' name='use'/> </vmethod>
<vmethod ret-type='bool' name='hasInvertedTile'/>
-- 30
<vmethod name='becomePaste'/>
<vmethod name='becomePressed'/>
<vmethod name='calculateWeight'/>
<vmethod ret-type='bool' name='isSharpStone'/>
<vmethod ret-type='bool' name='isCrystalGlassable'/>
<vmethod ret-type='bool' name='isMetalOre'> <int16_t name='matIndex'/> </vmethod>
<vmethod name='clearLastTempUpdateTS'/>
<vmethod name='listNotableKills'> <pointer type-name='stl-string' name='string_ptr'/> <uint32_t name='flag'/></vmethod>
<vmethod ret-type='uint16_t' name='getSpecHeat'/>
<vmethod ret-type='uint16_t' name='getIgnitePoint'/>
-- 40
<vmethod ret-type='uint16_t' name='getHeatdamPoint'/>
<vmethod ret-type='uint16_t' name='getColddamPoint'/>
<vmethod ret-type='uint16_t' name='getBoilingPoint'/>
<vmethod ret-type='uint16_t' name='getMeltingPoint'/>
<vmethod ret-type='uint16_t' name='getFixedTemp'/>
<vmethod ret-type='int32_t' name='getSolidDensity'/>
<vmethod ret-type='bool' name='materialRots'/>
<vmethod ret-type='uint16_t' name='getTemperature'/>
<vmethod ret-type='bool' name='adjustTemperature'>
<uint16_t name='target'/>
<int32_t name='amp'/>
</vmethod>
<vmethod name='evaluate_corpse_flags' comment='initialization for body components'/>
-- 50
<vmethod name='set_placement_information'/>
<vmethod ret-type='int8_t' name='getGloveHandedness'/>
<vmethod name='setGloveHandedness'> <uint32_t name='flag'/> </vmethod>
<vmethod ret-type='bool' name='isSpike'/>
<vmethod ret-type='bool' name='isScrew'/>
<vmethod ret-type='bool' name='isBuildMat'/>
<vmethod ret-type='bool' name='isTemperatureSafe'> <int8_t comment='1 fire, 2 magma'/> </vmethod>
<vmethod name='setRandSubtype'> <int32_t name='entity_id'/> </vmethod>
<vmethod ret-type='int32_t' name='getWeaponSize' comment='weapon racks have capacity 5'/>
<vmethod ret-type='int16_t' name='getWear'/>
- 60
<vmethod name='setWear'> <int16_t/> </vmethod>
<vmethod ret-type='int32_t' name='getMaker'/>
<vmethod name='setMaker'> <int32_t name='hf_id' ref-target='historical_figure'/> </vmethod>
<vmethod name='getCorpseInfo'>
<pointer type-name='int16_t' name='prace'/>
<pointer type-name='int16_t' name='pcaste'/>
<pointer name='phfig'> <pointer type-name='historical_figure'/> </pointer>
<pointer name='punit'> <pointer type-name='unit'/> </pointer>
</vmethod>
<vmethod name='getBodyInfo'> <ret-type><pointer type-name='caste_body_info'/></ret-type> </vmethod>
<vmethod name='getGloveFlags'> <ret-type><pointer><df-flagarray/></pointer></ret-type> </vmethod>
<vmethod name='getItemShapeDesc' comment='a statue/figurine of "string goes here"'>
<ret-type><pointer type-name='stl-string'/></ret-type>
</vmethod>
<vmethod name='get_art_graphics_type_ptr'>
<ret-type><pointer type-name='int32_t'/></ret-type>
</vmethod>
<vmethod name='get_art_graphics_id_ptr'>
<ret-type><pointer type-name='int32_t'/></ret-type>
</vmethod>
<vmethod ret-type='bool' name='isMatchingAmmoItem'> <pointer type-name='squad_ammo_spec'/> </vmethod>
-- 70
<vmethod name='getImageRef'>
<pointer name='id' pointer-type='int32_t'/> pointer-to-ref
<pointer name='subid' pointer-type='int16_t'/>
</vmethod>
<vmethod name='getImageCivSite'>
<pointer type-name='int32_t' name='civ_id' ref-target='historical_entity'/>
<pointer type-name='int32_t' name='site_id' ref-target='world_site'/>
</vmethod>
<vmethod name='setImageCivSite'>
<int32_t name='civ_id' ref-target='historical_entity'/>
<int32_t name='site_id' ref-target='world_site'/>
</vmethod>
<vmethod name='setSeedsPlantSkillLevel'> <int16_t name='level'/> </vmethod>
<vmethod ret-type='int16_t' name='getCorpseSize' comment='size_info.size_cur'/>
<vmethod ret-type='bool' name='ageItem'><int32_t name='amount'/></vmethod>
<vmethod ret-type='int32_t' name='getCritterAirdrownTimer'/>
<vmethod name='setCritterAirdrownTimer'> <int32_t/> </vmethod>
<vmethod name='incrementCritterAirdrownTimer'/>
<vmethod ret-type='int32_t' name='getRotTimer'/>
-- 80
<vmethod name='setRotTimer'> <int32_t name='val'/> </vmethod>
<vmethod name='incrementRotTimer'/>
<vmethod ret-type='bool' name='instantRot'/>
<vmethod ret-type='bool' name='fitsCivRequestTab'>
<enum base-type='int16_t' type-name='entity_sell_category' name='civ_request_tab'/>
</vmethod>
<vmethod name='getAmmoType'>
<ret-type><pointer type-name='stl-string'/></ret-type>
<pointer type-name='stl-string'/>
</vmethod>
<vmethod ret-type='bool' name='isLiquidPowder'/>
<vmethod ret-type='bool' name='isLiquid'/>
<vmethod ret-type='bool' name='isLiveAnimal' comment='vermin, pet, or critter'/>
<vmethod ret-type='int32_t' name='getVolume' comment='for putting in containers, building clutter'/>
<vmethod name='addImprovementFromJob'>
<ret-type><pointer type-name='itemimprovement'/></ret-type>
<enum type-name='improvement_type' name='imp_type'/>
<pointer type-name='job' name='job'/>
<pointer type-name='unit' name='unit'/>
<int16_t name='mat_type'/>
<int32_t name='mat_index'/>
<int32_t name='shape' ref-target='descriptor_shape'/>
<int32_t name='force_quality'/>
<pointer type-name='historical_entity' name='civ'/>
<pointer type-name='world_site' name='site'/>
<enum type-name='trade_good_purpose' name='tradegoodpurpose'/>
<bool name='suppress_shaping'/>
<bool name='use_roll'/>
<int32_t name='roll'/>
</vmethod>
-- 90
<vmethod ret-type='bool' name='isWeapon' comment='rackitem, goes in weapon racks'/>
<vmethod ret-type='bool' name='isArmorNotClothing' comment='standitem, goes in armor stands'/>
<vmethod ret-type='bool' name='isMillable'/>
<vmethod ret-type='bool' name='isProcessableThread'/>
<vmethod ret-type='bool' name='isProcessableVial'/>
<vmethod ret-type='bool' name='isProcessableBarrel'/>
<vmethod ret-type='bool' name='isEdiblePlant'/>
<vmethod ret-type='bool' name='isEdibleRaw'> <int32_t name='hunger'/> </vmethod>
<vmethod ret-type='bool' name='isEdibleCarnivore'> <int32_t name='hunger'/> </vmethod>
<vmethod ret-type='bool' name='isEdibleBonecarn'> <int32_t name='hunger'/> </vmethod>
-- 100
<vmethod ret-type='bool' name='moveToGround'>
<int32_t name='x'/> <int32_t name='y'/> <int32_t name='z'/>
</vmethod>
<vmethod name='categorize' comment='Add item to world.items.other.*'> <bool name='in_play'/> </vmethod>
<vmethod name='uncategorize' comment='Remove item from world.items.other.*'/>
<vmethod ret-type='bool' name='isFurniture'> <bool name='empty'/> </vmethod>
<vmethod ret-type='bool' name='isPressed'/>
<vmethod ret-type='bool' name='isAnimal' comment='stored in Animal stockpiles'/>
<vmethod ret-type='item_quality' name='assignQuality'>
<pointer name='maker' type-name='unit'/>
<enum base-type='int16_t' name='job_skill' type-name='job_skill'/>
</vmethod>
<vmethod ret-type='item_quality' name='assignQualityRoll'>
<pointer name='maker' type-name='unit'/>
<enum base-type='int16_t' name='job_skill' type-name='job_skill'/>
<int32_t name='skill_roll' comment='preferences add 10 to this, need 55 to roll masterworks'/>
</vmethod>
<vmethod name='notifyCreatedMasterwork'>
<pointer name='maker' type-name='unit'/>
</vmethod>
<vmethod name='notifyLostMasterwork'/>
-- 110
<vmethod name='setDisplayColor'><int16_t name='bg'/></vmethod>
<vmethod ret-type='bool' name='isDamagedByHeat'/>
<vmethod ret-type='bool' name='needTwoHandedWield'> <int32_t/> </vmethod>
<vmethod name='splitStack'>
<ret-type><pointer type-name='item'/></ret-type>
<int32_t name='stack_size'/>
<bool name='preserve_containment'/>
</vmethod>
<vmethod ret-type='bool' name='isTameableVermin'/>
-- 120
<vmethod ret-type='bool' name='isDye'/>
<vmethod ret-type='bool' name='isMilkable'><bool name='container_allowed'/><bool name='checkres'/></vmethod>
<vmethod ret-type='bool' name='isSandBearing'/>
<vmethod ret-type='bool' name='isLyeBearing'/>
<vmethod ret-type='bool' name='isAnimalProduct'/>
<vmethod name='getStorageInfo'>
<pointer type-name='item_type' name='item_type'/>
<pointer name='material_category'><enum type-name='entity_material_category'/></pointer> codegen workaround, enum forward declaration was missing the base-type
</vmethod>
<vmethod ret-type='bool' name='addWear'>
<int32_t name='delta'/> <bool name='lose_masterwork'/> <bool name='persist_parts'/>
</vmethod>
<vmethod ret-type='bool' name='incWearTimer'> <int32_t name='delta'/> </vmethod>
<vmethod ret-type='bool' name='checkWearDestroy'>
<bool name='lose_masterwork'/> <bool name='persist_parts'/>
</vmethod>
<vmethod name='addContaminant'>
<int16_t name='mat_type'/> <int32_t name='mat_index'/>
<enum type-name='matter_state' base-type='int16_t' name='mat_state'/>
<uint16_t name='temp'/> <int32_t name='size'/>
<int16_t name='body_part_id'/> <uint16_t name='flags'/>
</vmethod>
-- 130
<vmethod name='removeContaminantByIdx'>
<int32_t name='index'/> <int32_t name='amount'/>
</vmethod>
<vmethod name='removeContaminant'>
<int16_t name='mat_type'/> <int32_t name='mat_index'/>
<int32_t name='amount'/>
</vmethod>
<vmethod name='tradeUnitContaminants'>
<pointer type-name='unit'/> <int16_t name='body_part_id'/>
</vmethod>
<vmethod name='tradeItemContaminants' comment='calls item.tIC2(this)'>
<pointer type-name='item'/>
</vmethod>
<vmethod name='tradeItemActualContaminants'>
<pointer type-name='item_actual'/>
</vmethod>
<vmethod name='contaminateWound'>
<pointer type-name='unit'/> <pointer type-name='unit_wound'/>
<int32_t name='shift'/> <int16_t name='body_part_id'/>
</vmethod>
<vmethod name='write_file'> <pointer name='file' type-name='file_compressorst'/> </vmethod>
<vmethod name='read_file'>
<pointer name='file' type-name='file_compressorst'/>
<enum name='loadversion' type-name='save_version'/>
</vmethod>
<vmethod name='getWeaponAttacks'>
<ret-type><pointer><stl-vector pointer-type='weapon_attack'/></pointer></ret-type>
</vmethod>
<vmethod ret-type='bool' name='isNotHeld' comment='exitable - allowed to leave the map?'/>
-- 140
<vmethod ret-type='bool' name='isActual'/>
<vmethod name='addDefaultThreadImprovement'><pointer type-name='historical_entity' comment='add default thread improvement to items made of cloth'/></vmethod>
<vmethod name='addThreadImprovement'><pointer type-name='item'/><pointer type-name='historical_entity' comment='add a specific thread improvement to items made of cloth'/></vmethod>
<vmethod name='propagateUnitRefs'/> add to unit.owned_items/traded_items
<vmethod ret-type='bool' name='isSand'/>
<vmethod ret-type='int32_t' name='get_production_zone_id' />
<vmethod ret-type='int32_t' name='getStackSize'/>
<vmethod name='addStackSize'> <int32_t name='amount'/> </vmethod>
<vmethod name='setStackSize'> <int32_t name='amount'/> </vmethod>
<vmethod ret-type='bool' name='isAmmoClass'> <pointer type-name='stl-string'/> </vmethod>
-- 150
<vmethod ret-type='bool' name='isAutoClean'
comment='delete on_ground every season when in ANY_AUTO_CLEAN; default true'/>
<vmethod name='setTemperatureFromMapTile'>
<int16_t name='x'/> <int16_t name='y'/> <int16_t name='z'/>
<bool name='local'/> <bool name='contained'/>
</vmethod>
<vmethod name='setTemperatureFromMap'>
<bool name='local'/> <bool name='contained'/>
</vmethod>
<vmethod name='setTemperature'>
<uint16_t name='temp'/> <bool name='local'/> <bool name='contained'/>
</vmethod>
<vmethod ret-type='bool' name='updateTempFromMap'>
<bool name='local'/> <bool name='contained'/> <bool name='adjust'/>
<int32_t name='multiplier'/>
</vmethod>
<vmethod ret-type='bool' name='updateTemperature'>
<uint16_t name='temp'/> <bool name='local'/>
<bool name='contained'/> <bool name='adjust'/>
<int32_t name='multiplier'/>
</vmethod>
<vmethod ret-type='bool' name='updateFromWeather'/>
<vmethod ret-type='bool' name='updateContaminants'>
<int16_t name='x'/> <int16_t name='y'/> <int16_t name='z'/>
</vmethod>
<vmethod ret-type='bool' name='checkTemperatureDamage'/>
<vmethod ret-type='bool' name='checkHeatColdDamage'/>
-- 160
<vmethod ret-type='bool' name='checkMeltBoil'/>
<vmethod ret-type='job_skill' name='getMeleeSkill'/>
<vmethod ret-type='job_skill' name='getRangedSkill'/>
<vmethod name='setQuality'> <int16_t name='quality'/> </vmethod>
<vmethod ret-type='int16_t' name='getQuality'/>
<vmethod ret-type='int16_t' name='getOverallQuality'/>
<vmethod ret-type='int16_t' name='getImprovementQuality'/>
<vmethod ret-type='int16_t' name='getProjectileSize'/>
<vmethod ret-type='bool' name='isImprovable'>
<pointer type-name='job'/>
<int16_t name='mat_type'/> <int32_t name='mat_index'/>
</vmethod>
<vmethod name='setSharpness'>
<int16_t name='item_quality'/>
<bool name='force_edge'/>
</vmethod>
-- 170
<vmethod ret-type='int32_t' name='getSharpness'/>
<vmethod ret-type='bool' name='isTotemable'/>
<vmethod ret-type='bool' name='isDyeable'/>
<vmethod ret-type='bool' name='isNotDyed' comment='dyeable_after_fact'/>
<vmethod ret-type='bool' name='isDyed'/>
<vmethod ret-type='bool' name='canSewImage'/>
<vmethod ret-type='bool' name='canHaveImageSewnOnto'/>
<vmethod ret-type='bool' name='isProcessableVialAtStill'/>
<vmethod ret-type='bool' name='isSimilarToItem'>
<enum base-type='int16_t' name='item_type' type-name='item_type'/>
<int16_t name='item_subtype'/>
<int16_t name='mat_type'/>
<int16_t name='mat_index'/> actually int16 here
</vmethod>
<vmethod ret-type='int32_t' name='getBlockChance'/>
-- 180
<vmethod ret-type='int32_t' name='getParryChance'/>
<vmethod ret-type='int16_t' name='getMakerRace'/>
<vmethod name='setMakerRace'> <int16_t/> </vmethod>
<vmethod ret-type='int8_t' name='getEffectiveArmorLevel'
comment="adds 1 if it has [METAL_ARMOR_LEVELS] and it's made of an inorganic mat"/>
<vmethod ret-type='bool' name='isConstructed'/>
<vmethod ret-type='bool' name='wantsThreadImprovement'/> only for item_cloth
<vmethod ret-type='bool' name='wantsClothImprovement'/> for all constructed items
<vmethod name='coverWithContaminant' comment='also stops fire; used for rain'>
<int16_t name='mat_type'/> <int32_t name='mat_index'/>
<enum type-name='matter_state' base-type='int16_t' name='mat_state'/>
<uint16_t name='temperature'/>
</vmethod>
<vmethod ret-type='bool' name='hasSpecificImprovements'>
<enum type-name='improvement_type' name='imp_type'/>
</vmethod>
<vmethod ret-type='bool' name='hasImprovements'/> any at all
-- 190
<vmethod ret-type='bool' name='isImproved'/>
<vmethod name='getMagic'>
<ret-type><pointer type-name='item_magicalst'/></ret-type>
</vmethod>
<vmethod name='getItemDescription'>
<pointer type-name='stl-string'/>
<int8_t name='plurality' comment="0 = prickle berries [2], 1 = prickle berry, 2 = prickle berries"/>
</vmethod>
<vmethod name='getItemDescriptionPrefix' comment='"a " or "the "'>
<pointer type-name='stl-string'/>
<enum name='mode' type-name='article_type'/>
</vmethod>
<vmethod name='getItemBasicName' comment='usually just "item"'>
<pointer type-name='stl-string'/>
</vmethod>
<vmethod ret-type='int32_t' name='getImprovementsValue'> <pointer type-name='caravan_state' name='caravan'/> </vmethod>
<vmethod ret-type='bool' name='isExtractBearingFish'/>
<vmethod ret-type='bool' name='isExtractBearingVermin'/>
<vmethod ret-type='int32_t' name='getMaterialSizeForMelting' comment='for armor, clothing, weapons, and tools, returns material size from the corresponding itemdef'/>
<vmethod ret-type='int32_t' name='getBaseWeight'/>
-- 200
<vmethod ret-type='int32_t' name='getWeightShiftBits'/>
<vmethod ret-type='bool' name='isCollected' comment='is_bin_item'/>
<vmethod ret-type='bool' name='isEdibleVermin'/>
<vmethod ret-type='uint8_t' name='drawSelf'/>
<vmethod ret-type='bool' name='isRangedWeapon'/>
<vmethod ret-type='bool' name='isClothing' comment='cabinetitem'/>
<vmethod ret-type='bool' name='isWet'/>
<vmethod ret-type='int32_t' name='getCurrencyValue' comment='that is, value of coins'>
<pointer type-name='historical_entity' name='appraiser'/>
</vmethod>
<vmethod ret-type='bool' name='isAssignedToStockpile'/>
<vmethod ret-type='bool' name='isAssignedToThisStockpile'> <int32_t/> </vmethod>
-- 210
<vmethod name='detachStockpileAssignment' comment='also removes links from the pile'/>
<vmethod name='removeStockpileAssignment' comment='just wipes the fields'/>
<vmethod name='getStockpile2'>
<ret-type><pointer type-name='item_stockpile_ref'/></ret-type>
</vmethod>
<vmethod name='randomizeThreadImprovement' comment='this updates the quality of a thread improvement already added to the item (or adjusts the quality of a thread item) based on the skill of the dyer'>
<int16_t name='mat_type'/>
<int32_t name='mat_index'/>
<pointer name='u' type-name='unit'/>
<pointer name='j' type-name='job'/>
</vmethod>
<vmethod name='addImprovement' comment='use_image'>
<int32_t name='art_chunk_id'/>
<int16_t name='art_chunk_offse'/>
<int32_t name='art_civ'/>
<int32_t name='art_site'/>
<int16_t name='material'/>
<int32_t name='matgloss'/>
<int16_t name='dye_material'/>
<int32_t name='dye_matgloss'/>
<pointer name='item' type-name='item'/>
<int8_t name='quality'/>
<int16_t name='skill_level'/>
<int32_t name='artist_hf'/>
</vmethod>
<vmethod name='copyImprovementsFrom'><pointer type-name='item'/></vmethod>
<vmethod ret-type='int32_t' name='getThreadDyeValue'> <pointer type-name='caravan_state' name='caravan'/> </vmethod>
<vmethod name='getColorAndShape'>
<pointer name='colors'><stl-vector type-name='int16_t'/></pointer>