dfhack/library/xml/df.ui.xml

<data-definition>
    <struct-type type-name='dipscript_info' key-field='code'>
        <int32_t name='unk1' comment='uninit'/>
        <stl-string name='script_file' comment='data/dipscript/dwarf_liaison'/>
        <stl-vector name='script_steps' type-name='pointer'/>
        <stl-vector name='unknown' comment='null'/>
        <stl-string name='code' comment='DWARF_LIAISON etc'/>
    </struct-type>

    <struct-type type-name='burrow' key-field='id' instance-vector='$global.ui.burrows.list'>
        <int32_t name='id'/>
        <stl-string name='name'/>

        <code-helper name='describe'>
            (describe-obj $.name)
        </code-helper>

        <uint8_t name='tile'/>
        <int16_t name='fg_color'/>
        <int16_t name='bg_color'/>
        <stl-vector name='unk1' type-name='int32_t'/>
        <stl-vector name='unk2' type-name='int32_t'/>
        <stl-vector name='unk3' type-name='int32_t'/>
        <stl-vector name='units'>
            <int32_t ref-target='unit'/>
        </stl-vector>
    </struct-type>

    <enum-type type-name='ui_sidebar_mode'>
        <enum-item name='Default'/>
        <enum-item name='Squads'/>

        -- 2

        <enum-item name='DesignateMine'/>
        <enum-item name='DesignateRemoveRamps'/>
        <enum-item name='DesignateUpStair'/>
        <enum-item name='DesignateDownStair'/>
        <enum-item name='DesignateUpDownStair'/>
        <enum-item name='DesignateUpRamp'/>
        <enum-item name='DesignateChannel'/>
        <enum-item name='DesignateGatherPlants'/>
        <enum-item name='DesignateRemoveDesignation'/>
        <enum-item name='DesignateSmooth'/>
        <enum-item name='DesignateEngrave'/>
        <enum-item name='DesignateCarveFortification'/>

        -- 14

        <enum-item name='Stockpiles'/>
        <enum-item name='Build'/>
        <enum-item name='QueryBuilding'/>

        -- 17

        <enum-item name='Orders'/>
        <enum-item name='OrdersForbid'/>
        <enum-item name='OrdersRefuse'/>
        <enum-item name='OrdersWorkshop'/>
        <enum-item name='OrdersZone'/>

        -- 22

        <enum-item name='BuildingItems'/>
        <enum-item name='ViewUnits'/>
        <enum-item name='LookAround'/>

        -- 25

        <enum-item name='DesignateItemsClaim'/>
        <enum-item name='DesignateItemsForbid'/>
        <enum-item name='DesignateItemsMelt'/>
        <enum-item name='DesignateItemsUnmelt'/>
        <enum-item name='DesignateItemsDump'/>
        <enum-item name='DesignateItemsUndump'/>
        <enum-item name='DesignateItemsHide'/>
        <enum-item name='DesignateItemsUnhide'/>

        -- 33

        <enum-item name='DesignateChopTrees'/>
        <enum-item name='DesignateToggleEngravings'/>

        -- 35

        <enum-item name='Hotkeys'/>

        -- 36

        <enum-item name='DesignateTrafficHigh'/>
        <enum-item name='DesignateTrafficNormal'/>
        <enum-item name='DesignateTrafficLow'/>
        <enum-item name='DesignateTrafficRestricted'/>

        -- 40

        <enum-item name='Zones'/>
        <enum-item name='ZonesPenInfo'/>
        <enum-item name='ZonesPitInfo'/>
        <enum-item name='ZonesHospitalInfo'/>

        -- 44

        <enum-item name='DesignateRemoveConstruction'/>

        <enum-item name='DepotAccess'/>
        <enum-item name='NotesPoints'/>
        <enum-item name='NotesRoutes'/>
        <enum-item name='Burrows'/>
    </enum-type>

    <struct-type type-name='cursor'>
        <int32_t name='x'/>
        <int32_t name='y'/>
        <int32_t name='z'/>
    </struct-type>

    <struct-type type-name='selection_rect'>
        <int32_t name='start_x'/>
        <int32_t name='start_y'/>
        <int32_t name='start_z'/>
        <int32_t name='end_x'
                 comment='only valid for an instant while its being completed'/>
        <int32_t name='end_y'/>
        <int32_t name='end_z'/>
    </struct-type>

    <struct-type type-name='ui'>
        ctor 86e33c0 x
        dtor 8534190

        <padding size='16'/>
        <stl-vector name='unk10'/>
        <padding size='76'/>
        <stl-vector name='unk68' type-name='pointer'/>
        <padding size='388'/>
        <stl-vector name='currency_value' type-name='int32_t'
                    index-refers-to='(material-by-id 0 $)'/>
        <padding size='812'/>
        <stl-vector name='unk530' type-name='int32_t'/>
        <padding size='7516'/>
        <stl-vector name='unk2298' type-name='bool'
                    index-refers-to='(find-creature $)'/>
        <stl-vector name='unk22a4' type-name='bool'
                    index-refers-to='(find-creature $)'/>
        <stl-vector name='unk22b0' type-name='bool'
                    index-refers-to='(find-plant-raw $)'/>
        <stl-vector name='unk22bc' type-name='bool'
                    index-refers-to='(find-plant-raw $)'/>
        <padding size='16'/>
        <stl-vector name='unk22d8' type-name='int32_t'/>
        <padding size='4'/>
        <stl-vector name='unk22e8'/>

        <stl-vector name='dip_meeting_vec'>
            <pointer type-name='meeting_diplomat'/>
        </stl-vector>

        <stl-vector name='dip_meeting_info'>
            <pointer>
                <int32_t name='civ_id' ref-target='historical_entity'/>
                <int16_t name='unk1'/>
                <int32_t name='diplomat_id' ref-target='historical_figure'/>
                <int32_t name='unk2' comment='-1'/>
                <padding size='32' comment='0'/>
                <pointer name='dipscript' type-name='dipscript_info'/>
                <padding size='16' comment='0'/>
                <stl-string name='unk3'/>
                <stl-string name='unk4'/>
                <padding size='112' comment='0'/>
            </pointer>
        </stl-vector>

        <stl-vector name='unk230c' comment='really a wild guess'>
            <int32_t ref-target='unit'/>
        </stl-vector>

        <padding size='4'/>

        <stl-vector name='invasions' comment='goblins...'>
            <pointer>
                <int32_t name='id'/>
                <int32_t name='civ_id' ref-target='historical_entity'/>
                <int32_t name='is_active1' comment='0 unless active'/>
                <int32_t name='is_active2'/>
                <int32_t name='size' comment='just a guess'/>
                <int32_t name='duration_counter'/>
                <int16_t name='unk4a'/>
                <int16_t name='unk4b'/>
            </pointer>
        </stl-vector>
        <int32_t name='next_invasion_id'/>

        <stl-vector name='crimes'>
            <pointer>
                <enum name='mode' base-type='int16_t'>
                    <enum-item name='ProductionOrderViolation'/>
                    <enum-item name='ExportViolation'/>
                    <enum-item name='JobOrderViolation'/>
                    <enum-item name='ConspiracyToSlowLabor'/>
                    <enum-item name='Murder'/>
                    <enum-item name='DisorderlyBehavior'/>
                    <enum-item name='BuildingDestruction'/>
                    <enum-item name='Vandalism'/>
                </enum>
                <int16_t name='unk2' comment='uninit'/>

                <int16_t name='unk3'/>
                <int16_t name='unk4'/>
                <int32_t name='unk5'/>

                <pointer name='criminal' type-name='unit'/>
                <pointer name='victim' type-name='unit'/>
                <int32_t name='punishment_assigned'/>
            </pointer>
        </stl-vector>

        <stl-vector name='punishments'>
            <pointer>
                <pointer name="criminal" type-name='unit'/>
                <pointer name="officer" type-name='unit'/>
                <int16_t name="beating"/>
                <int16_t name="hammer_strikes"/>
                <int32_t name="prison_counter"/>
                <int16_t name="unk_10" comment='10080'/>
                <pointer name="chain" type-name='building'/>
                <stl-vector name="victims">
                    <pointer type-name="unit"/>
                </stl-vector>
            </pointer>
        </stl-vector>

        <stl-vector name='pet_meeting_vec'>
            <pointer type-name='meeting_pet'/>
        </stl-vector>

        <stl-vector name='unk2350' type-name='pointer'/>
        <stl-vector name='unk235c' type-name='pointer'/>

        <stl-vector name='dipscripts'>
            <pointer type-name='dipscript_info'/>
        </stl-vector>

        <stl-vector name='unk2374' type-name='pointer'/>

        <compound name='kitchen'>
            <stl-vector name='item_types' type-name='int16_t'/>
            <stl-vector name='item_subtypes' type-name='int16_t'/>
            <stl-vector name='mat_types'>
                <int16_t ref-target='material' aux-value='$$._parent.mat_indices[$._key]'/>
            </stl-vector>
            <stl-vector name='mat_indices' type-name='int32_t'/>
            <stl-vector name='exc_types' type-name='int8_t'/>
        </compound>

        <stl-vector name='economic_stone' type-name='bool'
                    index-refers-to='(material-by-id 0 $)'/>

        <padding size='4'/>
        <int16_t name='unk23cc'/>
        <int16_t name='unk23ce'/>
        <int32_t name='unk23d0'/>
        <int32_t name='unk23d4'/>

        <int32_t name='group_id' ref-target='historical_entity'/>
        <int32_t name='race_id' ref-target='creature_raw'/>

        <stl-vector name='unk23e0' type-name='int16_t'/>
        <stl-vector name='unk23ec' type-name='int8_t'/>

        <static-array name='unk23f8' count='2'>
            <static-array count='30'>
                <stl-vector type-name='int32_t'/>
            </static-array>
        </static-array>

        <compound name='stockpile'>
            <int32_t name='reserved_bins'/>
            <int32_t name='reserved_barrels'/>

            <compound name='custom_settings' type-name='stockpile_settings'/>
        </compound>

        <static-array name='unk2a8c' count='4'>
            <static-array count='768'>
                <int16_t name='unk1'/>
                <int16_t name='unk2'/>
            </static-array>
        </static-array>

        <stl-vector name='unk5a8c' type-name='int16_t'/>
        <stl-vector name='unk5a98' type-name='int16_t'/>
        <stl-vector name='unk5aa4' type-name='int16_t'/>

        <static-array name='unk5ab0' count='5'>
            <stl-vector type-name='int16_t'/>
        </static-array>

        <stl-vector name='unk5aec' type-name='int16_t'/>

        <static-array name='unk5af8' count='5'>
            <stl-vector type-name='int16_t'/>
        </static-array>

        <stl-vector name='unk5b34' type-name='int16_t'/>

        <static-array name='unk5b40' count='5'>
            <stl-vector type-name='int16_t'/>
        </static-array>

        <stl-vector name='unk5b7c' type-name='int16_t'/>

        <static-array name='unk5b88' count='7'>
            <stl-vector/>
        </static-array>

        <compound name='waypoints'>
            <stl-vector name='points'>
                <pointer key-field='name'>
                    <int32_t name='id'/>
                    <uint8_t name='tile'/>
                    <int16_t name='fg_color'/>
                    <int16_t name='bg_color'/>
                    <stl-string name='name'/>
                    <stl-string name='comment'/>
                    <int16_t name='x'/>
                    <int16_t name='y'/>
                    <int16_t name='z'/>
                </pointer>
            </stl-vector>
            <stl-vector name='routes'>
                <pointer key-field='name'>
                    <int32_t name='id'/>
                    <stl-string name='name'/>
                    <stl-vector name='points'>
                        <int32_t/>
                    </stl-vector>
                </pointer>
            </stl-vector>
            <int16_t name='sym_selector'/>
            <int16_t/>
            <int32_t name='cur_point_index'/>
            <bool name='in_edit_name_mode'/>
            <int8_t/>
            <uint8_t name='sym_tile'/>
            <int16_t name='sym_fg_color'/>
            <int16_t name='sym_bg_color'/>
            <stl-vector name='unk5c04'>
                <pointer type-name='stl-string'/>
            </stl-vector>
            <int32_t name='next_point_id'/>
            <int32_t name='next_route_id'/>
            <int32_t name='sel_route_idx'/>
            <int32_t name='sel_route_waypt_idx'/>
            <bool name='in_edit_waypts_mode'/>
        </compound>

        <compound name='burrows'>
            <stl-vector name='list'>
                <pointer type-name='burrow'/>
            </stl-vector>
            <int32_t name='next_id'/>
            <int32_t name='sel_index1'/>
            <int32_t name='sel_index2'/>
            <bool name='in_add_units_mode'/>
            <stl-vector name='list_units'>
                <pointer type-name='unit'/>
            </stl-vector>
            <stl-bit-vector name='sel_units' index-refers-to='$$._parent.list_units[$]'/>
            <int32_t name='unit_cursor_pos'/>
            <bool name='in_define_mode'/>
            <int16_t name='rect_start_x'/>
            <int16_t name='rect_start_y'/>
            <int16_t name='rect_start_z'/>
            <int32_t name='brush_mode'/>
            <int16_t name='sym_selector'/>
            <int16_t name='sym_tile'/>
            <int16_t name='sym_fg_color'/>
            <int16_t name='sym_bg_color'/>
        </compound>

        <compound name='alerts'>
            <stl-vector name='list'>
                <pointer key-field='name'>
                    <int32_t name='id'/>
                    <stl-string name='name'/>
                    <stl-vector/>
                </pointer>
            </stl-vector>
            <int32_t name='next_id'/>
            <int32_t name='civ_alert_idx' refers-to='$$._parent.list[$]'/>
        </compound>

        <compound name='equipment'>
            <static-array name='items_by_type1' count='112' index-enum='item_type'>
                <stl-vector>
                    <pointer type-name='item'/>
                </stl-vector>
            </static-array>

            <static-array name='items_unassigned' count='112' index-enum='item_type'>
                <stl-vector>
                    <pointer type-name='item'/>
                </stl-vector>
            </static-array>
            <static-array name='items_assigned' count='112' index-enum='item_type'>
                <stl-vector>
                    <pointer type-name='item'/>
                </stl-vector>
            </static-array>

            <int32_t name='unk6c4c'/>

            <stl-vector name='work_weapons' comment='i.e. woodcutter axes, and miner picks'>
                <int32_t ref-target='item'/>
            </stl-vector>
            <stl-vector name='work_units'>
                <int32_t ref-target='unit'/>
            </stl-vector>

            <stl-vector name='hunter_ammunition'>
                <pointer type-name='squad_ammo_spec'/>
            </stl-vector>
            <stl-vector name='ammo_items'>
                <int32_t ref-target='item'/>
            </stl-vector>
            <stl-vector name='ammo_units'>
                <int32_t ref-target='unit'/>
            </stl-vector>
        </compound>

        <compound name='main'>
            <static-array name='hotkeys' count='16'>
                <stl-string name='name'/>
                <int16_t name='cmd'/>
                <int32_t name='x'/>
                <int32_t name='y'/>
                <int32_t name='z'/>
            </static-array>

            <int32_t name='traffic_cost_high'/>
            <int32_t name='traffic_cost_normal'/>
            <int32_t name='traffic_cost_low'/>
            <int32_t name='traffic_cost_restricted'/>

            <stl-vector name='unk6ddc'>
                <pointer>
                    <int32_t name='unk1'/>
                    <int32_t name='unk2'/>
                    <int32_t name='unk3'/>
                    <int32_t name='unk4'/>
                    <int32_t name='unk5'/>
                    <int16_t name='unk6'/>
                    <int32_t name='unk7'/>
                </pointer>
            </stl-vector>

            <pointer name='unk6de8' type-name='historical_entity'/>

            <enum base-type='int32_t' name='mode' type-name='ui_sidebar_mode'/>

            <int32_t name='selected_traffic_cost'
                     comment='For changing the above costs.'/>

            <int32_t name='unk6df4'/>

            <int16_t name='selected_hotkey'/>
            <bool name='in_rename_hotkey'/>
        </compound>

        <compound name='squads'>
            <stl-vector name='list' has-bad-pointers='true'
                        comment='valid only when ui is displayed'>
                <pointer type-name='squad'/>
            </stl-vector>

            <stl-vector name='unk6e08'/>

            <stl-bit-vector name='sel_squads' index-refers-to='$$._parent.list[$]'/>

            <stl-vector name='indiv_selected'>
                <int32_t ref-target='historical_figure'/>
            </stl-vector>
            <bool name='in_select_indiv'/>
            <int32_t name='sel_indiv_squad' refers-to='$$._parent.list[$]'/>

            <padding size='8'/>

            <int32_t name='unk48'/>
            <pointer name='unk4c' type-name='squad'/>

            <bool name='in_move_order'/>
            <int32_t name='point_list_scroll'/>

            <bool name='in_kill_order'/>

            <stl-vector name='kill_rect_targets'>
                <pointer type-name='unit'/>
            </stl-vector>

            <padding size='4'/>

            <bool name='in_kill_list'/>
            <stl-vector name='kill_targets'>
                <pointer type-name='unit'/>
            </stl-vector>
            <stl-bit-vector name='sel_kill_targets' index-refers-to='$$._parent.kill_target[$]'/>
            <padding size='4'/>

            <bool name='in_kill_rect'/>
            <int16_t name='rect_start_x'/>
            <int16_t name='rect_start_y'/>
            <int16_t name='rect_start_z'/>
        </compound>

        <padding size='4'/>
    </struct-type>

    <struct-type type-name='build_item_selector'>
        <stl-vector name='requirement'>
            <pointer>
                <enum base-type='int16_t' name="item_type" type-name='item_type'/>
                <int16_t name="unk_2"/>
                <int16_t name="unk_4"/>
                <int32_t name="unk_8"/>
                <int32_t name="unk_c"/>
                <pointer name="item_vector">
                    <stl-vector>
                        <pointer type-name='item'/>
                    </stl-vector>
                </pointer>
                <int8_t name="unk_14"/>
                <int32_t name="unk_18"/>
                <int8_t name="unk_1c"/>
                <int32_t name="unk_20"/>
                <int8_t name="unk_24"/>
                <int32_t name="unk_28"/>
                <int8_t name="unk_2c"/>
                <int32_t name="unk_30"/>
                <int8_t name="unk_34"/>
                <stl-string name='unk38'/>
                <stl-string name='unk3c'/>
                <int32_t name="unk_40"/>
                <int16_t name="unk_44"/>
                <int8_t name="unk_46"/>
                <int32_t name="unk_48"/>
                <int32_t name="unk_4c"/>
                <stl-vector name='unk50'/>
                <int8_t name="unk_5c"/>
                <int16_t name="unk_5e"/>
                <int16_t name="unk_60"/>
                <int16_t name="unk_62"/>
                <int16_t name="unk_64"/>
                <int32_t name="unk_68"/>
                <int32_t name="unk_6c"/>
                <int32_t name="unk_70"/>
                <int32_t name="unk_74"/>
                <stl-vector name='unk78'/>
                <int8_t name="unk_84"/>
                <stl-vector name='candidates'>
                    <pointer type-name='item'/>
                </stl-vector>
                <stl-vector name='unk_94' type-name='int8_t'/>
                <stl-vector name='unk_a0' type-name='int16_t'/>
                <stl-vector name='unk_ac' type-name='int8_t'/>
                <int32_t name="unk_b8"/>
                <int16_t name="unk_bc"/>
            </pointer>
        </stl-vector>

        <stl-vector name='choices' type-name='pointer'/>

        <int32_t name="unk_18"/>
        <int16_t name="unk_1c"/>
        <int16_t name="unk_1e"/>
        <int32_t name="unk_20"/>
        <int32_t name="unk_24"/>
        <int16_t name="unk_28"/>
        <int16_t name="sel_index"/>
        <int32_t name="unk_2c"/>

        <stl-vector name='unk3'>
            <pointer type-name='stl-string'/>
        </stl-vector>
        <stl-vector name='unk4'>
            <pointer type-name='stl-string'/>
        </stl-vector>
        <padding size='3848'/>
        <int32_t name='unk5_1'/>
        <int32_t name='unk5_2'/>
        <int8_t name='unk5_3a'/>
        <int8_t name='unk5_3b'/>
        <int8_t name='unk5_3c'/>
        <int8_t name='unk5_3d'/>
        <int32_t name='unk5_4'/>
        <stl-vector name='unk6'/>
        <stl-vector name='unk7'/>
        dtor: 0x85272c0
    </struct-type>
</data-definition>

<!--
Local Variables:
indent-tabs-mode: nil
nxml-child-indent: 4
End:
-->