df.globals.xml

<data-definition>
    <enum-type type-name='weather_type' base-type='int8_t'>
        <enum-item name='None'/>
        <enum-item name='Rain'/>
        <enum-item name='Snow'/>
    </enum-type>

    <enum-type type-name='next_global_id'>
        <comment>
            The storage order of "next ID" fields in the save file.
            Followed by game type. The enum item name is the part between
            next_ and _global_id in the Dwarf Fortress global variable table.
        </comment>
        <enum-item name='unit'/>
        <enum-item name='soul'/>
        <enum-item name='item'/>
        <enum-item name='civ'/>
        <enum-item name='nem'/>
        <enum-item name='artifact'/>
        <enum-item name='job'/>
        <enum-item name='schedule'/>
        <enum-item name='proj'/>
        <enum-item name='building'/>
        <enum-item name='machine'/>
        <enum-item name='flow_guide'/>
        <enum-item name='histfig'/>
        <enum-item name='histevent'/>
        <enum-item name='histeventcol'/>
        <enum-item name='unitchunk'/>
        <enum-item name='imagechunk'/>
        <enum-item name='task'/>
        <enum-item name='squad'/>
        <enum-item name='formation'/>
        <enum-item name='activity'/>
        <enum-item name='interaction_instance'/>
        <enum-item name='written_content'/>
        <enum-item name='identity'/>
        <enum-item name='incident'/>
        <enum-item name='crime'/>
        <enum-item name='vehicle'/>
        <enum-item name='army'/>
        <enum-item name='army_controller'/>
        <enum-item name='army_tracking_info'/>
        <enum-item name='cultural_identity'/>
        <enum-item name='agreement'/>
        <enum-item name='poetic_form'/>
        <enum-item name='musical_form'/>
        <enum-item name='dance_form'/>
        <enum-item name='scale'/>
        <enum-item name='rhythm'/>
        <enum-item name='occupation'/>
        <enum-item name='belief_system'/>
        <enum-item name='image_set'/>
        <enum-item name='divination_set'/>
    </enum-type>

    -- .data

    <!-- Cursor: to find, look in the non-bss .data segment -->
    <global-object name='cursor'>
        <int32_t name='x'/>
        <int32_t name='y'/>
        <int32_t name='z'/>
    </global-object>

    <!-- Designation selection rect: to find, look just after cursor for six -30000 values. -->
    <global-object 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'/>
    </global-object>

    <enum-type type-name='game_mode'>
        <enum-item name='DWARF'/>
        <enum-item name='ADVENTURE'/>
        <enum-item name='num'/>
        <enum-item name='NONE'/>
    </enum-type>

    <enum-type type-name='game_type'>
        <enum-item name='DWARF_MAIN'/>
        <enum-item name='ADVENTURE_MAIN'/>
        <enum-item name='VIEW_LEGENDS'/>
        <enum-item name='DWARF_RECLAIM'/>
        <enum-item name='DWARF_ARENA'/>
        <enum-item name='ADVENTURE_ARENA'/>
        <enum-item name='ADVENTURE_DUNGEON'/>
        <enum-item name='DWARF_TUTORIAL'/>
        <enum-item name='DWARF_UNRETIRE'/>
        <enum-item name='ADVENTURE_WORLD_DEBUG'/>
        <enum-item name='num'/>
        <enum-item name='NONE'/>
    </enum-type>

    <global-object name='gamemode'>
        <enum base-type='int32_t' type-name='game_mode'/>
    </global-object>
    <global-object name='gametype'>
        <enum base-type='int32_t' type-name='game_type'/>
    </global-object>

    <global-object name='ui_menu_width'>
        <static-array type-name='int8_t' count='2'/>
    </global-object>

    <global-object name='title'>
        <static-string size='256'/>
    </global-object>

    <global-object name='title_spaced'>
        <static-string size='256'/>
    </global-object>

    -- .bss compound - THAT IS, NOT SIMPLE INTEGER VARIABLES!

    <global-object name='created_item_type'>
        <stl-vector>
            <enum base-type='int16_t' type-name='item_type'/>
        </stl-vector>
    </global-object>
    <global-object name='created_item_subtype'>
        <stl-vector>
            <int16_t refers-to='(item-subtype-target $global.created_item_type[$$._key] $)'/>
        </stl-vector>
    </global-object>
    <global-object name='created_item_mattype'>
        <stl-vector>
            <int16_t ref-target='material' aux-value='$global.created_item_matindex[$._key]'/>
        </stl-vector>
    </global-object>
    <global-object name='created_item_matindex'>
        <stl-vector type-name='int16_t'/>
    </global-object>
    <global-object name='created_item_count'>
        <stl-vector type-name='int32_t'/>
    </global-object>

    <!-- To find: with world, place cursor over unit, and trace pointers to unit -->
    <global-object name='map_renderer' type-name='map_renderer'/>

    <global-object name='d_init' type-name='d_init'/>

    <global-object name='flows'>
        <stl-vector pointer-type='flow_info'/>
    </global-object>

    <global-object name='enabler' type-name='enabler'/>
    <global-object name='gps' type-name='graphic'/>

    <!-- To find: search for strings in the welcome or textview screen, then trace pointers -->
    <global-object name='gview' type-name='interfacest'/>

    <global-object name='init' type-name='init'/>

    <global-object name='texture' type-name='texture_handlerst'/>

    <global-object name='timed_events'>
        <stl-vector pointer-type='timed_event'/>
    </global-object>

    <!-- To find: create squad, enter the 's' menu, trace pointers to squad -->
    <global-object name='plotinfo' type-name='plotinfost'/>

    <global-object name='adventure' type-name='adventurest'/>

    <!-- To find: start creating a building, trace the build material item pointers -->
    <global-object name='buildreq' type-name='buildreq'/>

    <global-object name='ui_building_assign_type'>
        <stl-vector type-name='int8_t'/>
    </global-object>
    <global-object name='ui_building_assign_is_marked'>
        <stl-vector type-name='bool'/>
    </global-object>
    <!-- Candidates for a building owner. To find: backtrack from unit. -->
    <global-object name='ui_building_assign_units'>
        <stl-vector pointer-type='unit'/>
    </global-object>
    <global-object name='ui_building_assign_items'>
        <stl-vector pointer-type='item'/>
    </global-object>

    <!-- To find: place loo'k' cursor over a unit, trace pointers to unit -->
    <global-object name='ui_look_list' type-name='ui_look_list'/>

    <!-- To find: select a unit in 'v'iew, open inventory page, trace unit.inventory.* pointers -->
    <global-object name='game' type-name='gamest'/>
    <!--
        game_extra immediately follows game in steam editions, but in classic editions the last 128 bytes
        of game overlap with game_extra due to steam-specific fields
        accessing the steam-specific fields with a classic version will cause misoperation
        game.external_flag should be the last four bytes of game_extra
        for 50.07 game_extra is game + 0xa558 and steam_mod_manager is game + 0xa4d8
    -->
    <global-object name='game_extra' type-name='gamest_extra'/>
    <global-object name='steam_mod_manager' type-name='steam_mod_manager'/>

    <!-- To find: search for unit nickname, backtrace pointers to find the main unit list. -->
    <global-object name='world' type-name='world'/>

    -- .bss primitive

    <global-object name='version'>
        <enum base-type='int32_t' type-name='save_version'/>
    </global-object>
    <global-object name='min_load_version'>
        <enum base-type='int32_t' type-name='save_version'/>
    </global-object>
    <global-object name='movie_version'>
        <enum base-type='int32_t' type-name='cmv_version'/>
    </global-object>
    <global-object name='basic_seed' type-name='int32_t'/>

    <global-object name='activity_next_id' type-name='int32_t'/>
    <global-object name='agreement_next_id' type-name='int32_t'/>
    <global-object name='army_controller_next_id' type-name='int32_t'/>
    <global-object name='army_next_id' type-name='int32_t'/>
    <global-object name='army_tracking_info_next_id' type-name='int32_t'/>
    <global-object name='art_image_chunk_next_id' type-name='int32_t'/>
    <global-object name='artifact_next_id' type-name='int32_t'/>
    <global-object name='belief_system_next_id' type-name='int32_t'/>
    <global-object name='building_next_id' type-name='int32_t'/>
    <global-object name='crime_next_id' type-name='int32_t'/>
    <global-object name='cultural_identity_next_id' type-name='int32_t'/>
    <global-object name='dance_form_next_id' type-name='int32_t'/>
    <global-object name='divination_set_next_id' type-name='int32_t'/>
    <global-object name='entity_next_id' type-name='int32_t'/>
    <global-object name='flow_guide_next_id' type-name='int32_t'/>
    <global-object name='formation_next_id' type-name='int32_t'/>
    <global-object name='hist_event_collection_next_id' type-name='int32_t'/>
    <global-object name='hist_event_next_id' type-name='int32_t'/>
    <global-object name='hist_figure_next_id' type-name='int32_t'/>
    <global-object name='identity_next_id' type-name='int32_t'/>
    <global-object name='image_set_next_id' type-name='int32_t'/>
    <global-object name='incident_next_id' type-name='int32_t'/>
    <global-object name='interaction_instance_next_id' type-name='int32_t'/>
    <global-object name='item_next_id' type-name='int32_t'/>
    <global-object name='job_next_id' type-name='int32_t'/>
    <global-object name='machine_next_id' type-name='int32_t'/>
    <global-object name='musical_form_next_id' type-name='int32_t'/>
    <global-object name='nemesis_next_id' type-name='int32_t'/>
    <global-object name='occupation_next_id' type-name='int32_t'/>
    <global-object name='poetic_form_next_id' type-name='int32_t'/>
    <global-object name='proj_next_id' type-name='int32_t'/>
    <global-object name='rhythm_next_id' type-name='int32_t'/>
    <global-object name='scale_next_id' type-name='int32_t'/>
    <global-object name='schedule_next_id' type-name='int32_t'/>
    <global-object name='soul_next_id' type-name='int32_t'/>
    <global-object name='squad_next_id' type-name='int32_t'/>
    <global-object name='task_next_id' type-name='int32_t'/>
    <global-object name='unit_chunk_next_id' type-name='int32_t'/>
    <global-object name='unit_next_id' type-name='int32_t'/>
    <global-object name='vehicle_next_id' type-name='int32_t'/>
    <global-object name='written_content_next_id' type-name='int32_t'/>

    <global-object name='cur_year' type-name='int32_t'/>
    <global-object name='cur_year_tick' type-name='int32_t'/>
    <global-object name='cur_year_tick_advmode' type-name='int32_t'/>

    <global-object name='cur_season'>
        <enum base-type='int8_t' type-name='season'/>
    </global-object>
    <global-object name='cur_season_tick' type-name='int32_t'/>

    <global-object name='current_weather'>
        <static-array count='5'>
            <static-array count='5'>
                <enum base-type='int8_t' type-name='weather_type'/>
            </static-array>
        </static-array>
    </global-object>

    <global-object name='pause_state' type-name='bool'/>

    <global-object name='process_dig' type-name='bool'
                   comment='Requests dig designations to be processed next frame.'/>
    <global-object name='process_jobs' type-name='bool'
                   comment='Requests building jobs to be processed next frame.'/>

    <global-object name='ui_building_in_assign' type-name='bool'/>
    <global-object name='ui_building_in_resize' type-name='bool'/>

    <global-object name='ui_building_resize_radius' type-name='int16_t'/>

    <!-- To find: open building i't'ems, move list highlight around, search for changes -->
    <global-object name='ui_building_item_cursor'>
        <int32_t/>
    </global-object>

    <!-- To find: enter loo'k' mode, move list highlight around, search for changes -->
    <global-object name='ui_look_cursor'>
        <int32_t refers-to='$global.ui_look_list.items[$]'/>
    </global-object>

    <!-- To find: enter unit 'v'iew mode, move to a point with multiple units
         within range, toggle them by pressing 'v', search for changes. -->
    <global-object name='ui_selected_unit'>
        <int32_t refers-to='$global.world.units.active[$]'/>
    </global-object>

    <!-- To find: enter unit 'v'iew mode, switch pages, search for changes -->
    <global-object name='ui_unit_view_mode' type-name='ui_unit_view_mode'/>

    <!-- To find: enter 'q'uery, add jobs, see which bool changes between
         the main query page and selecting job to add. -->
    <global-object name='ui_workshop_in_add' type-name='bool'/>

    <!-- To find: enter 'q'uery, move the job list highlight, search for changes. -->
    <global-object name='ui_workshop_job_cursor'>
        <int32_t refers-to='$global.world.selected_building.jobs[$]'/>
    </global-object>

    <enum-type type-name='lever_target_type' base-type='int8_t'>
        <enum-attr name='building_type' type-name='building_type' use-key-name='true' default-value='NONE'/>

        <enum-item name='NONE' value='-1'/>
        <enum-item name='BarsVertical' value='66'/> 'B'
        <enum-item name='BarsFloor' value='70'/> 'F'
        <enum-item name='SpearsSpikes' value='83'> 'S'
            <item-attr name='building_type' value='Trap'/>
        </enum-item>
        <enum-item name='TrackStop' value='84'> 'T'
            <item-attr name='building_type' value='Trap'/>
        </enum-item>

        <enum-item name='GearAssembly' value='97'/> 'a'
        <enum-item name='Bridge' value='98'/> 'b'
        <enum-item name='Chain' value='99'/> 'c'
        <enum-item name='Door' value='100'/> 'd'
        <enum-item name='EncrustGems' value='101'> 'e'
            <item-attr name='building_type' value='NONE'/>
        </enum-item>
        <enum-item name='Floodgate' value='102'/> 'f'
        <enum-item name='GrateFloor' value='103'/> 'g'
        <enum-item name='Hatch' value='104'/> 'h'
        <enum-item name='Cage' value='106'/> 'j'
        <enum-item name='LeverMechanism' value='108' comment='use in lever'> 'l'
            <item-attr name='building_type' value='NONE'/>
        </enum-item>
        <enum-item name='Support' value='115'/> 's'
        <enum-item name='TargetMechanism' value='116' comment='use in target'> 't'
            <item-attr name='building_type' value='NONE'/>
        </enum-item>
        <enum-item name='GrateWall' value='119'/> 'w'
    </enum-type>

    <!-- To find: enter 'q'uery, select a lever, queue a "link to" job and search for changes. -->
    <global-object name='ui_lever_target_type'>
        <enum base-type='int8_t' type-name='lever_target_type'/>
    </global-object>

    <global-object name='window_x' type-name='int32_t'/>
    <global-object name='window_y' type-name='int32_t'/>
    <global-object name='window_z' type-name='int32_t'/>

    <global-object name='debug_nopause' type-name='bool' comment='Prevents the game from being paused'/>
    <global-object name='debug_nomoods' type-name='bool' comment='Same as ARTIFACTS:NO'/>
    <global-object name='debug_combat' type-name='bool' comment='Functionality unknown, combat-related'/>
    <global-object name='debug_wildlife' type-name='bool' comment='Functionality unknown, wildlife-related'/>
    <global-object name='debug_nodrink' type-name='bool' comment='Disables thirst on everything'/>
    <global-object name='debug_noeat' type-name='bool' comment='Disables hunger on everything'/>
    <global-object name='debug_nosleep' type-name='bool' comment='Disables drowsiness on everything'/>
    <global-object name='debug_showambush' type-name='bool' comment='Makes hidden ambushers visible on-screen and in the units list (but not to your citizens)'/>
    <global-object name='debug_fastmining' type-name='bool' comment='All dwarves mine as fast as a Legendary Miner'/>
    <global-object name='debug_noberserk' type-name='bool' comment='Insanity can only result in Crazed or Melancholy, never Berserk'/>
    <global-object name='debug_turbospeed' type-name='bool' comment='All units move and work at maximum speed'/>

    <global-object name='save_on_exit' type-name='bool' comment='Ending the game saves its state back to world.dat or world.sav'/>

    <global-object name='standing_orders_gather_minerals' type-name='uint8_t'/>
    <global-object name='standing_orders_gather_wood' type-name='uint8_t'/>
    <global-object name='standing_orders_gather_food' type-name='uint8_t'/>
    <global-object name='standing_orders_gather_bodies' type-name='uint8_t'/>
    <global-object name='standing_orders_gather_animals' type-name='uint8_t'/>
    <global-object name='standing_orders_gather_furniture' type-name='uint8_t'/>
    <global-object name='standing_orders_farmer_harvest' type-name='uint8_t'/>
    <global-object name='standing_orders_job_cancel_announce' type-name='uint8_t'/>
    <global-object name='standing_orders_mix_food' type-name='uint8_t'/>
    <global-object name='standing_orders_gather_refuse' type-name='uint8_t'/>
    <global-object name='standing_orders_gather_refuse_outside' type-name='uint8_t'/>
    <global-object name='standing_orders_gather_vermin_remains' type-name='uint8_t'/>
    <global-object name='standing_orders_dump_corpses' type-name='uint8_t'/>
    <global-object name='standing_orders_dump_skulls' type-name='uint8_t'/>
    <global-object name='standing_orders_dump_skins' type-name='uint8_t'/>
    <global-object name='standing_orders_dump_bones' type-name='uint8_t'/>
    <global-object name='standing_orders_dump_hair' type-name='uint8_t'/>
    <global-object name='standing_orders_dump_shells' type-name='uint8_t'/>
    <global-object name='standing_orders_dump_other' type-name='uint8_t'/>
    <global-object name='standing_orders_forbid_used_ammo' type-name='uint8_t'/>
    <global-object name='standing_orders_forbid_other_dead_items' type-name='uint8_t'/>
    <global-object name='standing_orders_forbid_own_dead' type-name='uint8_t'/>
    <global-object name='standing_orders_forbid_other_nohunt' type-name='uint8_t'/>
    <global-object name='standing_orders_forbid_own_dead_items' type-name='uint8_t'/>
    <global-object name='standing_orders_auto_loom' type-name='uint8_t'/>
    <global-object name='standing_orders_auto_collect_webs' type-name='uint8_t'/>
    <global-object name='standing_orders_auto_slaughter' type-name='uint8_t'/>
    <global-object name='standing_orders_auto_butcher' type-name='uint8_t'/>
    <global-object name='standing_orders_auto_tan' type-name='uint8_t'/>
    <global-object name='standing_orders_auto_fishery' type-name='uint8_t'/>
    <global-object name='standing_orders_auto_kitchen' type-name='uint8_t'/>
    <global-object name='standing_orders_auto_kiln' type-name='uint8_t'/>
    <global-object name='standing_orders_auto_smelter' type-name='uint8_t'/>
    <global-object name='standing_orders_auto_other' type-name='uint8_t'/>
    <global-object name='standing_orders_use_dyed_cloth' type-name='uint8_t'/>
    <global-object name='standing_orders_zoneonly_drink' type-name='uint8_t'/>
    <global-object name='standing_orders_zoneonly_fish' type-name='uint8_t'/>

    <global-object name='cur_snow_counter' type-name='int16_t'/>
    <global-object name='cur_rain_counter' type-name='int16_t'/>
    <global-object name='weathertimer' type-name='int16_t'/>
    <global-object name='cur_snow'>
        <static-array count='256' type-name='coord'/>
    </global-object>
    <global-object name='cur_rain'>
        <static-array count='1280' type-name='coord'/>
    </global-object>
    <global-object name='jobvalue'>
        <static-array count='258' type-name='int32_t'/>
    </global-object>
    <global-object name='jobvalue_setter'>
        <static-array count='258' pointer-type='unit'/>
    </global-object>
    <global-object name='interactitem' pointer-type='item'/>
    <global-object name='interactinvslot' pointer-type='unit_inventory_item'/>
    <global-object name='handleannounce' type-name='bool'/>
    <global-object name='preserveannounce' type-name='bool'/>
    <global-object name='updatelightstate' type-name='bool'/>
</data-definition>

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