.. _structures.refs:

####
refs
####

.. _structures.refs.general_ref_type:

refs.general_ref_type
=====================

.. code-block:: xml

    <enum-type type-name="general_ref_type">
      <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-type>

.. _structures.refs.general_ref:

refs.general_ref
================

.. code-block:: xml

    <class-type type-name="general_ref" original-name="general_refst">
      <virtual-methods>
        <vmethod name="write_file">
          <pointer name="file" type-name="file_compressorst"/>
        </vmethod>
        <vmethod name="read_file">
          <pointer name="file" type-name="file_compressorst"/>
          <int32_t name="loadversion"/>
        </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>
        <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>
        <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/>
          <int32_t/>
          <int32_t/>
        </vmethod>
        <vmethod name="getLocation">
          <pointer type-name="int32_t"/>
          <pointer type-name="int32_t"/>
          <pointer type-name="int32_t"/>
        </vmethod>
        <vmethod is-destructor="true"/>
        <vmethod name="clone">
          <ret-type>
            <pointer type-name="general_ref"/>
          </ret-type>
        </vmethod>
        <vmethod>
          <int32_t/>
          <pointer type-name="stl-string"/>
        </vmethod>
        <vmethod name="getDescription">
          <pointer name="str" type-name="stl-string"/>
        </vmethod>
        <vmethod name="getDescription2">
          <pointer name="str" type-name="stl-string"/>
        </vmethod>
        <vmethod name="getDescription3">
          <pointer name="str" type-name="stl-string"/>
          for scholar flags
        </vmethod>
      </virtual-methods>
    </class-type>

.. _structures.refs.general_ref_artifact:

refs.general_ref_artifact
=========================

.. code-block:: xml

    <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>

.. _structures.refs.general_ref_nemesis:

refs.general_ref_nemesis
========================

.. code-block:: xml

    <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>

.. _structures.refs.general_ref_item:

refs.general_ref_item
=====================

.. code-block:: xml

    <class-type type-name="general_ref_item" inherits-from="general_ref" 
        original-name="general_ref_itemst">
      <int32_t name="item_id" ref-target="item"/>
    </class-type>

.. _structures.refs.general_ref_item_type:

refs.general_ref_item_type
==========================

.. code-block:: xml

    <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>

.. _structures.refs.general_ref_coinbatch:

refs.general_ref_coinbatch
==========================

.. code-block:: xml

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

.. _structures.refs.general_ref_mapsquare:

refs.general_ref_mapsquare
==========================

.. code-block:: xml

    <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>

.. _structures.refs.general_ref_entity_art_image:

refs.general_ref_entity_art_image
=================================

.. code-block:: xml

    <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">
        lookup in entity.resources.art_image_*
      </int32_t>
    </class-type>

.. _structures.refs.general_ref_projectile:

refs.general_ref_projectile
===========================

.. code-block:: xml

    <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>

.. _structures.refs.general_ref_unit:

refs.general_ref_unit
=====================

.. code-block:: xml

    <class-type type-name="general_ref_unit" inherits-from="general_ref" 
        original-name="general_ref_unitst">
      <int32_t name="unit_id" ref-target="unit"/>
    </class-type>

.. _structures.refs.general_ref_building:

refs.general_ref_building
=========================

.. code-block:: xml

    <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>

.. _structures.refs.general_ref_entity:

refs.general_ref_entity
=======================

.. code-block:: xml

    <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>

.. _structures.refs.general_ref_locationst:

refs.general_ref_locationst
===========================

.. code-block:: xml

    <class-type type-name="general_ref_locationst" 
        inherits-from="general_ref">
      <int32_t/>
      <int32_t/>
      <int32_t/>
    </class-type>

.. _structures.refs.general_ref_interactionst:

refs.general_ref_interactionst
==============================

.. code-block:: xml

    <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>

.. _structures.refs.general_ref_abstract_buildingst:

refs.general_ref_abstract_buildingst
====================================

.. code-block:: xml

    <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>

.. _structures.refs.general_ref_historical_eventst:

refs.general_ref_historical_eventst
===================================

.. code-block:: xml

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

.. _structures.refs.general_ref_spherest:

refs.general_ref_spherest
=========================

.. code-block:: xml

    <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>

.. _structures.refs.general_ref_sitest:

refs.general_ref_sitest
=======================

.. code-block:: xml

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

.. _structures.refs.general_ref_subregionst:

