df.refs.xml

<data-definition>
    <enum-type type-name='general_ref_type'>
        <enum-item name='NONE' value='-1'/>
        <enum-item name="ARTIFACT"/>
        <enum-item name="IS_ARTIFACT"/>
        <enum-item name="NEMESIS"/>
        <enum-item name="IS_NEMESIS"/>
        <enum-item name="ITEM"/>
        <enum-item name="ITEM_TYPE"/>
        <enum-item name="COINBATCH"/>
        <enum-item name="MAPSQUARE"/>
        <enum-item name="ENTITY_ART_IMAGE"/>
        <enum-item name="CONTAINS_UNIT"/>
        <enum-item name="CONTAINS_ITEM"/>
        <enum-item name="CONTAINED_IN_ITEM"/>
        <enum-item name="PROJECTILE"/>
        <enum-item name="UNIT"/>
        <enum-item name="UNIT_MILKEE"/>
        <enum-item name="UNIT_TRAINEE"/>

        <enum-item name="UNIT_ITEMOWNER"/>
        <enum-item name="UNIT_TRADEBRINGER"/>
        <enum-item name="UNIT_HOLDER"/>
        <enum-item name="UNIT_WORKER"/>
        <enum-item name="UNIT_CAGEE"/>
        <enum-item name="UNIT_BEATEE"/>
        <enum-item name="UNIT_FOODRECEIVER"/>
        <enum-item name="UNIT_KIDNAPEE"/>
        <enum-item name="UNIT_PATIENT"/>
        <enum-item name="UNIT_INFANT"/>
        <enum-item name="UNIT_SLAUGHTEREE"/>
        <enum-item name="UNIT_SHEAREE"/>
        <enum-item name="UNIT_SUCKEE"/>
        <enum-item name="UNIT_REPORTEE"/>
        <enum-item name="BUILDING"/>
        <enum-item name="BUILDING_CIVZONE_ASSIGNED"/>

        <enum-item name="BUILDING_TRIGGER"/>
        <enum-item name="BUILDING_TRIGGERTARGET"/>
        <enum-item name="BUILDING_CHAIN"/>
        <enum-item name="BUILDING_CAGED"/>
        <enum-item name="BUILDING_HOLDER"/>
        <enum-item name="BUILDING_WELL_TAG"/>
        <enum-item name="BUILDING_USE_TARGET_1"/>
        <enum-item name="BUILDING_USE_TARGET_2"/>
        <enum-item name="BUILDING_DESTINATION"/>
        <enum-item name="BUILDING_NEST_BOX"/>
        <enum-item name="ENTITY"/>
        <enum-item name="ENTITY_STOLEN"/>
        <enum-item name="ENTITY_OFFERED"/>
        <enum-item name="ENTITY_ITEMOWNER"/>
        <enum-item name="LOCATION"/>
        <enum-item name="INTERACTION"/>

        <enum-item name="ABSTRACT_BUILDING"/>
        <enum-item name="HISTORICAL_EVENT"/>
        <enum-item name="SPHERE"/>
        <enum-item name="SITE"/>
        <enum-item name="SUBREGION"/>
        <enum-item name="FEATURE_LAYER"/>
        <enum-item name="HISTORICAL_FIGURE"/>
        <enum-item name="ENTITY_POP"/>
        <enum-item name="CREATURE"/>
        <enum-item name="UNIT_RIDER"/>
        <enum-item name="UNIT_CLIMBER"/>
        <enum-item name="UNIT_GELDEE"/>
        <enum-item name="KNOWLEDGE_SCHOLAR_FLAG"/>
        <enum-item name="ACTIVITY_EVENT"/>
        <enum-item name="VALUE_LEVEL"/>
        <enum-item name="LANGUAGE"/>

        <enum-item name="WRITTEN_CONTENT"/>
        <enum-item name="POETIC_FORM"/>
        <enum-item name="MUSICAL_FORM"/>
        <enum-item name="DANCE_FORM"/>
        <enum-item name="BUILDING_DISPLAY_FURNITURE"/>
        <enum-item name="UNIT_INTERROGATEE"/>
    </enum-type>

    <class-type type-name='general_ref' original-name='general_refst'>
        <virtual-methods>
            -- 0 --
            <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='general_ref_type' name='getType'/>
            <vmethod name='getItem'>
                <ret-type><pointer type-name='item'/></ret-type>
            </vmethod>
            <vmethod name='getUnit'>
                <ret-type><pointer type-name='unit'/></ret-type>
            </vmethod>
            -- 5 --
            <vmethod name='getProjectile'>
                <ret-type><pointer type-name='projectile'/></ret-type>
            </vmethod>
            <vmethod name='getBuilding'>
                <ret-type><pointer type-name='building'/></ret-type>
            </vmethod>
            <vmethod name='getEntity'>
                <ret-type><pointer type-name='historical_entity'/></ret-type>
            </vmethod>
            <vmethod name='getArtifact'>
                <ret-type><pointer type-name='artifact_record'/></ret-type>
            </vmethod>
            <vmethod name='getNemesis'>
                <ret-type><pointer type-name='nemesis_record'/></ret-type>
            </vmethod>
            -- 10 --
            <vmethod name='getEvent'>
                <ret-type><pointer type-name='activity_event'/></ret-type>
            </vmethod>
            <vmethod name='setID'> <int32_t/> </vmethod>
            <vmethod ret-type='int32_t' name='getID'/>
            <vmethod name='setLocation'>
                <int32_t name='x'/>
                <int32_t name='y'/>
                <int32_t name='z'/>
            </vmethod>
            <vmethod name='getLocation'>
                <pointer type-name='int32_t' name='out_x'/>
                <pointer type-name='int32_t' name='out_y'/>
                <pointer type-name='int32_t' name='out_z'/>
            </vmethod>
            -- 15 --
            <vmethod is-destructor='true'/>
            <vmethod name='clone' comment='bay12: copy'>
                <ret-type><pointer type-name='general_ref'/></ret-type>
            </vmethod>
            <vmethod name='generateTitle' comment='bay12: generate_title'>
                <enum type-name='written_content_type' name='form'/>
                <pointer type-name='stl-string' name='title'/>
            </vmethod>
            <vmethod name='getDescription' comment='bay12: descriptive_string'>
                <pointer name='str' type-name='stl-string'/>
            </vmethod>
            <vmethod name='getDescription2' comment='bay12: short_name'>
                <pointer name='str' type-name='stl-string'/>
            </vmethod>
            -- 20 --
            <vmethod name='getDescription3' comment='bay12: unique_xml_name'>
                <pointer name='str' type-name='stl-string'/>
            </vmethod>
        </virtual-methods>
    </class-type>

    <class-type type-name='general_ref_artifact' inherits-from='general_ref'
                original-name='general_ref_artifactst'>
        <int32_t name='artifact_id' ref-target='artifact_record'/>
    </class-type>

    <class-type type-name='general_ref_nemesis' inherits-from='general_ref'
                original-name='general_ref_nemesisst'>
        <int32_t name='nemesis_id' ref-target='nemesis_record'/>
    </class-type>

    <class-type type-name='general_ref_item' inherits-from='general_ref'
                original-name='general_ref_itemst'>
        <int32_t name='item_id' ref-target='item'/>
        <int32_t name='cached_index' init-value='-1' comment='lookup optimization, tries before binary search'/>
    </class-type>

    <class-type type-name='general_ref_item_type' inherits-from='general_ref'
                original-name='general_ref_item_typest'>
        <enum base-type='int32_t' name='type' type-name='item_type'/>
        <int32_t name='subtype' refers-to='(item-subtype-target $$._parent.type $)'/>
        <int16_t name="mat_type" ref-target='material' aux-value='$$.mat_index'/>
        <int16_t name="mat_index" init-value='-1'/>
    </class-type>

    <class-type type-name='general_ref_coinbatch' inherits-from='general_ref'
                original-name='general_ref_coinbatchst'>
        <int32_t name='batch'/>
    </class-type>

    <class-type type-name='general_ref_mapsquare' inherits-from='general_ref'
                original-name='general_ref_mapsquarest'>
        <enum base-type='int16_t' name='tiletype' type-name='tiletype'/>
        <int16_t name="mat_type" ref-target='material' aux-value='$$.mat_index'/>
        <int32_t name="mat_index" init-value='-1'/>
    </class-type>

    <class-type type-name='general_ref_entity_art_image' inherits-from='general_ref'
                original-name='general_ref_entity_art_imagest'>
        <int32_t name='entity_id' ref-target='historical_entity'/>
        <int32_t name='index' comment='lookup in entity.resources.art_image_*'/>
    </class-type>

    <class-type type-name='general_ref_projectile' inherits-from='general_ref'
                original-name='general_ref_projectilest'>
        <int32_t name='projectile_id' ref-target='projectile'/>
    </class-type>

    <class-type type-name='general_ref_unit' inherits-from='general_ref'
                original-name='general_ref_unitst'>
        <int32_t name='unit_id' ref-target='unit'/>
        <int32_t name='cached_index' init-value='-1' comment='lookup optimization, tries before binary search'/>
    </class-type>

    <class-type type-name='general_ref_building' inherits-from='general_ref'
                original-name='general_ref_buildingst'>
        <int32_t name='building_id' ref-target='building'/>
    </class-type>

    <class-type type-name='general_ref_entity' inherits-from='general_ref'
                original-name='general_ref_entityst'>
        <int32_t name='entity_id' ref-target='historical_entity'/>
    </class-type>

    <class-type type-name='general_ref_locationst' inherits-from='general_ref'>
        <int32_t name='x'/>
        <int32_t name='y'/>
        <int32_t name='z'/>
    </class-type>

    <class-type type-name='general_ref_interactionst' inherits-from='general_ref'>
        <int32_t name='interaction_id' ref-target='interaction'/>
        <int32_t name='source_id' ref-target='interaction_source' aux-value='$$.interaction_id'/>
        <int32_t name='unk_08'/>
        <int32_t name='unk_0c'/>
    </class-type>

    <class-type type-name='general_ref_abstract_buildingst' inherits-from='general_ref'>
        <int32_t name='site_id' ref-target='world_site'/>
        <int32_t name='building_id' ref-target='abstract_building' aux-value='$$.site_id'/>
    </class-type>

    <class-type type-name='general_ref_historical_eventst' inherits-from='general_ref'>
        <int32_t name='event_id' ref-target='history_event'/>
    </class-type>

    <class-type type-name='general_ref_spherest' inherits-from='general_ref'>
        <enum base-type='int16_t' name='sphere_type' type-name='sphere_type'/>
    </class-type>

    <class-type type-name='general_ref_sitest' inherits-from='general_ref'>
        <int32_t name='site_id' ref-target='world_site'/>
    </class-type>

    <class-type type-name='general_ref_subregionst' inherits-from='general_ref'>
        <int32_t name='region_id' ref-target='world_region'/>
    </class-type>

    <class-type type-name='general_ref_feature_layerst' inherits-from='general_ref'>
        <int32_t name='underground_region_id' ref-target='world_underground_region'/>
    </class-type>

    <class-type type-name='general_ref_historical_figurest' inherits-from='general_ref'>
        <int32_t name='hist_figure_id' ref-target='historical_figure'/>
    </class-type>

    <class-type type-name='general_ref_entity_popst' inherits-from='general_ref'>
        <int32_t name='unk_1'/>
        <int32_t name='race' ref-target='creature_raw'/>
        <int32_t name='unk_2'/>
        <bitfield name='flags' type-name='undead_flags'/>
    </class-type>

    <class-type type-name='general_ref_creaturest' inherits-from='general_ref'>
        <int32_t name='race' ref-target='creature_raw'/>
        <int32_t name='caste' ref-target='caste_raw' aux-value='$$.race'/>
        <int32_t name='unk_1'/>
        <int32_t name='unk_2'/>
        <bitfield name='flags' type-name='undead_flags'/>
    </class-type>

    <class-type type-name='general_ref_knowledge_scholar_flagst' inherits-from='general_ref'>
        <compound name='knowledge' type-name='knowledge_scholar_category_flag'/>
    </class-type>

    <class-type type-name='general_ref_activity_eventst' inherits-from='general_ref'>
        <int32_t name='activity_id' ref-target='activity_entry'/>
        <int32_t name='event_id'/>
    </class-type>

    <class-type type-name='general_ref_value_levelst' inherits-from='general_ref'>
        <enum name='value' base-type='int32_t' type-name='value_type'/>
        <int32_t name='level' comment='see http://dwarffortresswiki.org/index.php/DF2014:Personality_trait'/>
    </class-type>

    <class-type type-name='general_ref_languagest' inherits-from='general_ref'>
        <int32_t name='unk_1'/>
    </class-type>

    <class-type type-name='general_ref_written_contentst' inherits-from='general_ref'>
        <int32_t name='written_content_id' ref-target='written_content'/>
    </class-type>

    <class-type type-name='general_ref_poetic_formst' inherits-from='general_ref'>
        <int32_t name='poetic_form_id' ref-target='poetic_form'/>
    </class-type>

    <class-type type-name='general_ref_musical_formst' inherits-from='general_ref'>
        <int32_t name='musical_form_id' ref-target='musical_form'/>
    </class-type>

    <class-type type-name='general_ref_dance_formst' inherits-from='general_ref'>
        <int32_t name='dance_form_id' ref-target='dance_form'/>
    </class-type>

    <class-type type-name='general_ref_is_artifactst' inherits-from='general_ref_artifact'/>
    <class-type type-name='general_ref_is_nemesisst' inherits-from='general_ref_nemesis'/>
    <class-type type-name='general_ref_contains_unitst' inherits-from='general_ref_unit'/>
    <class-type type-name='general_ref_contains_itemst' inherits-from='general_ref_item'/>
    <class-type type-name='general_ref_contained_in_itemst' inherits-from='general_ref_item'/>
    <class-type type-name='general_ref_unit_milkeest' inherits-from='general_ref_unit'/>
    <class-type type-name='general_ref_unit_traineest' inherits-from='general_ref_unit'/>
    <class-type type-name='general_ref_unit_itemownerst' inherits-from='general_ref_unit'>
        <bitfield name='flags' since='v0.34.06'>
            <flag-bit name='litter'
                      comment='apparetly set after 1000 ticks, then confiscated in 1000 more ticks'/>
        </bitfield>
    </class-type>
    <class-type type-name='general_ref_unit_tradebringerst' inherits-from='general_ref_unit'/>
    <class-type type-name='general_ref_unit_holderst' inherits-from='general_ref_unit'/>
    <class-type type-name='general_ref_unit_workerst' inherits-from='general_ref_unit'/>
    <class-type type-name='general_ref_unit_cageest' inherits-from='general_ref_unit'/>
    <class-type type-name='general_ref_unit_beateest' inherits-from='general_ref_unit'/>
    <class-type type-name='general_ref_unit_foodreceiverst' inherits-from='general_ref_unit'/>
    <class-type type-name='general_ref_unit_kidnapeest' inherits-from='general_ref_unit'/>
    <class-type type-name='general_ref_unit_patientst' inherits-from='general_ref_unit'/>
    <class-type type-name='general_ref_unit_infantst' inherits-from='general_ref_unit'/>
    <class-type type-name='general_ref_unit_slaughtereest' inherits-from='general_ref_unit'/>
    <class-type type-name='general_ref_unit_sheareest' inherits-from='general_ref_unit'/>
    <class-type type-name='general_ref_unit_suckeest' inherits-from='general_ref_unit'/>
    <class-type type-name='general_ref_unit_reporteest' inherits-from='general_ref_unit'/>
    <class-type type-name='general_ref_unit_riderst' inherits-from='general_ref_unit'/>
    <class-type type-name='general_ref_unit_climberst' inherits-from='general_ref_unit'/>
    <class-type type-name='general_ref_unit_geldeest' inherits-from='general_ref_unit'/>
    <class-type type-name='general_ref_unit_interrogateest' inherits-from='general_ref_unit'/>

    <class-type type-name='general_ref_building_civzone_assignedst' inherits-from='general_ref_building'/>
    <class-type type-name='general_ref_building_triggerst' inherits-from='general_ref_building'/>
    <class-type type-name='general_ref_building_triggertargetst' inherits-from='general_ref_building'/>
    <class-type type-name='general_ref_building_chainst' inherits-from='general_ref_building'/>
    <class-type type-name='general_ref_building_cagedst' inherits-from='general_ref_building'/>
    <class-type type-name='general_ref_building_holderst' inherits-from='general_ref_building'/>
    <class-type type-name='general_ref_building_well_tag' inherits-from='general_ref_building'
                original-name='general_ref_building_well_tagst'>
        <int8_t name='direction'/>
    </class-type>
    <class-type type-name='general_ref_building_use_target_1st' inherits-from='general_ref_building'/>
    <class-type type-name='general_ref_building_use_target_2st' inherits-from='general_ref_building'/>
    <class-type type-name='general_ref_building_destinationst' inherits-from='general_ref_building'/>
    <class-type type-name='general_ref_building_nest_boxst' inherits-from='general_ref_building'/>
    <class-type type-name='general_ref_building_display_furniturest' inherits-from='general_ref_building'/>
    <class-type type-name='general_ref_entity_stolenst' inherits-from='general_ref_entity'/>
    <class-type type-name='general_ref_entity_offeredst' inherits-from='general_ref_entity'/>
    <class-type type-name='general_ref_entity_itemownerst' inherits-from='general_ref_entity'/>

    <enum-type type-name='specific_ref_type'> Bay12: ReferenceType
        <enum-attr name='union_field'/>

        <enum-item name='NONE' value='-1'/>
        <enum-item name='BUILDING'/>
        <enum-item name='UNIT'>
            <item-attr name='union_field' value='unit'/>
        </enum-item>
        <enum-item name='JOB'>
            <item-attr name='union_field' value='job'/>
        </enum-item>
        <enum-item name='ACTIVITY'>
            <item-attr name='union_field' value='activity'/>
        </enum-item>

        <enum-item name='ITEM_GENERAL'>
            <item-attr name='union_field' value='item'/>
        </enum-item>
        <enum-item name='EFFECT'>
            <item-attr name='union_field' value='effect'/>
        </enum-item>
        <enum-item name='VERMIN_EVENT'/>

        <enum-item name='VERMIN_ESCAPED_PET'>
            <item-attr name='union_field' value='vermin'/>
        </enum-item>
        <enum-item name='ENTITY'>
            <item-attr name='union_field' value='entity'/>
        </enum-item>
        <enum-item name='PLOT_INFO'/>
        <enum-item name='VIEWSCREEN'>
            <item-attr name='union_field' value='screen'/>
        </enum-item>
        <enum-item name='UNIT_ITEM_WRESTLE'>
            <item-attr name='union_field' value='wrestle'/>
        </enum-item>

        <enum-item name='NULL_REF'>
            <item-attr name='union_field' value='object'/>
        </enum-item>
        <enum-item name='HIST_FIG'>
            <item-attr name='union_field' value='histfig'/>
        </enum-item>
        <enum-item name='SITE'/>
        <enum-item name='ARTIFACT'/>
        <enum-item name='ITEM_IMPROVEMENT'/>

        <enum-item name='COIN_FRONT'/>
        <enum-item name='COIN_BACK'/>
        <enum-item name='DETAIL_EVENT'/>
        <enum-item name='SUBREGION'/>
        <enum-item name='FEATURE_LAYER'/>

        <enum-item name='ART_IMAGE'/>
        <enum-item name='CREATURE_DEF'/>
        <enum-item name='ENTITY_ART_IMAGE' comment='unused?'/>
        <enum-item name='ABSTRACT_BUILDING'/>
        <enum-item name='ENTITY_POPULATION'/>
        <enum-item name='BREED'/>
    </enum-type>

    <struct-type type-name='specific_ref' original-name='referencest'>
        <enum name='type' base-type='int32_t' type-name='specific_ref_type'/>

        <compound is-union='true' name='data' union-tag-attr='union_field'>
            <pointer name='object' comment='raw pointer'/>
            <pointer name='unit' type-name='unit'/>
            <pointer name='activity' type-name='activity_info'/>
            <pointer name='screen' type-name='viewscreen'/>
            <pointer name='effect' type-name='effect_info'/>
            <pointer name='vermin' type-name='vermin'/>
            <pointer name='job' type-name='job'/>
            <pointer name='histfig' type-name='historical_figure'/>
            <pointer name='entity' type-name='historical_entity'/>
            <compound name='wrestle'>
                <pointer name='unk_1'/>
                <pointer name='item' type-name='unit_item_wrestle'/>
            </compound>
        </compound>
    </struct-type>

    <enum-type type-name='histfig_entity_link_type'>
        <enum-item name='MEMBER'/>
        <enum-item name='FORMER_MEMBER'/>
        <enum-item name='MERCENARY'/>
        <enum-item name='FORMER_MERCENARY'/>
        <enum-item name='SLAVE'/>
        <enum-item name='FORMER_SLAVE'/>
        <enum-item name='PRISONER'/>
        <enum-item name='FORMER_PRISONER'/>
        <enum-item name='ENEMY'/>
        <enum-item name='CRIMINAL'/>
        <enum-item name='POSITION'/>
        <enum-item name='FORMER_POSITION'/>
        <enum-item name='POSITION_CLAIM'/>
        <enum-item name='SQUAD'/>
        <enum-item name='FORMER_SQUAD'/>
        <enum-item name='OCCUPATION'/>
        <enum-item name='FORMER_OCCUPATION'/>
        <enum-item name='RESIDENT'/>
    </enum-type>

    <class-type type-name='histfig_entity_link' original-name='histfig_entity_linkst'>
        <int32_t name='entity_id' ref-target='historical_entity'/>
        <int32_t name='entity_vector_idx' init-value='-1' refers-to='$global.world.entities.all[$]'/>
        <int16_t name='link_strength'/>

        <virtual-methods>
            <vmethod ret-type='histfig_entity_link_type' name='getType'/>
            <vmethod is-destructor='true'/>
            <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/>
            <vmethod/>
            <vmethod ret-type='int32_t' name='getPosition'/>
            <vmethod ret-type='int32_t' name='getOccupation'/>
            <vmethod ret-type='int32_t' name='getPositionStartYear'/>
            <vmethod ret-type='int32_t' name='getPositionEndYear'/>
            <vmethod name='generate_xml'>
                <pointer type-name='stl-fstream'/>
                <int32_t name='indent'/>
            </vmethod>
        </virtual-methods>
    </class-type>

    <class-type type-name='histfig_entity_link_memberst' inherits-from='histfig_entity_link'/>
    <class-type type-name='histfig_entity_link_former_memberst' inherits-from='histfig_entity_link'/>
    <class-type type-name='histfig_entity_link_mercenaryst' inherits-from='histfig_entity_link'/>
    <class-type type-name='histfig_entity_link_former_mercenaryst' inherits-from='histfig_entity_link'/>
    <class-type type-name='histfig_entity_link_slavest' inherits-from='histfig_entity_link'/>
    <class-type type-name='histfig_entity_link_former_slavest' inherits-from='histfig_entity_link'/>
    <class-type type-name='histfig_entity_link_prisonerst' inherits-from='histfig_entity_link'/>
    <class-type type-name='histfig_entity_link_former_prisonerst' inherits-from='histfig_entity_link'/>
    <class-type type-name='histfig_entity_link_enemyst' inherits-from='histfig_entity_link'/>
    <class-type type-name='histfig_entity_link_criminalst' inherits-from='histfig_entity_link'/>
    <class-type type-name='histfig_entity_link_positionst' inherits-from='histfig_entity_link'>
        <int32_t name='assignment_id'
                 refers-to='(find-by-id $$._global.entity_id.ref-target.positions.assignments $id $)'/>
        <int32_t name='assignment_vector_idx' init-value='-1'/>?
        <int32_t name='start_year'/>
    </class-type>
    <class-type type-name='histfig_entity_link_former_positionst' inherits-from='histfig_entity_link'>
        <int32_t name='assignment_id'
                 refers-to='(find-by-id $$._global.entity_id.ref-target.positions.assignments $id $)'/>
        <int32_t name='start_year'/>
        <int32_t name='end_year'/>
    </class-type>
    <class-type type-name='histfig_entity_link_position_claimst' inherits-from='histfig_entity_link'>
        <int32_t name='assignment_id'
                 refers-to='(find-by-id $$._global.entity_id.ref-target.positions.assignments $id $)'/>
        <int32_t name='start_year'/>
    </class-type>
    <class-type type-name='histfig_entity_link_squadst' inherits-from='histfig_entity_link'>
        <int32_t name='squad_id'/>
        <int32_t name='squad_position'/>
        <int32_t name='start_year'/>
    </class-type>
    <class-type type-name='histfig_entity_link_former_squadst' inherits-from='histfig_entity_link'>
        <int32_t name='squad_id'/>
        <int32_t name='start_year'/>
        <int32_t name='end_year'/>
    </class-type>
    <class-type type-name='histfig_entity_link_occupationst' inherits-from='histfig_entity_link'>
        <int32_t name='occupation_id'/>
        <int32_t name='start_year'/>
    </class-type>
    <class-type type-name='histfig_entity_link_former_occupationst' inherits-from='histfig_entity_link'>
        <int32_t name='occupation_id'/>
        <int32_t name='start_year'/>
        <int32_t name='end_year'/>
    </class-type>

    <enum-type type-name='histfig_site_link_type'>
        <enum-item name='OCCUPATION'/>
        <enum-item name='SEAT_OF_POWER'/>
        <enum-item name='HANGOUT'/>
        <enum-item name='HOME_SITE_ABSTRACT_BUILDING'/>
        <enum-item name='HOME_SITE_REALIZATION_BUILDING'/>
        <enum-item name='LAIR'/>
        <enum-item name='HOME_SITE_REALIZATION_SUL'/>
        <enum-item name='HOME_SITE_SAVED_CIVZONE'/>
        <enum-item name='PRISON_ABSTRACT_BUILDING'/>
        <enum-item name='PRISON_SITE_BUILDING_PROFILE'/>
    </enum-type>

    <class-type type-name='histfig_site_link' original-name='histfig_site_linkst'>
        <int32_t name='site' ref-target='world_site'/>
        <int32_t name='sub_id' comment='from XML'/>
        <int32_t name='entity' ref-target='historical_entity'/>
        <virtual-methods>
            <vmethod ret-type='histfig_site_link_type' name='getType'/>
            <vmethod is-destructor='true'/>
            <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='generate_xml'>
                <pointer type-name='stl-fstream'/>
                <int32_t name='indent'/>
            </vmethod>
        </virtual-methods>
    </class-type>

    <class-type type-name='histfig_site_link_occupationst' inherits-from='histfig_site_link'>
        <int32_t name='unk_1'/>
    </class-type>
    <class-type type-name='histfig_site_link_seat_of_powerst' inherits-from='histfig_site_link'/>
    <class-type type-name='histfig_site_link_hangoutst' inherits-from='histfig_site_link'/>
    <class-type type-name='histfig_site_link_home_site_abstract_buildingst' inherits-from='histfig_site_link'/>
    <class-type type-name='histfig_site_link_home_site_realization_buildingst' inherits-from='histfig_site_link'/>
    <class-type type-name='histfig_site_link_lairst' inherits-from='histfig_site_link'/>
    <class-type type-name='histfig_site_link_home_site_realization_sulst' inherits-from='histfig_site_link'/>
    <class-type type-name='histfig_site_link_home_site_saved_civzonest' inherits-from='histfig_site_link'/>
    <class-type type-name='histfig_site_link_prison_abstract_buildingst' inherits-from='histfig_site_link'/>
    <class-type type-name='histfig_site_link_prison_site_building_profilest' inherits-from='histfig_site_link'/>


    <enum-type type-name='histfig_hf_link_type'>
        <enum-item name='MOTHER'/>
        <enum-item name='FATHER'/>
        <enum-item name='SPOUSE'/>
        <enum-item name='CHILD'/>
        <enum-item name='DEITY'/>
        <enum-item name='LOVER'/>
        <enum-item name='PRISONER'/>
        <enum-item name='IMPRISONER'/>
        <enum-item name='MASTER'/>
        <enum-item name='APPRENTICE'/>
        <enum-item name='COMPANION'/>
        <enum-item name='FORMER_MASTER'/>
        <enum-item name='FORMER_APPRENTICE'/>
        <enum-item name='PET_OWNER'/>
        <enum-item name='FORMER_SPOUSE'/>
        <enum-item name='DECEASED_SPOUSE'/>
    </enum-type>

    <class-type type-name='histfig_hf_link' original-name='histfig_hf_linkst'>
        <int32_t name='target_hf' ref-target='historical_figure'/>
        <int16_t name='link_strength'/>

        <virtual-methods>
            <vmethod ret-type='histfig_hf_link_type' name='getType'/>
            <vmethod is-destructor='true'/>
            <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='generate_xml'>
                <pointer type-name='stl-fstream'/>
                <int32_t name='indent'/>
            </vmethod>
        </virtual-methods>
    </class-type>

    <class-type type-name='histfig_hf_link_motherst' inherits-from='histfig_hf_link'/>
    <class-type type-name='histfig_hf_link_fatherst' inherits-from='histfig_hf_link'/>
    <class-type type-name='histfig_hf_link_spousest' inherits-from='histfig_hf_link'/>
    <class-type type-name='histfig_hf_link_childst' inherits-from='histfig_hf_link'/>
    <class-type type-name='histfig_hf_link_deityst' inherits-from='histfig_hf_link'/>
    <class-type type-name='histfig_hf_link_loverst' inherits-from='histfig_hf_link'/>
    <class-type type-name='histfig_hf_link_prisonerst' inherits-from='histfig_hf_link'/>
    <class-type type-name='histfig_hf_link_imprisonerst' inherits-from='histfig_hf_link'/>
    <class-type type-name='histfig_hf_link_masterst' inherits-from='histfig_hf_link'/>
    <class-type type-name='histfig_hf_link_apprenticest' inherits-from='histfig_hf_link'/>
    <class-type type-name='histfig_hf_link_companionst' inherits-from='histfig_hf_link'>
        <int32_t name='unk_1'/>
        <int32_t name='unk_2'/>
    </class-type>
    <class-type type-name='histfig_hf_link_former_apprenticest' inherits-from='histfig_hf_link'/>
    <class-type type-name='histfig_hf_link_former_masterst' inherits-from='histfig_hf_link'/>
    <class-type type-name='histfig_hf_link_pet_ownerst' inherits-from='histfig_hf_link'/>
    <class-type type-name='histfig_hf_link_former_spousest' inherits-from='histfig_hf_link'/>
    <class-type type-name='histfig_hf_link_deceased_spousest' inherits-from='histfig_hf_link'/>

    <enum-type type-name='entity_entity_link_type' base-type='int16_t'>
        <enum-item name='PARENT'/>
        <enum-item name='CHILD'/>
        <enum-item name='RELIGIOUS' comment='Seen between religion and merc company.' since='v0.47.01'/>
    </enum-type>

    <struct-type type-name='entity_entity_link'>
        <enum base-type='int16_t' type-name='entity_entity_link_type' name='type'/>
        <int32_t name='target' ref-target='historical_entity'/>
        <int16_t name='strength'/>
    </struct-type>

    <enum-type type-name='entity_site_link_type' base-type='int32_t' comment="Enum names updated per Putnam">
            Mostly guesswork, hence the 'research notes' below. Interacts highly with status
            Putnam has provided us with some source details, so enum names have been amended to match what she provided
        <enum-item name='None' value='-1'/>
            Probably inactive/failed/NA. Seen with status = 0/2/8/16/128/144/8192. Entities Civilization/SiteGovernment/NomadicGroup/Outcast (not all value/entity permutations)
        <enum-item name='All'/>
            Civilization: status = 0 if any flags set and status = 2 if not, with the exception of "fortress" that can be set in either case. capital, monument, reclaim, and land_for_holding flags seen.
            does not seem to indicate clearly whether the site is owned currently. Note that civs don't have links to most of its sites, as it normally goes via site governments.
            SiteGovernment: flags.residence => status = 0. No flags set with any other status value. Thus, SiteGovernment/type=Claim/status=0 probably means it's the current official local government.
            NomadicGroup: flags.residence => status = 0. Probably official local government (mostly Camp). Other status values (1/129) have no flags set.
            Religion: all were Fortress (and had that flag) and had status = 0. Thus, probably civ level "owner", as the monasteries seem to have local site governments.
            MilitaryUnit: residence+fortress flags => status = 0 and owner (with no local site government). status = 5 and no flags set was the alternative seen.
            Outcast: flags.residence => status = 0 and local government. Alternative seen is status = 1 and no flags set.
        <enum-item name='Inside_Wall'/>
        <enum-item name='Outside_Wall'/>
            NomadicGroup/SiteGovernment, all with criminal_gang flag set and status = 0. Can also be found with None (failed/inactive?). Connection usually not mentioned anywhere.
        <enum-item name='Outskirts'/>
        <enum-item name='Local_Activity'/>
            Religion: All have status = 0. At least one of the residence and base_of_operation flags set.
            Outcast: status = 0 => flag residence and/or base_of_operation. Reverse not true. Assume status = 0 still active, with 2, 3, 131, 195 being failures.
            MerchantCompany: All have status = 0 and the capital flag set. Some also have base_of_operations.
            Guild: All have status = 0 and the capital flag set.
    </enum-type>

    <bitfield-type type-name='entity_site_link_flags' base-type='uint32_t'>
        <flag-bit name='residence'             comment='site is residence'/>
        <flag-bit name='capital'               comment='site is capital'/>
        <flag-bit name='fortress'              comment='used at least by those castles which arent currently in'/>
        <flag-bit name='local_market'          comment='for villages to think about their market town'/>
        <flag-bit name='trade_partner'         comment='for markets to think about other markets'/>
        <flag-bit name='monument'              comment='for a civ to know its tomb sites'/>
        <flag-bit name='primary_criminal_gang'/>
        <flag-bit name='criminal_gang'        />
        <flag-bit name='invasion_marked'       comment='marked for invasion'/>
        <flag-bit name='land_for_holding'      comment='all regular sites get this if civ has nobles, whether they have a noble or not (reclaim and capital (can be?) excluded, as can "slow repopulation" by civ group)'/>
        <flag-bit name='central_holding_land'  comment='only dwarf fortresses get this for now'/>
        <flag-bit name='land_holder_residence' comment='the regular sites where a baron etc. actually lives'/>
        <flag-bit name='invasion_push_out'     comment='pushed out by invasion'/>
        <flag-bit name='reclaim'               comment='marked for reclaim'/>
        <flag-bit name='occupation_failed'     comment='failed to hold hostile occupation'/>
        <flag-bit name='base_of_operation'     comment='set for some Religions, Criminals, and Merchant Companies. The function is largely a guess. Persecution, founding seen, as well as no mentioning of a relation at all in exported legends'/>
        <flag-bit name='holy_city'             comment='for the holy city of a religion'/>
    </bitfield-type>

    <struct-type type-name='entity_site_link'> toady's name for this is entity_site_profilest
        <int32_t name="target" ref-target='world_site'/> this is a union in toady code but we can probably ignore that per putnam
        <int32_t name="entity_id" ref-target='historical_entity'/>
        <int32_t name="entity_cache_index" comment="not saved"/>
        <int32_t name='position_profile_id' init-value='-1' comment="index into entity.positions.assignments of Civilization (?)"/>
        <enum name='type' type-name='entity_site_link_type' base-type='int32_t' comment="called location in df source"/>
        <int32_t name='start_hr' init-value='-1'/>
        <int32_t name='end_hr' init-value='-1'/>
        <bitfield name='flags' type-name='entity_site_link_flags'/>
        <bitfield name='former_flag' type-name='entity_site_link_flags'/>
          Summary: 0 seems to be active, 1, 2, 3, 5, 131, various cessations of activity. 8, 16, 128, 144, 8192 something unrelated, and the 129, 195 possible cessations"
          0: Civilization/SiteGovernment/NomadicGroup/Religion/Outcast/MerchantCompany/Guild. Seems to be 'Active'. Civ can have 'Active' claim on site not held, while others seem to be currently active.
          1: SiteGovernment/NomadicGroup/Outcast. Seems to be defeated and losing presence at the site. Nomads/Outcasts might not have been the masters of the site as single rampage can cause enmity of two entities.
          2: Civilization: type = None/Active, (failed to find difference). All sites seen were either destroyed or abandoned, can be reclaimed, but without that flag set. No flags set except a possible 'fortress'. Note that no conquest was seen.
             Outcast: type = Local_Activity. All have criminal flags. Some may have indications of having left, but some don't...
          3: Outcast, all with type = Local_Activity. All seen were fully incorporated into other criminal gangs.
          5: SiteGovernment/MilitaryUnit. All Fortress. All type = Claim. SiteGovernment just replaced w/o event. MercenaryCompay abandoned or were replaced silently, and no flags set.
          8: All SiteGovernment with type = None. Seems to be references to SiteGovernments without any known relations. No flags set.
          16: SiteGovernment/NomadicGroup with type = None. Seems to be references to entities without any known relations. No flags set.
          128: SiteGovernment/NomadicGroup/Outcast with type = None. Seems to be references to entities without any known relations. No flags set.
          129: NomadicGroup settling in destroyed site/site horribly experimented on, being present silently, and site getting destroyed again. type = Claim.
          131: Outcast, type = Local_Activity. No flags. All relocated to site location, typically catacombs. All fully incorporated into other organization, as per 3.
          144: NomadicGroup (only one entry). type = None. No flags. No apparent connection.
          195: Outcast (only 2 entries). type = Local_Activity. No flags. Both moved to inn and became primary criminal org. One had lots of members moving from the inn. Different site destroyed in both cases. No incorporation seen, though.
          8192: Civilization/SiteGovernment. type = None. No flags. No apparent connection.

          former_flag is an accumulation of every flag the entity has ever had, any operation that clears part of flag also adds that flag to former_flag
        <int32_t name="link_strength" init-value='100'/>
        <int32_t name='initial_controlling_population' init-value='0' comment="all non zero cases are SiteGovernments with type = Claim, status = 0, and flags.residence = true. All examined were formed as forced administrations"/>
        <int32_t name='last_check_controlling_population' init-value='0' comment="same value as previous field"/>
        the above are related to army.squads in some way
        <stl-vector name='ab_profile' comment="When a single element the first value makes sense as an abstract building related to the entity, but longer lists do not, including numbers larger than the number of abstract buildings">
            <pointer>
                <int32_t name='unk_1' init-value='-1'/>
                <int32_t name='unk_2' comment="1, 2, 5 seen"/>
            </pointer>
        </stl-vector>
        <int32_t name='target_site_x' comment='target site world coordinate x'/>
        <int32_t name='target_site_y' comment='target site world coordinate y'/>
        <int32_t name='last_checked_army_year' init-value='-1' since='v0.43.01' comment="all cases seen were NomadicGroup with criminal_gang flag set, unk_4 = 0 and type = Foreign_Crime, except for cases with type = Claim and residence flag set as well"/>
        <int32_t name='last_checked_army_year_tick' init-value='-1' since='v0.43.01' comment="paired with the previous field. Could be year/year_tick pair set to the start of play for all of these as all have the same number pair in the same save"/>
    </struct-type>

    <bitfield-type type-name='undead_flags' base-type='uint16_t'>
        <flag-bit name='zombie'/>
        <flag-bit name='ghostly'/>
    </bitfield-type>
</data-definition>

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