df.block.xml

<data-definition>
    <bitfield-type type-name='block_flags' original-name='block_flag' base-type='uint32_t'> bay12: BLOCKFLAG_*
        <flag-bit name='designated' original-name='HAS_DESJOB' comment='for jobs etc'/>
        <flag-bit name='update_temperature' original-name='TEMPERATURE_ADJUST'/>
        <flag-bit name='update_liquid' original-name='FLOW_ADJUST'/>
        <flag-bit name='update_liquid_twice' original-name='FLOW_MAINTAIN_ADJUST'
                  comment='Protects UpdateLiquid from being cleared the first time.'/>
        <flag-bit name='repath_on_freeze' original-name='STALE_ON_FREEZE'
                  comment='reindex_pathfinding set and flag cleared if temperature below 10000'/>
        <flag-bit name='repath_on_melt' original-name='STALE_ON_MELT'
                  comment='reindex_pathfinding set and flag cleared if temperature above 10000'/>
        <flag-bit name='has_aquifer' original-name='HAS_WATER_TABLE'
                  comment='has at least one "water_table" designation flag'/>
        <flag-bit name='check_aquifer' original-name='NEARBY_WATER_TABLE'
                  comment='has tiles that may get flooded by an adjacent aquifer'/>
        <flag-bit name='may_have_item_spatter' original-name='MAY_HAVE_ITEM_SPATTER'/>
        <flag-bit name='may_have_material_spatter' original-name='MAY_HAVE_MATERIAL_SPATTER' comment="usually mud"/>
        <flag-bit name='has_magma_close' original-name='HAS_MAGMA_CLOSE'/>
        <flag-bit name='has_magma_far' original-name='HAS_MAGMA_FAR'/>
        <flag-bit name='mas_magma_low' original-name='HAS_MAGMA_LOW'/>
        <flag-bit name='has_river_high' original-name='HAS_RIVER_HIGH'/>
        <flag-bit name='has_river_medium' original-name='HAS_RIVER_MEDIUM'/>
        <flag-bit name='has_river_low' original-name='HAS_RIVER_LOW'/>
    </bitfield-type>

    <enum-type type-name='block_square_event_type' base-type='int16_t'> bay12: BlockSquareEventType
        <enum-item name='NONE' value='-1'/>
        <enum-item name='mineral' original-name='MINERAL'/>
        <enum-item name='frozen_liquid' original-name='FROZEN_LIQUID'/>
        <enum-item name='world_construction' original-name='WORLD_CONSTRUCTION'/>
        <enum-item name='material_spatter' original-name='MATERIAL_SPATTER'/>
        <enum-item name='grass' original-name='GRASS'/>
        <enum-item name='spoor' original-name='SPOOR'/>
        <enum-item name='item_spatter' original-name='ITEM_SPATTER'/>
        <enum-item name='designation_priority' original-name='DESIGNATION_PRIORITY'/>
    </enum-type>

    <class-type type-name='block_square_event' original-name='block_square_eventst'>
        <virtual-methods>
            <vmethod ret-type='block_square_event_type' name='getType' original-name='type'/>
            <vmethod name='write_file'> <pointer type-name='file_compressorst' name='filecomp'/> </vmethod>
            <vmethod name='read_file'>
                <pointer type-name='file_compressorst' name='filecomp'/>
                <int32_t name='loadversion'/>
            </vmethod>
            <vmethod ret-type='bool' name='isEmpty' original-name='is_empty'/>
            <vmethod is-destructor='true'/>

            <vmethod name='checkTemperature' original-name='temperature_advance'>
                <int16_t name='x'/>
                <int16_t name='y'/>
                <uint16_t name='ct'/>
            </vmethod>
        </virtual-methods>
    </class-type>

    <bitfield-type type-name='mineral_event_flag'> bay12: MINERAL_EVENT_FLAG_*
        <flag-bit name='discovered' original-name='DISCOVERED'/>
        <flag-bit name='cluster' original-name='CLUSTER'/>
        <flag-bit name='vein' original-name='VEIN'/>
        <flag-bit name='cluster_small' original-name='SMALL_CLUSTER'/>
        <flag-bit name='cluster_one' original-name='RARE'/>
    </bitfield-type>

    <class-type type-name='block_square_event_mineralst' inherits-from='block_square_event' custom-methods='true'>
        <int32_t name='inorganic_mat' original-name='stone_index' ref-target='inorganic_raw'/>
        <compound type-name='tile_bitmask' name='tile_bitmask' original-name='mask'/>
        <bitfield base-type='uint32_t' type-name='mineral_event_flag' name='flags' original-name='flag'/>
        <extra-include type-name='coord2d'/>
        <custom-methods>
            <cmethod name='has_assignments'/>
        </custom-methods>
    </class-type>

    <class-type type-name='block_square_event_frozen_liquidst' inherits-from='block_square_event'>
        <static-array name='tiles' original-name='covered_map_tile' count='16'>
            <static-array count='16'>
                <enum base-type='uint16_t' type-name='tiletype'/>
            </static-array>
        </static-array>
        <static-array name='liquid_type' count='16'>
            <static-array count='16'>
                <enum base-type='uint8_t' type-name='tile_liquid'/>
            </static-array>
        </static-array>
    </class-type>

    <class-type type-name='block_square_event_material_spatterst' inherits-from='block_square_event'>
        <int16_t name='mat_type' original-name='mat' ref-target='material' aux-value='$$.mat_index'/>
        <int32_t name='mat_index' original-name='matg'/>
        <enum type-name='matter_state' name='mat_state' original-name='state'/>
        <static-array name='amount' count='16'>
            <static-array count='16' type-name='uint8_t'/>
        </static-array>
        <uint16_t name='min_temperature' original-name='danger_low_temp'/>
        <uint16_t name='max_temperature' original-name='danger_high_temp'/>
    </class-type>

    <bitfield-type type-name='item_spatter_flag' original-name='block_square_event_item_spatter_flag' base-type='uint8_t'> bay12: BLOCK_SQUARE_EVENT_ITEM_SPATTER_FLAG_*
        <flag-bit name='season_full_timer' original-name='SEASON_FULL_TIMER' count='3'/>
    </bitfield-type>

    <class-type type-name='block_square_event_item_spatterst' inherits-from='block_square_event'>
        <enum type-name='item_type' name='item_type' original-name='i_type'/>
        <int16_t name='item_subtype' original-name='i_subtype' refers-to='(item-subtype-target $$._parent.item_type $)'/>
        <int16_t name='mattype' original-name='i_subcat1' ref-target='material' aux-value='$$.matindex'/>
        <int32_t name='matindex' original-name='i_subcat2'/>

        <int32_t name='print_variant'/>
        <static-array name='amount' count='16'>
            <static-array count='16' type-name='int32_t'/>
        </static-array>
        <static-array name='flag' count='16'>
            <static-array count='16' type-name='item_spatter_flag'/>
        </static-array>

        <uint16_t name='min_temperature' original-name='danger_low_temp'/>
        <uint16_t name='max_temperature' original-name='danger_high_temp'/>
    </class-type>

    <class-type type-name='block_square_event_grassst' inherits-from='block_square_event'>
        <int32_t name='plant_index' original-name='race' ref-target='plant_raw' />
        <static-array name='amount' count='16'>
            <static-array count='16' type-name='uint8_t'/>
        </static-array>
    </class-type>

    <enum-type type-name='spoor_type' original-name='bse_spoor_type' base-type='int8_t'> bay12: BSESpoorType, defined as uint8_t but that won't work here because of NONE
        <enum-item name='NONE' value='-1'/>
        <enum-item name='BROKEN_VEGETATION'/>
        <enum-item name='HFID_COMBINEDCASTE_BP'/>
        <enum-item name='ITEMT_ITEMST_ORIENT'/>
        <enum-item name='MESS'/>
    </enum-type>

    <bitfield-type type-name='spoor_flag' original-name='bse_spoor_flag' base-type='uint16_t'> bay12: BSE_SPOOR_FLAG_*
        <flag-bit name='present' original-name='PRESENT'/>
        <flag-bit name='has_direction' original-name='HAS_DIRECTION'/>
        <flag-bit name='direction' original-name='DIR' count='3' type-name='spoor_flag_dir'/>
        <flag-bit name='yours' original-name='YOURS'/>
        <flag-bit name='liquid_print' original-name='LIQUID_PRINT'/>
        <flag-bit name='level' original-name='LEVEL' count='2' type-name='spoor_flag_level'/>
    </bitfield-type>

    <enum-type type-name='spoor_flag_dir' base-type='uint16_t'> bay12: BSE_SPOOR_FLAG_DIR_*
        <enum-item name='north' original-name='N'/>
        <enum-item name='south' original-name='S'/>
        <enum-item name='east' original-name='E'/>
        <enum-item name='northeast' original-name='NE'/>
        <enum-item name='west' original-name='W'/>
        <enum-item name='northwest' original-name='NW'/>
        <enum-item name='southeast' original-name='SE'/>
        <enum-item name='southwest' original-name='SW'/>
    </enum-type>

    <enum-type type-name='spoor_flag_level' base-type='uint16_t'> bay12: BSE_SPOOR_FLAG_LEVEL_*
        <enum-item name='normal' original-name='NORMAL'/>
        <enum-item name='vague' original-name='VAGUE'/>
        <enum-item name='light' original-name='LIGHT'/>
        <enum-item name='heavy' original-name='HEAVY'/>
    </enum-type>

    <struct-type type-name='bse_spoor_datast'>
        <bitfield type-name='spoor_flag' name='flag'/>
        <enum type-name='spoor_type' name='type'/>
        <int32_t name='id1'/>
        <int32_t name='id2'/>
        <int32_t name='id3'/>
    </struct-type>

    <struct-type type-name='block_square_event_spoor_infost'>
        <static-array name='flags' original-name='flag' count='16'>
            <static-array count='16' type-name='spoor_flag'/>
        </static-array>
        <static-array name='type' count='16'>
            <static-array count='16' type-name='spoor_type'/>
        </static-array>
        <static-array name='id1' count='16'>
            <static-array count='16' type-name='int32_t'/>
        </static-array>
        <static-array name='race' original-name='id2' count='16' comment='varies based on type'>
            <static-array count='16'>
                <int32_t ref-target='creature_raw'/>
            </static-array>
        </static-array>
        <static-array name='caste' original-name='id3' count='16' comment='varies based on type'>
            <static-array count='16'>
                <int32_t ref-target='caste_raw'/>
            </static-array>
        </static-array>
        <static-array name='age' original-name='rel_sec_since_base_time' count='16' comment='in half-seconds'>
            <static-array count='16' type-name='int32_t'/>
        </static-array>
        <int32_t name='year' original-name='base_year' init-value='-1'/>
        <int32_t name='year_tick' original-name='base_season_count' init-value='-1'/>
    </struct-type>

    <class-type type-name='block_square_event_spoorst' inherits-from='block_square_event'>
        <compound type-name='block_square_event_spoor_infost' name='info'/>
    </class-type>

    <class-type type-name='block_square_event_world_constructionst' inherits-from='block_square_event'>
        <int32_t name='construction_id' original-name='wcid' ref-target='world_construction'/>
        <compound type-name='tile_bitmask' name='tile_bitmask' original-name='mask'/>
    </class-type>

    <class-type type-name='block_square_event_designation_priorityst' inherits-from='block_square_event'>
        <static-array name='priority' count='16'>
            <static-array count='16' type-name='int32_t'/>
        </static-array>
    </class-type>

    <df-linked-list-type type-name='block_burrow_link' item-type='block_burrow'/> bay12: tlink{burrow_blockst}

    <struct-type type-name='block_burrow' original-name='burrow_blockst' df-list-link-type='block_burrow_link' df-list-link-field='link' custom-methods='true'>
        <int32_t name='id' original-name='burrow_id' ref-target='burrow'/>

        <compound type-name='tile_bitmask' name='tile_bitmask' original-name='mask'/>

        <pointer type-name='block_burrow_link' name="link" original-name='my_link'/>

        <extra-include type-name='coord2d'/>
        <custom-methods>
            <cmethod name='has_assignments'/>
        </custom-methods>
    </struct-type>

    <struct-type type-name='map_block' original-name='blockst'>
        <bitfield type-name='block_flags' name='flags' original-name='flag'/>

        <stl-vector pointer-type='block_square_event' name='block_events' original-name='block_square_event'/>

        <df-linked-list name='block_burrows' original-name='burrow' type-name='block_burrow_link'/>

        <int32_t name='local_feature' original-name='feature_ind' init-value='-1' comment='index into world_data.region_map'/>
        <int32_t name='global_feature' original-name='feature_layer' ref-target='world_underground_region'/>
        <int32_t name='global_feature_sq' original-name='feature_layer_sq' init-value='-1'/>

        This is compared to unit.animal.population.depth when a revealed
        necromancer searches for a map edge tile to run away to:
        <int16_t name='layer_depth' comment='uninitialized'/>

        <int32_t name='dsgn_check_cooldown' original-name='des_timer'/>
        <bitfield type-name='tile_designation' name='default_liquid' original-name='edge_liquid_type'/>

        <stl-vector type-name='int32_t' name='items' original-name='ground_item_id' ref-target='item'/>
        <stl-vector pointer-type='flow_info' name='flows' original-name='flow'/>

        <compound type-name='flow_reuse_pool' name='flow_pool' comment='actually inline'/>

        <compound type-name='coord' name='map_pos' original-name='start'/>
        <compound type-name='coord2d' name='region_pos' original-name='a'/>

        <size_t name='pool_id' init-value='-1'/>

        <static-array name='tiletype' original-name='map_tile' count='16'>
            <static-array count='16'>
                <enum base-type='uint16_t' type-name='tiletype' init-value='OpenSpace'/>
            </static-array>
        </static-array>
        <static-array name='designation' count='16'>
            <static-array count='16'>
                <bitfield base-type='uint32_t' type-name='tile_designation'/>
            </static-array>
        </static-array>
        <static-array name='occupancy' count='16'>
            <static-array count='16'>
                <bitfield base-type='uint32_t' type-name='tile_occupancy'/>
            </static-array>
        </static-array>

        <static-array name='fog_of_war' original-name='memmap' count='16' comment='for adventure mode'>
            <static-array count='16' type-name='uint8_t'/>
        </static-array>

        <static-array name='path_cost' original-name='pmap' count='16'>
            <comment>flood; 256*cost for straight, 362*cost for diagonal</comment>
            <static-array count='16'>
                <int32_t/>
            </static-array>
        </static-array>
        <static-array name='path_tag' original-name='dirmap' count='16'>
            <comment>flood; sync to path_distance; same value; inc per run; reset to 0 on wraparound</comment>
            <static-array count='16'>
                <uint16_t/>
            </static-array>
        </static-array>
        <static-array name='walkable' original-name='levelmap' count='16'>
            <comment>0 = non-walkable; same nonzero at A and B = walkable from A to B</comment>
            <static-array count='16'>
                <int32_t/>
            </static-array>
        </static-array>
        <static-array name='map_edge_distance' original-name='dlevelmap' count='16'>
            <comment>1 at walkable map edge; then +1 per 10 tiles it seems; 0 in dug tunnels</comment>
            <static-array count='16'>
                <int16_t/>
            </static-array>
        </static-array>

        <static-array name='temperature_1' original-name='current_temperature' count='16'>
            <static-array count='16'>
                <uint16_t/>
            </static-array>
        </static-array>
        <static-array name='temperature_2' original-name='normal_temperature' count='16'>
            <static-array count='16'>
                <uint16_t/>
            </static-array>
        </static-array>

        <static-array name='lighting' count='16'>
            <static-array count='16'>
                <uint16_t/>
            </static-array>
        </static-array>
        <static-array name='liquid_flow' original-name='flow_dir' count='16'>
            <static-array count='16'>
                <bitfield base-type='uint16_t' type-name='tile_liquid_flow'/>
            </static-array>
        </static-array>

        <static-array name='region_offset' original-name='world_shift' count='9'>
            <int8_t/>
        </static-array>
    </struct-type>

    <bitfield-type type-name='cave_column_flag' base-type='uint8_t'> bay12: CAVE_COLUMN_FLAG_*
        <flag-bit name='UNSTABLE'/>
        <flag-bit name='ULTRA_SUPPORTED'/>
    </bitfield-type>

    <df-linked-list-type type-name='cave_column_link' item-type='cave_column'/>

    <class-type type-name='cave_column' df-list-link-type='cave_column_link' df-list-link-field='' original-name='cave_columnst'>
        <int16_t name='base_z'/>
        <int16_t name='top_z'/>
        <uint16_t name='rect_index' init-value='30000'/>
        <bitfield base-type='uint8_t' type-name='cave_column_flag' name='flags' original-name='flag'/>

        <virtual-methods>
            <vmethod name='write_file'> <pointer type-name='file_compressorst' name='filecomp'/> </vmethod>
            <vmethod name='read_file'>
                <pointer type-name='file_compressorst' name='filecomp'/>
                <int32_t name='loadversion'/>
            </vmethod>
        </virtual-methods>
    </class-type>

    <bitfield-type type-name='cave_column_rectangle_flag' base-type='uint32_t'> bay12: CAVE_COLUMN_RECTANGLE_FLAG_*
        <flag-bit name='SUPPORTED'/>
        <flag-bit name='UNSTABLE'/>
        <flag-bit name='ULTRA_SUPPORTED'/>
    </bitfield-type>

    <class-type type-name='cave_column_rectangle' original-name='cave_column_rectanglest'>
        <int32_t name='weight'/>
        <int16_t name='min_x'/>
        <int16_t name='min_y'/>
        <int16_t name='max_x'/>
        <int16_t name='max_y'/>
        <int16_t name='base_z'/>
        <stl-vector type-name='int16_t' name='neighbor_bx'/>
        <stl-vector type-name='int16_t' name='neighbor_by'/>
        <stl-vector type-name='uint16_t' name='neighbor_index'/>
        <bitfield base-type='uint32_t' type-name='cave_column_rectangle_flag' name='flags' original-name='flag'/>

        <virtual-methods>
            <vmethod name='write_file'> <pointer type-name='file_compressorst' name='filecomp'/> </vmethod>
            <vmethod name='read_file'>
                <pointer type-name='file_compressorst' name='filecomp'/>
                <int32_t name='loadversion'/>
            </vmethod>
        </virtual-methods>
    </class-type>

    <struct-type type-name='block_column_print_infost'>
        <static-array name='x' count='4' type-name='int16_t'/>
        <static-array name='y' count='4' type-name='int16_t'/>
        <static-array name='tile' original-name='character' count='4' type-name='uint8_t'/>
    </struct-type>

    <enum-type type-name='map_block_column_flags' original-name='block_column_flag_type'> bay12: BlockColumnFlagType
        <enum-item name='UPDATE_CAVE_COLUMNS'/>
    </enum-type>

    <struct-type type-name='map_block_column' original-name='block_columnst'>
        <int16_t name="sink_level" original-name='water_el_table_block' comment='water at or above this level sinks into aquifer tiles'/>
        <int16_t name="beach_level" original-name='water_el_sink_height' comment='water at this level disappears if above more water'/>

        <int16_t name='ground_level' original-name='central_el_z' comment='for coloring unallocated blocks'/>

        <stl-vector pointer-type='block_column_print_infost' name='unmined_glyphs' original-name='print_info'/>
        <int16_t name="z_base" original-name='print_info_start_el_z'/>

        <static-array name='cave_columns' original-name='cave_column' count='16'>
            <static-array count='16'>
                <df-linked-list type-name='cave_column_link'/>
            </static-array>
        </static-array>

        <stl-vector pointer-type='cave_column_rectangle' name='column_rectangles' original-name='cave_column_rectangle'/>

        <int16_t name='z_shift' original-name='base_z' comment='seems to be 0 originally, but updated when map is shifted'/>

        <df-flagarray name='flags' original-name='flag' index-enum='map_block_column_flags'/>

        <static-array name='elevation' original-name='abs_el_z' count='16' since='v0.40.01'>
            <static-array count='16' type-name='int16_t' init-value='100'/>
        </static-array>

        <int16_t name='minimum_river_z'/>

        <compound type-name='coord' name='map_pos' original-name='start' comment='top left in tiles'/>
        <compound type-name='coord2d' name='region_pos' original-name='a'/>

        <stl-vector pointer-type='plant' name='plants' original-name='veg' comment="Only populated for the top left column in each mid level tile"/>
    </struct-type>
</data-definition>

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