refs.general_ref_subregionst
============================

.. code-block:: xml

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

.. _structures.refs.general_ref_feature_layerst:

refs.general_ref_feature_layerst
================================

.. code-block:: xml

    <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>

.. _structures.refs.general_ref_historical_figurest:

refs.general_ref_historical_figurest
====================================

.. code-block:: xml

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

.. _structures.refs.general_ref_entity_popst:

refs.general_ref_entity_popst
=============================

.. code-block:: xml

    <class-type type-name="general_ref_entity_popst" 
        inherits-from="general_ref">
      <int32_t/>
      <int32_t name="race" ref-target="creature_raw"/>
      <int32_t/>
      <bitfield name="flags">
        <flag-bit name="animated_corpse"/>
        <flag-bit name="ghostly"/>
      </bitfield>
    </class-type>

.. _structures.refs.general_ref_creaturest:

refs.general_ref_creaturest
===========================

.. code-block:: xml

    <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/>
      <int32_t/>
      <bitfield name="flags">
        <flag-bit name="animated_corpse"/>
        <flag-bit name="ghostly"/>
      </bitfield>
    </class-type>

.. _structures.refs.general_ref_knowledge_scholar_flagst:

refs.general_ref_knowledge_scholar_flagst
=========================================

.. code-block:: xml

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

.. _structures.refs.general_ref_activity_eventst:

refs.general_ref_activity_eventst
=================================

.. code-block:: xml

    <class-type type-name="general_ref_activity_eventst" 
        inherits-from="general_ref">
      <int32_t/>
      <int32_t/>
    </class-type>

.. _structures.refs.general_ref_value_levelst:

refs.general_ref_value_levelst
==============================

.. code-block:: xml

    <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">
        see 
        http://dwarffortresswiki.org/index.php/DF2014:Personality_trait
      </int32_t>
    </class-type>

.. _structures.refs.general_ref_languagest:

refs.general_ref_languagest
===========================

.. code-block:: xml

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

.. _structures.refs.general_ref_written_contentst:

refs.general_ref_written_contentst
==================================

.. code-block:: xml

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

.. _structures.refs.general_ref_poetic_formst:

refs.general_ref_poetic_formst
==============================

.. code-block:: xml

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

.. _structures.refs.general_ref_musical_formst:

refs.general_ref_musical_formst
===============================

.. code-block:: xml

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

.. _structures.refs.general_ref_dance_formst:

refs.general_ref_dance_formst
=============================

.. code-block:: xml

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

.. _structures.refs.general_ref_is_artifactst:

refs.general_ref_is_artifactst
==============================

.. code-block:: xml

    <class-type type-name="general_ref_is_artifactst" 
        inherits-from="general_ref_artifact"/>

.. _structures.refs.general_ref_is_nemesisst:

refs.general_ref_is_nemesisst
=============================

.. code-block:: xml

    <class-type type-name="general_ref_is_nemesisst" 
        inherits-from="general_ref_nemesis"/>

.. _structures.refs.general_ref_contains_unitst:

refs.general_ref_contains_unitst
================================

.. code-block:: xml

    <class-type type-name="general_ref_contains_unitst" 
        inherits-from="general_ref_unit"/>

.. _structures.refs.general_ref_contains_itemst:

refs.general_ref_contains_itemst
================================

.. code-block:: xml

    <class-type type-name="general_ref_contains_itemst" 
        inherits-from="general_ref_item"/>

.. _structures.refs.general_ref_contained_in_itemst:

refs.general_ref_contained_in_itemst
====================================

.. code-block:: xml

    <class-type type-name="general_ref_contained_in_itemst" 
        inherits-from="general_ref_item"/>

.. _structures.refs.general_ref_unit_milkeest:

refs.general_ref_unit_milkeest
==============================

.. code-block:: xml

    <class-type type-name="general_ref_unit_milkeest" 
        inherits-from="general_ref_unit"/>

.. _structures.refs.general_ref_unit_traineest:

refs.general_ref_unit_traineest
===============================

.. code-block:: xml

    <class-type type-name="general_ref_unit_traineest" 
        inherits-from="general_ref_unit"/>

.. _structures.refs.general_ref_unit_itemownerst:

refs.general_ref_unit_itemownerst
=================================

