.. _structures.legends:

#######
legends
#######

.. _structures.legends.invasion_info:

legends.invasion_info
=====================

.. code-block:: xml

    <struct-type type-name="invasion_info" 
        instance-vector="$global.ui.invasions.list" key-field="id">
      <int32_t name="id"/>
      <int32_t name="civ_id" ref-target="historical_entity"/>
      <int32_t name="active_size1">
        0 unless active
      </int32_t>
      <int32_t name="active_size2"/>
      <int32_t name="size"/>
      <int32_t name="duration_counter"/>
      <bitfield base-type="uint16_t" name="flags">
        <flag-bit name="active"/>
        <flag-bit name="siege"/>
      </bitfield>
      <int16_t name="unk4b"/>
    </struct-type>

.. _structures.legends.entity_population_unk4:

legends.entity_population_unk4
==============================

.. code-block:: xml

    <struct-type type-name="entity_population_unk4">
      <stl-vector>
        <pointer>
          <int32_t name="idx"/>
          <int32_t name="unk1"/>
          <int32_t name="unk2"/>
        </pointer>
      </stl-vector>
      <stl-vector/>
      <stl-vector>
        <pointer>
          <int32_t name="idx"/>
          <int32_t name="unk1"/>
        </pointer>
      </stl-vector>
    </struct-type>

.. _structures.legends.entity_population:

legends.entity_population
=========================

.. code-block:: xml

    <struct-type type-name="entity_population" key-field="id" 
        instance-vector="$global.world.entity_populations">
      <compound name="name" type-name="language_name"/>
      <stl-vector name="races">
        <int16_t ref-target="creature_raw"/>
      </stl-vector>
      <stl-vector name="counts" type-name="int32_t"/>
      <stl-vector name="unk3" type-name="int32_t"/>
      <stl-vector name="unk4">
        <pointer type-name="entity_population_unk4"/>
      </stl-vector>
      <int32_t name="unk5"/>
      <int32_t name="unk6"/>
      <int32_t name="id"/>
      <int32_t name="flags">
        ?; unk6 == -1
      </int32_t>
      <int32_t name="civ_id" ref-target="historical_entity"/>
    </struct-type>

.. _structures.legends.nemesis_flags:

legends.nemesis_flags
=====================

.. code-block:: xml

    <enum-type type-name="nemesis_flags">
      <enum-item name="ACTIVE_ADVENTURER">
        used when loading save
      </enum-item>
      <enum-item name="RETIRED_ADVENTURER">
        allows resuming play
      </enum-item>
      <enum-item name="ADVENTURER">
        blue color in legends
      </enum-item>
    </enum-type>

.. _structures.legends.nemesis_record:

legends.nemesis_record
======================

.. code-block:: xml

    <struct-type type-name="nemesis_record" key-field="id" 
        instance-vector="$global.world.nemesis.all">
      <int32_t name="id">
        sequential index in the array
      </int32_t>
      <int32_t name="unit_id" ref-target="unit"/>
      <int32_t name="save_file_id" ref-target="unit_chunk">
        unit-*.dat
      </int32_t>
      <int16_t name="member_idx">
        index in the file
      </int16_t>
      <pointer name="figure" type-name="historical_figure"/>
      <pointer name="unit" type-name="unit"/>
      <int32_t name="group_leader_id" ref-target="nemesis_record"/>
      <stl-vector name="companions">
        <int32_t ref-target="nemesis_record"/>
      </stl-vector>
      <int16_t name="unk10" init-value="-1"/>
      <int32_t name="unk11" init-value="-1"/>
      <int32_t name="unk12" init-value="-1"/>
      <df-flagarray name="flags" index-enum="nemesis_flags"/>
    </struct-type>

.. _structures.legends.artifact_record:

legends.artifact_record
=======================

.. code-block:: xml

    <struct-type type-name="artifact_record" key-field="id" 
        instance-vector="$global.world.artifacts.all">
      <int32_t name="id"/>
      <compound name="name" type-name="language_name"/>
      <df-flagarray name="flags"/>
      <pointer name="item" type-name="item"/>
      <int32_t>
        v0.34.01
      </int32_t>
      <int32_t>
        v0.34.01
      </int32_t>
      <int32_t>
        v0.34.01
      </int32_t>
    </struct-type>