.. code-block:: xml

    <class-type type-name="general_ref_unit_itemownerst" 
        inherits-from="general_ref_unit">
      <bitfield name="flags">
        <flag-bit name="litter">
          apparetly set after 1000 ticks, then confiscated in 1000 more 
          ticks
        </flag-bit>
        v0.34.06
      </bitfield>
    </class-type>

.. _structures.refs.general_ref_unit_tradebringerst:

refs.general_ref_unit_tradebringerst
====================================

.. code-block:: xml

    <class-type type-name="general_ref_unit_tradebringerst" 
        inherits-from="general_ref_unit"/>

.. _structures.refs.general_ref_unit_holderst:

refs.general_ref_unit_holderst
==============================

.. code-block:: xml

    <class-type type-name="general_ref_unit_holderst" 
        inherits-from="general_ref_unit"/>

.. _structures.refs.general_ref_unit_workerst:

refs.general_ref_unit_workerst
==============================

.. code-block:: xml

    <class-type type-name="general_ref_unit_workerst" 
        inherits-from="general_ref_unit"/>

.. _structures.refs.general_ref_unit_cageest:

refs.general_ref_unit_cageest
=============================

.. code-block:: xml

    <class-type type-name="general_ref_unit_cageest" 
        inherits-from="general_ref_unit"/>

.. _structures.refs.general_ref_unit_beateest:

refs.general_ref_unit_beateest
==============================

.. code-block:: xml

    <class-type type-name="general_ref_unit_beateest" 
        inherits-from="general_ref_unit"/>

.. _structures.refs.general_ref_unit_foodreceiverst:

refs.general_ref_unit_foodreceiverst
====================================

.. code-block:: xml

    <class-type type-name="general_ref_unit_foodreceiverst" 
        inherits-from="general_ref_unit"/>

.. _structures.refs.general_ref_unit_kidnapeest:

refs.general_ref_unit_kidnapeest
================================

.. code-block:: xml

    <class-type type-name="general_ref_unit_kidnapeest" 
        inherits-from="general_ref_unit"/>

.. _structures.refs.general_ref_unit_patientst:

refs.general_ref_unit_patientst
===============================

.. code-block:: xml

    <class-type type-name="general_ref_unit_patientst" 
        inherits-from="general_ref_unit"/>

.. _structures.refs.general_ref_unit_infantst:

refs.general_ref_unit_infantst
==============================

.. code-block:: xml

    <class-type type-name="general_ref_unit_infantst" 
        inherits-from="general_ref_unit"/>

.. _structures.refs.general_ref_unit_slaughtereest:

refs.general_ref_unit_slaughtereest
===================================

.. code-block:: xml

    <class-type type-name="general_ref_unit_slaughtereest" 
        inherits-from="general_ref_unit"/>

.. _structures.refs.general_ref_unit_sheareest:

refs.general_ref_unit_sheareest
===============================

.. code-block:: xml

    <class-type type-name="general_ref_unit_sheareest" 
        inherits-from="general_ref_unit"/>

.. _structures.refs.general_ref_unit_suckeest:

refs.general_ref_unit_suckeest
==============================

.. code-block:: xml

    <class-type type-name="general_ref_unit_suckeest" 
        inherits-from="general_ref_unit"/>

.. _structures.refs.general_ref_unit_reporteest:

refs.general_ref_unit_reporteest
================================

.. code-block:: xml

    <class-type type-name="general_ref_unit_reporteest" 
        inherits-from="general_ref_unit"/>

.. _structures.refs.general_ref_unit_riderst:

refs.general_ref_unit_riderst
=============================

.. code-block:: xml

    <class-type type-name="general_ref_unit_riderst" 
        inherits-from="general_ref_unit"/>

.. _structures.refs.general_ref_unit_climberst:

refs.general_ref_unit_climberst
===============================

.. code-block:: xml

    <class-type type-name="general_ref_unit_climberst" 
        inherits-from="general_ref_unit"/>

.. _structures.refs.general_ref_unit_geldeest:

refs.general_ref_unit_geldeest
==============================

.. code-block:: xml

    <class-type type-name="general_ref_unit_geldeest" 
        inherits-from="general_ref_unit"/>

.. _structures.refs.general_ref_building_civzone_assignedst:

refs.general_ref_building_civzone_assignedst
============================================

.. code-block:: xml

    <class-type type-name="general_ref_building_civzone_assignedst" 
        inherits-from="general_ref_building"/>

.. _structures.refs.general_ref_building_triggerst:

refs.general_ref_building_triggerst
===================================

.. code-block:: xml

    <class-type type-name="general_ref_building_triggerst" 
        inherits-from="general_ref_building"/>

.. _structures.refs.general_ref_building_triggertargetst:

refs.general_ref_building_triggertargetst
=========================================

.. code-block:: xml

    <class-type type-name="general_ref_building_triggertargetst" 
        inherits-from="general_ref_building"/>

.. _structures.refs.general_ref_building_chainst:

refs.general_ref_building_chainst
=================================

.. code-block:: xml

    <class-type type-name="general_ref_building_chainst" 
        inherits-from="general_ref_building"/>

.. _structures.refs.general_ref_building_cagedst:

refs.general_ref_building_cagedst
=================================

.. code-block:: xml

    <class-type type-name="general_ref_building_cagedst" 
        inherits-from="general_ref_building"/>

.. _structures.refs.general_ref_building_holderst:

refs.general_ref_building_holderst
==================================

.. code-block:: xml

    <class-type type-name="general_ref_building_holderst" 
        inherits-from="general_ref_building"/>

.. _structures.refs.general_ref_building_well_tag:

refs.general_ref_building_well_tag
==================================

.. code-block:: xml

    <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>

.. _structures.refs.general_ref_building_use_target_1st:

refs.general_ref_building_use_target_1st
========================================

.. code-block:: xml

    <class-type type-name="general_ref_building_use_target_1st" 
        inherits-from="general_ref_building"/>

.. _structures.refs.general_ref_building_use_target_2st:

refs.general_ref_building_use_target_2st
========================================

.. code-block:: xml

    <class-type type-name="general_ref_building_use_target_2st" 
        inherits-from="general_ref_building"/>

.. _structures.refs.general_ref_building_destinationst:

refs.general_ref_building_destinationst
=======================================

.. code-block:: xml

    <class-type type-name="general_ref_building_destinationst" 
        inherits-from="general_ref_building"/>

.. _structures.refs.general_ref_building_nest_boxst:

refs.general_ref_building_nest_boxst
====================================

.. code-block:: xml

    <class-type type-name="general_ref_building_nest_boxst" 
        inherits-from="general_ref_building"/>

.. _structures.refs.general_ref_entity_stolenst:

refs.general_ref_entity_stolenst
================================

.. code-block:: xml

    <class-type type-name="general_ref_entity_stolenst" 
        inherits-from="general_ref_entity"/>

.. _structures.refs.general_ref_entity_offeredst:

refs.general_ref_entity_offeredst
=================================

.. code-block:: xml

    <class-type type-name="general_ref_entity_offeredst" 
        inherits-from="general_ref_entity"/>

.. _structures.refs.general_ref_entity_itemownerst:

refs.general_ref_entity_itemownerst
===================================

.. code-block:: xml

    <class-type type-name="general_ref_entity_itemownerst" 
        inherits-from="general_ref_entity"/>

.. _structures.refs.specific_ref_type:

refs.specific_ref_type
======================

.. code-block:: xml

    <enum-type type-name="specific_ref_type">
      <enum-item/>
      <enum-item name="UNIT_INVENTORY"/>
      <enum-item name="JOB"/>
      <enum-item name="BUILDING_PARTY"/>
      <enum-item name="ACTIVITY"/>
      <enum-item name="ITEM_GENERAL"/>
      <enum-item name="EFFECT"/>
      <enum-item name="PETINFO_PET">
        unused
      </enum-item>
      <enum-item name="PETINFO_OWNER">
        unused
      </enum-item>
      <enum-item name="VERMIN_EVENT"/>
      <enum-item name="VERMIN_ESCAPED_PET"/>
      <enum-item name="ENTITY"/>
      <enum-item name="PLOT_INFO"/>
      <enum-item name="VIEWSCREEN"/>
      <enum-item name="UNIT_ITEM_WRESTLE"/>
      <enum-item name="NULL_REF"/>
      <enum-item name="HIST_FIG"/>
      <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/>
      <enum-item/>
      <enum-item name="ENTITY_POPULATION"/>
      <enum-item name="BREED"/>
    </enum-type>

.. _structures.refs.specific_ref:

refs.specific_ref
=================

.. code-block:: xml

    <struct-type type-name="specific_ref">
      <enum name="type" base-type="int32_t" 
          type-name="specific_ref_type"/>
      <compound is-union="true">
        <pointer name="object"/>
        <pointer name="unit" type-name="unit"/>
        <pointer name="activity" type-name="activity_info"/>
        <pointer name="screen" type-name="viewscreen"/>
        <pointer name="vermin" type-name="vermin"/>
        <pointer name="effect" type-name="effect_info"/>
        <pointer name="job" type-name="job"/>
      </compound>
      <compound is-union="true" name="arg2">
        <pointer name="wrestle" type-name="unit_item_wrestle"/>
      </compound>
    </struct-type>

.. _structures.refs.histfig_entity_link_type:

refs.histfig_entity_link_type
=============================

.. code-block:: xml

    <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-type>

.. _structures.refs.histfig_entity_link:

refs.histfig_entity_link
========================

.. code-block:: xml

    <class-type type-name="histfig_entity_link" 
        original-name="histfig_entity_linkst">
      <int32_t name="entity_id" ref-target="historical_entity"/>
      <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"/>
          <int32_t name="loadversion"/>
        </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/>
          <pointer/>
        </vmethod>
      </virtual-methods>
    </class-type>

.. _structures.refs.histfig_entity_link_memberst:

refs.histfig_entity_link_memberst
=================================

.. code-block:: xml

    <class-type type-name="histfig_entity_link_memberst" 
        inherits-from="histfig_entity_link"/>

.. _structures.refs.histfig_entity_link_former_memberst:

refs.histfig_entity_link_former_memberst
========================================

.. code-block:: xml

    <class-type type-name="histfig_entity_link_former_memberst" 
        inherits-from="histfig_entity_link"/>

.. _structures.refs.histfig_entity_link_mercenaryst:

refs.histfig_entity_link_mercenaryst
====================================

.. code-block:: xml

    <class-type type-name="histfig_entity_link_mercenaryst" 
        inherits-from="histfig_entity_link"/>

.. _structures.refs.histfig_entity_link_former_mercenaryst:

refs.histfig_entity_link_former_mercenaryst
===========================================

.. code-block:: xml

    <class-type type-name="histfig_entity_link_former_mercenaryst" 
        inherits-from="histfig_entity_link"/>

.. _structures.refs.histfig_entity_link_slavest:

refs.histfig_entity_link_slavest
================================

.. code-block:: xml

    <class-type type-name="histfig_entity_link_slavest" 
        inherits-from="histfig_entity_link"/>

.. _structures.refs.histfig_entity_link_former_slavest:

refs.histfig_entity_link_former_slavest
=======================================

.. code-block:: xml

    <class-type type-name="histfig_entity_link_former_slavest" 
        inherits-from="histfig_entity_link"/>

.. _structures.refs.histfig_entity_link_prisonerst:

refs.histfig_entity_link_prisonerst
===================================

.. code-block:: xml

    <class-type type-name="histfig_entity_link_prisonerst" 
        inherits-from="histfig_entity_link"/>

.. _structures.refs.histfig_entity_link_former_prisonerst:

refs.histfig_entity_link_former_prisonerst
==========================================

.. code-block:: xml

    <class-type type-name="histfig_entity_link_former_prisonerst" 
        inherits-from="histfig_entity_link"/>

.. _structures.refs.histfig_entity_link_enemyst:

refs.histfig_entity_link_enemyst
================================

.. code-block:: xml

    <class-type type-name="histfig_entity_link_enemyst" 
        inherits-from="histfig_entity_link"/>

.. _structures.refs.histfig_entity_link_criminalst:

refs.histfig_entity_link_criminalst
===================================

.. code-block:: xml

    <class-type type-name="histfig_entity_link_criminalst" 
        inherits-from="histfig_entity_link"/>

.. _structures.refs.histfig_entity_link_positionst:

refs.histfig_entity_link_positionst
===================================

.. code-block:: xml

    <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="start_year"/>
    </class-type>

.. _structures.refs.histfig_entity_link_former_positionst:

refs.histfig_entity_link_former_positionst
==========================================

.. code-block:: xml

    <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>

.. _structures.refs.histfig_entity_link_position_claimst:

refs.histfig_entity_link_position_claimst
=========================================

.. code-block:: xml

    <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>

.. _structures.refs.histfig_entity_link_squadst:

refs.histfig_entity_link_squadst
================================

.. code-block:: xml

    <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>

.. _structures.refs.histfig_entity_link_former_squadst:

refs.histfig_entity_link_former_squadst
=======================================

.. code-block:: xml

    <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>

.. _structures.refs.histfig_entity_link_occupationst:

refs.histfig_entity_link_occupationst
=====================================

.. code-block:: xml

    <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>

.. _structures.refs.histfig_entity_link_former_occupationst:

refs.histfig_entity_link_former_occupationst
============================================

.. code-block:: xml

    <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>

.. _structures.refs.histfig_site_link_type:

refs.histfig_site_link_type
===========================

.. code-block:: xml

    <enum-type type-name="histfig_site_link_type">
      <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-type>

.. _structures.refs.histfig_site_link:

refs.histfig_site_link
======================

.. code-block:: xml

    <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">
        from XML
      </int32_t>
      <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"/>
          <int32_t name="loadversion"/>
        </vmethod>
        <vmethod>
          <pointer/>
          <pointer/>
          generate_xml
        </vmethod>
      </virtual-methods>
    </class-type>

.. _structures.refs.histfig_site_link_seat_of_powerst:

refs.histfig_site_link_seat_of_powerst
======================================

.. code-block:: xml

    <class-type type-name="histfig_site_link_seat_of_powerst" 
        inherits-from="histfig_site_link"/>

.. _structures.refs.histfig_site_link_hangoutst:

refs.histfig_site_link_hangoutst
================================

.. code-block:: xml

    <class-type type-name="histfig_site_link_hangoutst" 
        inherits-from="histfig_site_link"/>

.. _structures.refs.histfig_site_link_home_site_abstract_buildingst:

refs.histfig_site_link_home_site_abstract_buildingst
====================================================

.. code-block:: xml

    <class-type 
        type-name="histfig_site_link_home_site_abstract_buildingst" 
        inherits-from="histfig_site_link"/>

.. _structures.refs.histfig_site_link_home_site_realization_buildingst:

refs.histfig_site_link_home_site_realization_buildingst
=======================================================

.. code-block:: xml

    <class-type 
        type-name="histfig_site_link_home_site_realization_buildingst" 
        inherits-from="histfig_site_link"/>

.. _structures.refs.histfig_site_link_lairst:

refs.histfig_site_link_lairst
=============================

.. code-block:: xml

    <class-type type-name="histfig_site_link_lairst" 
        inherits-from="histfig_site_link"/>

.. _structures.refs.histfig_site_link_home_site_realization_sulst:

refs.histfig_site_link_home_site_realization_sulst
==================================================

.. code-block:: xml

    <class-type type-name="histfig_site_link_home_site_realization_sulst" 
        inherits-from="histfig_site_link"/>

.. _structures.refs.histfig_hf_link_type:

refs.histfig_hf_link_type
=========================

.. code-block:: xml

    <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-type>

.. _structures.refs.histfig_hf_link:

refs.histfig_hf_link
====================

.. code-block:: xml

    <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"/>
          <int32_t name="loadversion"/>
        </vmethod>
        <vmethod>
          <pointer/>
          <pointer/>
          generate_xml
        </vmethod>
      </virtual-methods>
    </class-type>

.. _structures.refs.histfig_hf_link_motherst:

refs.histfig_hf_link_motherst
=============================

.. code-block:: xml

    <class-type type-name="histfig_hf_link_motherst" 
        inherits-from="histfig_hf_link"/>

.. _structures.refs.histfig_hf_link_fatherst:

refs.histfig_hf_link_fatherst
=============================

.. code-block:: xml

    <class-type type-name="histfig_hf_link_fatherst" 
        inherits-from="histfig_hf_link"/>

.. _structures.refs.histfig_hf_link_spousest:

refs.histfig_hf_link_spousest
=============================

.. code-block:: xml

    <class-type type-name="histfig_hf_link_spousest" 
        inherits-from="histfig_hf_link"/>

.. _structures.refs.histfig_hf_link_childst:

refs.histfig_hf_link_childst
============================

.. code-block:: xml

    <class-type type-name="histfig_hf_link_childst" 
        inherits-from="histfig_hf_link"/>

.. _structures.refs.histfig_hf_link_deityst:

refs.histfig_hf_link_deityst
============================

.. code-block:: xml

    <class-type type-name="histfig_hf_link_deityst" 
        inherits-from="histfig_hf_link"/>

.. _structures.refs.histfig_hf_link_loverst:

refs.histfig_hf_link_loverst
============================

.. code-block:: xml

    <class-type type-name="histfig_hf_link_loverst" 
        inherits-from="histfig_hf_link"/>

.. _structures.refs.histfig_hf_link_prisonerst:

refs.histfig_hf_link_prisonerst
===============================

.. code-block:: xml

    <class-type type-name="histfig_hf_link_prisonerst" 
        inherits-from="histfig_hf_link"/>

.. _structures.refs.histfig_hf_link_imprisonerst:

refs.histfig_hf_link_imprisonerst
=================================

.. code-block:: xml

    <class-type type-name="histfig_hf_link_imprisonerst" 
        inherits-from="histfig_hf_link"/>

.. _structures.refs.histfig_hf_link_masterst:

refs.histfig_hf_link_masterst
=============================

.. code-block:: xml

    <class-type type-name="histfig_hf_link_masterst" 
        inherits-from="histfig_hf_link"/>

.. _structures.refs.histfig_hf_link_apprenticest:

refs.histfig_hf_link_apprenticest
=================================

.. code-block:: xml

    <class-type type-name="histfig_hf_link_apprenticest" 
        inherits-from="histfig_hf_link"/>

.. _structures.refs.histfig_hf_link_companionst:

refs.histfig_hf_link_companionst
================================

.. code-block:: xml

    <class-type type-name="histfig_hf_link_companionst" 
        inherits-from="histfig_hf_link">
      <int32_t/>
      <int32_t/>
    </class-type>

.. _structures.refs.entity_entity_link_type:

refs.entity_entity_link_type
============================

.. code-block:: xml

    <enum-type type-name="entity_entity_link_type" base-type="int16_t">
      <enum-item name="PARENT"/>
      <enum-item name="CHILD"/>
    </enum-type>

.. _structures.refs.entity_entity_link:

refs.entity_entity_link
=======================

.. code-block:: xml

    <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>

.. _structures.refs.entity_site_link:

refs.entity_site_link
=====================

.. code-block:: xml

    <struct-type type-name="entity_site_link">
      <int32_t name="target" ref-target="world_site">
        world.world_data.sites vector
      </int32_t>
      <int32_t name="entity_id" ref-target="historical_entity"/>
      <int32_t/>
      <int32_t/>
      <int32_t/>
      <int32_t/>
      <bitfield name="flags" base-type="uint32_t">
        <flag-bit name="residence">
          site is residence
        </flag-bit>
        <flag-bit name="capital">
          site is capital
        </flag-bit>
        <flag-bit name="fortress">
          used at least by those castles which arent currently in
        </flag-bit>
        <flag-bit name="local_market">
          for villages to think about their market town
        </flag-bit>
        <flag-bit name="trade_partner">
          for markets to think about other markets
        </flag-bit>
        <flag-bit name="monument">
          for a civ to know its tomb sites
        </flag-bit>
        <flag-bit name="primary_criminal_gang"/>
        <flag-bit name="criminal_gang"/>
        <flag-bit name="invasion_marked">
          marked for invasion
        </flag-bit>
        <flag-bit name="land_for_holding">
          all regular sites get this if civ has nobles, whether they have 
          a noble or not
        </flag-bit>
        <flag-bit name="central_holding_land">
          only dwarf fortresses get this for now
        </flag-bit>
        <flag-bit name="land_holder_residence">
          the regular sites where a baron etc. actually lives
        </flag-bit>
        <flag-bit name="invasion_push_out">
          pushed out by invasion
        </flag-bit>
        <flag-bit name="reclaim">
          marked for reclaim
        </flag-bit>
        <flag-bit name="occupation_failed">
          failed to hold hostile occupation
        </flag-bit>
      </bitfield>
      <int32_t/>
      <int32_t name="link_strength" init-value="100"/>
      <int32_t/>
      <int32_t/>
      <stl-vector>
        <pointer>
          <int32_t init-value="-1"/>
          <int32_t/>
        </pointer>
      </stl-vector>
      <int32_t name="target_site_x">
        target site world coordinate x
      </int32_t>
      <int32_t name="target_site_y">
        target site world coordinate y
      </int32_t>
      <int32_t name="unk_v43_1" init-value="-1">
        v0.43.01
      </int32_t>
      <int32_t name="unk_v43_2" init-value="-1">
        v0.43.01
      </int32_t>
    </struct-type>