df.military.xml

<data-definition>
    <bitfield-type type-name='uniform_indiv_choice'> bay12: ITEM_CREATION_PARAM_FLAG_*
        <flag-bit name='any'/>
        <flag-bit name='melee'/>
        <flag-bit name='ranged'/>
    </bitfield-type>

    <struct-type type-name='item_filter_spec'>
        <enum base-type='int16_t' name="item_type" type-name='item_type'/>
        <int16_t name="item_subtype" refers-to='(item-subtype-target $$._parent.item_type $)'/>

        <enum name="material_class" type-name='entity_material_category'/>

        <int16_t name='mattype' ref-target='material' aux-value='$$.matindex'/>
        <int32_t name='matindex'/>
    </struct-type>

    <struct-type type-name='squad_uniform_spec'>
        <int32_t name="item" ref-target='item'/>

        <compound name='item_filter' type-name='item_filter_spec'/>

        <int32_t name="color"/>

        <stl-vector name="assigned">
            <int32_t ref-target='item'/>
        </stl-vector>

        <bitfield name="indiv_choice" type-name='uniform_indiv_choice'/>
    </struct-type>

    <struct-type type-name='squad_ammo_spec'>
        <compound name='item_filter' type-name='item_filter_spec'/>

        <int32_t name="amount"/>

        <bitfield name='flags' base-type='uint32_t'>
            <flag-bit name='use_combat'/>
            <flag-bit name='use_training'/>
        </bitfield>

        <stl-vector name="assigned">
            <int32_t ref-target='item'/>
        </stl-vector>
    </struct-type>

    <bitfield-type type-name='squad_use_flags' base-type='uint32_t'>
        <flag-bit name='sleep'/>
        <flag-bit name='train'/>
        <flag-bit name='indiv_eq'/>
        <flag-bit name='squad_eq'/>
    </bitfield-type>

    <enum-type type-name='uniform_category' base-type='int16_t'>
        <enum-item name='body'/>
        <enum-item name='head'/>
        <enum-item name='pants'/>
        <enum-item name='gloves'/>
        <enum-item name='shoes'/>
        <enum-item name='shield'/>
        <enum-item name='weapon'/>
    </enum-type>

    <bitfield-type type-name='uniform_flags' base-type='uint32_t'> bay12: ENTITY_UNIFORM_FLAG_*
        <flag-bit name='replace_clothing'/>
        <flag-bit name='exact_matches'/>
    </bitfield-type>

    <enum-type type-name='barrack_preference_category'>
        <enum-item name='Bed'/>
        <enum-item name='Armorstand'/>
        <enum-item name='Box'/>
        <enum-item name='Cabinet'/>
    </enum-type>

    <enum-type type-name='squad_event_type' base-type='int16_t'>
        <enum-item name='None' value='-1'/>
        <enum-item name='Unk0'/>
        <enum-item name='Unk1'/>
        <enum-item name='Unk2'/>
    </enum-type>

    <struct-type type-name='squad_position'>
        <int32_t name='occupant' ref-target='historical_figure'/>

        <code-helper name='describe'>(describe-obj @.occupant)</code-helper>

        <stl-vector name="orders" pointer-type='squad_order'/>

        <static-array name='preferences' count='4' index-enum='barrack_preference_category'>
            <stl-vector type-name='int32_t' ref-target='building'/>
        </static-array>

        <static-array name='uniform' count='7' index-enum='uniform_category'>
            <stl-vector pointer-type='squad_uniform_spec'/>
        </static-array>

        <stl-string name="unk_c4"/>

        <bitfield name='flags' type-name='uniform_flags'/>

        <stl-vector name='assigned_items'>
            <int32_t ref-target='item'/>
        </stl-vector>

        <int32_t name="quiver" ref-target='item'/>
        <int32_t name="backpack" ref-target='item'/>
        <int32_t name="flask" ref-target='item'/>

        <int32_t name='unk_1'/>
        <static-array name='activities' count='3' index-enum='squad_event_type'
                      type-name='int32_t' ref-target='activity_entry'/>
        <static-array name='events' count='3' index-enum='squad_event_type'
                      type-name='int32_t' ref-target='activity_event'
                      aux-value='$._global.activities[$._key]'/>

        <int32_t name='unk_2' init-value='-1'/>
    </struct-type>

    <struct-type type-name='squad_schedule_order'>
        <pointer name="order" type-name='squad_order'/>
        <int32_t name="min_count"/>
        <stl-bit-vector name="positions"/>
    </struct-type>

    <struct-type type-name='squad_schedule_entry'>
        <stl-string name='name'/>

        <int16_t name='sleep_mode' comment='0 room, 1 barrack will, 2 barrack need'/>
        <int16_t name='uniform_mode' comment='0 uniformed, 1 civ clothes'/>

        <stl-vector name='orders' pointer-type='squad_schedule_order'/>

        <stl-vector name='order_assignments' index-refers-to='$$._global._upglobal.positions[$]'>
            -- weird change to pointer to int in v0.34.01
            <pointer>
                <int32_t refers-to='$$._parent._parent._parent.orders[$]'/>
            </pointer>
        </stl-vector>
    </struct-type>

    <struct-type type-name='squad' key-field='id' instance-vector='$global.world.squads.all' original-name='squadst'>
        <int32_t name='id'/>

        <compound name='name' type-name='language_name'/>

        <stl-string name='alias' comment='if not empty, used instead of name'/>

        <code-helper name='describe'>
            (describe-obj $.name)
        </code-helper>

        <stl-vector name='positions' pointer-type='squad_position'/>

        <stl-vector name="orders" pointer-type='squad_order'/>

        <stl-vector name="schedule">
            <pointer>
                <static-array count='12' type-name='squad_schedule_entry'/>
            </pointer>
        </stl-vector>

        <int32_t name="cur_routine_idx" refers-to='$$._parent.schedule[$]' init-value='0'/>

        <stl-vector name="rooms">
            <pointer>
                <int32_t name='building_id' ref-target='building'/>
                <bitfield name='mode' type-name='squad_use_flags'/>
            </pointer>
        </stl-vector>

        <stl-vector name="rack_combat" type-name='int32_t' ref-target='building'/>
        <stl-vector name="rack_training" type-name='int32_t' ref-target='building'/>

        <int32_t name="uniform_priority"/>
        <int32_t name="activity" ref-target='activity_entry'/>

        <compound name='ammo'>
            <stl-vector name="ammunition" pointer-type='squad_ammo_spec'/>

            <stl-vector name="train_weapon_free">
                <int32_t ref-target='item'/>
            </stl-vector>
            <stl-vector name="train_weapon_inuse">
                <int32_t ref-target='item'/>
            </stl-vector>

            <stl-vector name="ammo_items">
                <int32_t ref-target='item'/>
            </stl-vector>
            <stl-vector name="ammo_units">
                <int32_t ref-target='unit'/>
            </stl-vector>
            <bitfield name='update' type-name='equipment_update'/>
        </compound>

        <int16_t name="carry_food"/>
        <int16_t name="carry_water"/>

        <int32_t name="entity_id" ref-target='historical_entity' since='v0.40.01'/>
        <int32_t name="leader_position" since='v0.40.01'
                 refers-to='(find-by-id $$._global.entity_id.ref-target.positions.own $id $)'/>
        <int32_t name="leader_assignment" since='v0.40.01'
                 refers-to='(find-by-id $$._global.entity_id.ref-target.positions.assignments $id $)'/>
        <int32_t name='assigned_army_controller_id' ref-target='army_controller' init-value='-1' since='v0.44.01'/>
        <int32_t name='solid_texpos' comment='Appears to be a transient per-squad texture id. Initialised on squad ui click'/>
        <int32_t name='blended_texpos' comment='Always 1 less than the above field when initialised, and has tied initialisation'/>
        <int32_t name='symbol' comment='0 to 22 inclusive, row-wise. Only used in graphics mode'/>
        <uint8_t name='foreground_r'/>
        <uint8_t name='foreground_g'/>
        <uint8_t name='foreground_b'/>
        <uint8_t name='background_r'/>
        <uint8_t name='background_g'/>
        <uint8_t name='background_b'/>
    </struct-type>

    <enum-type type-name='squad_order_type'>
        <enum-item name='MOVE'/>
        <enum-item name='KILL_LIST'/>
        <enum-item name='DEFEND_BURROWS'/>
        <enum-item name='PATROL_ROUTE'/>
        <enum-item name='TRAIN'/>
        <enum-item name='DRIVE_ENTITY_OFF_SITE'/>
        <enum-item name='CAUSE_TROUBLE_FOR_ENTITY'/>
        <enum-item name='KILL_HF'/>
        <enum-item name='DRIVE_ARMIES_FROM_SITE'/>
        <enum-item name='RETRIEVE_ARTIFACT'/>
        <enum-item name='RAID_SITE'/>
        <enum-item name='RESCUE_HF'/>
    </enum-type>

    <enum-type type-name='squad_order_cannot_reason'>
        text in viewscreen_unitlistst
        <enum-item name='not_following_order'/>
        <enum-item name='activity_cancelled'/>
        <enum-item name='no_barracks'/>
        <enum-item name='improper_barracks'/>
        <enum-item name='no_activity'/>
        <enum-item name='cannot_individually_drill'/>
        <enum-item name='does_not_exist'/>
        <enum-item name='no_archery_target'/>
        <enum-item name='improper_building'/>
        <enum-item name='unreachable_location'/>
        <enum-item name='invalid_location'/>
        <enum-item name='no_reachable_valid_target'/>
        <enum-item name='no_burrow'/>
        <enum-item name='not_in_squad'/>
        <enum-item name='no_patrol_route'/>
        <enum-item name='no_reachable_point_on_route'/>
        <enum-item name='invalid_order'/>
        <enum-item name='no_temple'/>
        <enum-item name='no_library'/>
        <enum-item name='no_item'/>
        <enum-item name='cannot_leave_site'/>
    </enum-type>

    <class-type type-name='squad_order' original-name='squad_orderst'>
        <int32_t name='unk_v40_1' init-value='-1' since='v0.40.01'/>
        <int32_t name='unk_v40_2' init-value='-1' since='v0.40.01'/>
        <int32_t name='year' init-value='-1' since='v0.40.01'/>
        <int32_t name='year_tick' init-value='-1' since='v0.40.01'/>
        <int32_t name='unk_v40_3' init-value='-1' since='v0.40.01'/>
        <int32_t name='unk_1'/>

        <virtual-methods>
            <vmethod name='clone'> <ret-type><pointer type-name='squad_order'/></ret-type> </vmethod>
            <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='squad_order_type' name='getType'/>
            <vmethod name='isPatrol' ret-type='bool'/> whether or not dwarves get unhappy while doing this

            <vmethod is-destructor='true'/>
            <vmethod name='offsetPosition'>
                <int16_t name='x'/> <int16_t name='y'/> <int16_t name='z'/>
            </vmethod>
            <vmethod name='process'>
                <int32_t/> <int32_t/> <pointer name='soldier' type-name='unit'/>
            </vmethod>
            <vmethod ret-type='squad_order_cannot_reason' name='reasonCannot'>
                <pointer name='soldier' type-name='unit'/>
            </vmethod>
            <vmethod ret-type='bool' name='decUniformLock'>
                <pointer name='soldier' type-name='unit'/>
            </vmethod>

            <vmethod name='isFulfilled' ret-type='bool' since='v0.34.11' comment='true if all killed'/>
            <vmethod name='getTargetUnits'>
                <ret-type><pointer><stl-vector type-name='int32_t'/></pointer></ret-type>
            </vmethod>
            <vmethod ret-type='int16_t' name='getUniformType'>
                <pointer name='soldier' type-name='unit'/>
            </vmethod>
            <vmethod name='getDescription'> <pointer type-name='stl-string'/> </vmethod>
            <vmethod name='isInactive' ret-type='bool' comment='always false'> <int32_t/> </vmethod>
            <vmethod name='isCombat' ret-type='bool' comment='not train'/>
            <vmethod name='isEqual' ret-type='bool'><pointer name='other' type-name='squad_order'/></vmethod>
        </virtual-methods>
    </class-type>

    <class-type type-name='squad_order_movest' inherits-from='squad_order'>
        <compound name='pos' type-name='coord'/>
        <int32_t name='point_id'/>
    </class-type>

    <class-type type-name='squad_order_kill_listst' inherits-from='squad_order'>
        <stl-vector name='units'>
            <int32_t ref-target='unit'/>
        </stl-vector>
        <stl-vector name='histfigs'>
            <int32_t ref-target='historical_figure'/>
        </stl-vector>
        <stl-string name='title'/>
    </class-type>

    <class-type type-name='squad_order_defend_burrowsst' inherits-from='squad_order'>
        <stl-vector name='burrows' type-name='int32_t' ref-target='burrow'/>
    </class-type>

    <class-type type-name='squad_order_patrol_routest' inherits-from='squad_order'>
        <int32_t name='route_id'/>
    </class-type>

    <class-type type-name='squad_order_trainst' inherits-from='squad_order'/>

    <class-type type-name='squad_order_drive_entity_off_sitest' inherits-from='squad_order'>
        <int32_t name='unk_2'/>
        <int32_t name='unk_3'/>
        <stl-string name='unk_4'/>
    </class-type>

    <class-type type-name='squad_order_cause_trouble_for_entityst' inherits-from='squad_order'>
        <int32_t name='entity_id' ref-target='historical_entity'/>
        <stl-string name='override_name'/>
    </class-type>

    <class-type type-name='squad_order_kill_hfst' inherits-from='squad_order'>
        <int32_t name='histfig_id' ref-target='historical_figure'/>
        <stl-string name='title'/>
    </class-type>

    <class-type type-name='squad_order_drive_armies_from_sitest' inherits-from='squad_order'>
        <int32_t name='unk_2'/>
        <int32_t name='unk_3'/>
        <stl-string name='unk_4'/>
    </class-type>

    <class-type type-name='squad_order_retrieve_artifactst' inherits-from='squad_order'>
        <int32_t name='artifact_id' ref-target='artifact_record'/>
        <compound name='unk_2' type-name='coord'/>
    </class-type>

    <class-type type-name='squad_order_raid_sitest' inherits-from='squad_order'>
        <int32_t name='unk_2'/>
        <compound name='unk_3' type-name='coord'/>
    </class-type>

    <class-type type-name='squad_order_rescue_hfst' inherits-from='squad_order'>
        <int32_t name='unk_2'/>
        <compound name='unk_3' type-name='coord'/>
    </class-type>

    <enum-type type-name='invasion_intent_type' base-type='int32_t' comment='bay12: InvasionIntent'>
        <enum-item name='NONE' value='-1'/>
        <enum-item name='OBLITERATION'/>
        <enum-item name='TAKE_OVER_SITE'/>
        <enum-item name='INSTALL_PUPPET_GOVERNMENT'/>
        <enum-item name='DEMAND_TRIBUTE'/>
        <enum-item name='RAID'/>
        <enum-item name='EXPLORE'/>
        <enum-item name='PILLAGE'/>
    </enum-type>

    <enum-type type-name='invasion_stage_type' base-type='int32_t' comment='bay12: InvasionStage'>
        <enum-item name='NONE' value='-1'/>
        <enum-item name='ORGANIZE'/>
        <enum-item name='TRAVEL'/>
        <enum-item name='RAMPAGE'/>
        <enum-item name='PACIFY_SITE'/>
        <enum-item name='OCCUPY'/>
        <enum-item name='SITE_TAKEN'/>
    </enum-type>

    <enum-type type-name='army_controller_goal_type' base-type='int32_t' comment='bay12: ArmyControllerGoalType'>
        <enum-item name='NONE' value='-1'/>
        <enum-item name='HOLD_TERRITORY'/>
        <enum-item name='HARASS'/>
        <enum-item name='SITE_INVASION'/>
        <enum-item name='RAMPAGE'/>
        <enum-item name='CAMP'/>
        <enum-item name='GUARD'/>
        <enum-item name='HUNTING'/>
        <enum-item name='PATROL'/>
        <enum-item name='PACIFY_SITE'/>
        <enum-item name='PACIFY_CONNECTED_HAMLET'/>
        <enum-item name='WAIT'/>
        <enum-item name='ESCAPE'/>
        <enum-item name='MOVE_TO_SITE'/>
        <enum-item name='RECLAIM_SITE'/>
        <enum-item name='CREATE_NEW_SITE'/>
        <enum-item name='POSSE'/>
        <enum-item name='SITE_WORK'/>
        <enum-item name='RECOVER_ARTIFACT'/>
        <enum-item name='RESCUE_HF'/>
        <enum-item name='MAKE_REQUEST'/>
        <enum-item name='PERFORM_TASK'/>
        <enum-item name='ASSASSINATE_HF'/>
        <enum-item name='ABDUCT_HF'/>
        <enum-item name='SABOTAGE_ENTITY'/>
        <enum-item name='INFILTRATE_SOCIETY'/>
    </enum-type>

    Some army_controller research notes:
      t1: All seen NomadicGroup. master = group boss, general = leader of army (with troops) referencing controller. Purpose and action unknown.

      An InvasionOrder (2) is generated at the start of the season, shortly followed by an army that references an Invasion controller. The army disappears from the armies.all
      vector once it enters the embark.

      Invasion (4) has been seen via InvasionOrder army_controllers' armies, but only player fortress attacks have been studied. Prior to the army appears in the armies.all vector this controller
      seems to be available via the army_controllers.all vector referencing the the InvasionOrder via unk_34.

      t5: unk_34 seen referencing Invasion (4) and unk_38 referencing t5 (player fortress) or t7, disappearing when an army is generated (at least for player fortress).

      Visit (12) appears in the army_controller vector only very briefly before legitimate visitors arrive, and is also used for exiled residents.

      Quest (17) doesn't seem to contain any useful info except the site_id, time, and the artifact_id, in particular not anything that looks like
      references to the questers themselves or their employer. However, prior to arriving at the site, armies in armies.all can reference the controller, and the army members
      seem to match the questers that show up shortly thereafter, looking for the indicated artifact. As with InvasionOrder armies, quester armies disappear on embark arrival.

      VillainousVisit (24): Villainous visitors. Legitimate ones use Visit army controllers, but only until they arrive, while villainous ones linger.
    <struct-type type-name='army_controller' key-field='id' original-name='army_controllerst'
                 instance-vector='$global.world.army_controllers.all'>
        <int32_t name='id' comment="all army.controllers seen and reached via InvasionOrder controllers' armies have been of type = Invasion and absent from the 'all' vector"/>
        <int32_t name="entity_id" ref-target='historical_entity'/>
        <int32_t name='site_id' ref-target="world_site" comment="Invasion/Order: site to invade. Visit/Quest/VillainousVisit: site to 'visit'"/>
        <int32_t name='subregion_id' ref-target='world_region' init-value='-1'/>
        <int32_t name='pos_x' comment="Look like the unit is map_block, i.e. 3 * 16 * world tile. Position of target, which is the starting point for defeated invasions"/>
        <int32_t name='pos_y'/>
        <int32_t name='percentage_pop'/>
        <int32_t name='number_pop'/>
        <stl-vector name='activity_id' type-name='int32_t'/>
        <int32_t name="year"/>
        <int32_t name="year_tick"/>
        <int32_t name='parent_id' ref-target='army_controller' comment="id of other army controller (Invasion) from same entity seen here"/>
        <int32_t name='master_id' ref-target='army_controller' comment="copy of the id seen here, as well as a t7 for a t5 controller"/>
        <int32_t name='master_hf' ref-target='historical_figure' comment="InvasionOrder: Civ/sitegov master. Invasion: leader of the attack, can be in army nemesis vector"/>
        <int32_t name='commander_hf' ref-target='historical_figure' comment="InvasionOrder:leader of the attack. Invasion: subordinate squad leader(?) in army nemesis vector. Can be same as master"/>
        <int32_t name="origin_task_holder_nemesis_id" ref-target='nemesis_record'/>
        <int32_t name="origin_task_id"/>
        <int32_t name='origin_plot_holder_nemesis_id' ref-target='nemesis_record'/>
        <int32_t name='origin_plot_id'/>
        <stl-vector name="ignore_track_entity_id" type-name='int32_t'/>
        <bitfield name="flag" base-type='int32_t'>
            <flag-bit name='do_not_clear_army_dependencies'/>
            <flag-bit name='delete_me'/>
            <flag-bit name='site_realized_over_goal'/>
            <flag-bit name='civ_rep'/>
            <flag-bit name='done_for_dwarf_mode'/>
        </bitfield>
        <stl-vector name="assigned_squads" type-name='int32_t' ref-target='squad'/>
        <stl-vector name='assigned_epp_entity_id' type-name='int32_t' ref-target='historical_entity' since='v0.44.11'/>
        <stl-vector name='assigned_epp_epp_id' type-name='int32_t' ref-target='entity_position_assignment' since='v0.50.01'/>
        <pointer name='mission_report' type-name='mission_report'/>
        <compound name='data' is-union='true'>
            <pointer type-name='army_controller_goal_site_invasionst' name='goal_site_invasion'/>
            <pointer type-name='army_controller_goal_campst' name='goal_camp'/>
            <pointer type-name='army_controller_goal_guardst' name='goal_guard'/>
            <pointer type-name='army_controller_goal_harassst' name='goal_harass'/>
            <pointer type-name='army_controller_goal_huntingst' name='goal_hunting'/>
            <pointer type-name='army_controller_goal_patrolst' name='goal_patrol'/>
            <pointer type-name='army_controller_goal_escapest' name='goal_escape'/>
            <pointer type-name='army_controller_goal_move_to_sitest' name='goal_move_to_site'/>
            <pointer type-name='army_controller_goal_reclaim_sitest' name='goal_reclaim_site'/>
            <pointer type-name='army_controller_goal_create_new_sitest' name='goal_create_new_site'/>
            <pointer type-name='army_controller_goal_possest' name='goal_posse'/>
            <pointer type-name='army_controller_goal_site_workst' name='goal_site_work'/>
            <pointer type-name='army_controller_goal_recover_artifactst' name='goal_recover_artifact'/>
            <pointer type-name='army_controller_goal_rescue_hfst' name='goal_rescue_hf'/>
            <pointer type-name='army_controller_goal_make_requestst' name='goal_make_request'/>
            <pointer type-name='army_controller_goal_perform_taskst' name='goal_perform_task'/>
            <pointer type-name='army_controller_goal_assassinate_hfst' name='goal_assassinate_hf'/>
            <pointer type-name='army_controller_goal_abduct_hfst' name='goal_abduct_hf'/>
            <pointer type-name='army_controller_goal_sabotage_entityst' name='goal_sabotage_entity'/>
            <pointer type-name='army_controller_goal_infiltrate_societyst' name='goal_infiltrate_society'/>
        </compound>
        <enum name='goal' type-name='army_controller_goal_type'/>
    </struct-type>

    <struct-type type-name='army_camp_profilest'>
        <int32_t name='army_id' ref-target='army' comment="no longer available when an attack has started, unioned to another field named 'global_id'"/>
        <int32_t name='abs_smm_sx' comment="In map_blocks, i.e. in 3 * 16 * world tiles"/>
        <int32_t name='abs_smm_sy'/>
        <int32_t name='abs_smm_ex' comment="One is probably start and one is probably end of some movement"/>
        <int32_t name='abs_smm_ey'/>
        <int32_t name='army_total_pop' comment="size of the army, including leaders"/>
    </struct-type>

    <struct-type type-name='army_controller_goal_site_invasionst' original-name='ac_goal_site_invasionst'>
        <enum name='invasion_intent' type-name='invasion_intent_type' init-value='NONE'/>
        <enum name='invasion_stage' type-name='invasion_stage_type' init-value='ORGANIZE'/>
        <int32_t name='arrive_year' init-value='-1'/>
        <int32_t name='arrive_season_count' init-value='-1'/>
        <stl-vector name='camp_profile' pointer-type='army_camp_profilest'/>
        <stl-vector name='connected_hamlet_site_id' type-name='int32_t' comment='not sorted'/>
        <stl-vector name='connected_hamlet_site_flag' type-name='uint32_t'/>
        <bitfield name="flag" base-type='uint32_t'>
            <flag-bit name='RETURNING_HOME'/>
            <flag-bit name='DEMAND_TRIBUTE_ONE_TIME'/>
            <flag-bit name='DEMAND_TRIBUTE_ONGOING'/>
            <flag-bit name='FREE_OWN_CAPTIVES'/>
            <flag-bit name='FREE_OTHER_CAPTIVES'/>
            <flag-bit name='TAKE_ARTIFACTS'/>
            <flag-bit name='TAKE_ITEMS'/>
            <flag-bit name='STEAL_LIVESTOCK'/>
            <flag-bit name='ANNOUNCED_RAMPAGE'/>
            <flag-bit name='DEMAND_SURRENDER_AND_MAYBE_LEAVE'/>
        </bitfield>
        <int32_t name='source_abs_smm_x' init-value='-1'/>
        <int32_t name='source_abs_smm_y' init-value='-1'/>
        <stl-vector name='rampaged_ac' type-name='int32_t' since='v0.44.06'/>
    </struct-type>

    <struct-type type-name='army_controller_goal_campst' original-name='ac_goal_campst'>
        <int32_t name='camp_cz_alt_id' init-value='-1'/>
        <bitfield name='camp_flag' base-type='uint32_t'>
            <flag-bit name='ALARM_INTRUDER' comment='set to 1 to make army wake up'/>
            <flag-bit name='ONE_NIGHT_ONLY' comment='seen set on gobbo/necro attack controller'/>
            <flag-bit name='DONE'/>
            <flag-bit name='PUT_OUT_GUARDS' comment='sen set on gobbo/necro attack controller'/>
        </bitfield>
    </struct-type>

    <struct-type type-name='army_controller_goal_guardst' original-name='ac_goal_guardst'>
        <int32_t name='guard_point_abs_smm_x'/>
        <int32_t name='guard_point_abs_smm_y'/>
        <int32_t name='smm_guard_range'/>
        <int32_t name='year_arrived'/>
        <int32_t name='season_count_arrived'/>
    </struct-type>

    <struct-type type-name='army_controller_goal_harassst' original-name='ac_goal_harassst'>
        <bitfield name="flag" base-type='uint32_t'>
            <flag-bit name='RETURNING_HOME'/>
        </bitfield>
        <int32_t name='source_abs_smm_x'/>
        <int32_t name='source_abs_smm_y'/>
    </struct-type>

    <struct-type type-name='army_controller_goal_huntingst' original-name='ac_goal_huntingst'>
        <int32_t name='arrive_year' init-value='-1'/>
        <int32_t name='arrive_season_count' init-value='-1'/>
        <bitfield name='flag' base-type='uint32_t'>
            <flag-bit name='RETURNING_HOME'/>
            <flag-bit name='DAWN_PERMITTED'/>
            <flag-bit name='DAY_PERMITTED'/>
            <flag-bit name='DUSK_PERMITTED'/>
            <flag-bit name='NIGHT_PERMITTED'/>
        </bitfield>
        <int32_t name='source_abs_smm_x'/>
        <int32_t name='source_abs_smm_y'/>
        <int32_t name='latest_track_base_year' init-value='-1'/>
        <int32_t name='latest_track_rel_sec' init-value='-1'/>
        <int32_t name='latest_track_abs_smm_x' init-value='-1'/>
        <int32_t name='latest_track_abs_smm_y' init-value='-1'/>
    </struct-type>

    <struct-type type-name='army_controller_goal_patrolst' original-name='ac_goal_patrolst'>
        <int32_t name='arrive_year' init-value='-1'/>
        <int32_t name='arrive_season_count' init-value='-1'/>
        <stl-vector name='camp_profile' pointer-type='army_camp_profilest'/>
        <bitfield name="flag" base-type='uint32_t'>
            <flag-bit name='RETURNING_HOME'/>
            <flag-bit name='HARASS_ONLY'/>
        </bitfield>
        <int32_t name='source_abs_smm_x'/>
        <int32_t name='source_abs_smm_y'/>
        <int32_t name='latest_track_base_year' init-value='-1'/>
        <int32_t name='latest_track_rel_sec' init-value='-1'/>
        <int32_t name='latest_track_abs_smm_x' init-value='-1'/>
        <int32_t name='latest_track_abs_smm_y' init-value='-1'/>
    </struct-type>

    <struct-type type-name='army_controller_goal_escapest' original-name='ac_goal_escapest'>
        <int32_t name='arrive_year' init-value='-1'/>
        <int32_t name='arrive_season_count' init-value='-1'/>
        <stl-vector name='camp_profile' pointer-type='army_camp_profilest'/>
    </struct-type>

    <struct-type type-name='army_controller_goal_move_to_sitest' original-name='ac_goal_move_to_sitest'>
        <int32_t name='goal_hfid' init-value='-1'/>
        <int32_t name='goal_srbid' init-value='-1'/>
        <bitfield name="flag" base-type='uint32_t'>
            <flag-bit name='PERMANENT_MOVE'/>
            <flag-bit name='RETURNING_TO_CURRENT_HOME'/>
        </bitfield>
        <stl-vector name='camp_profile' pointer-type='army_camp_profilest'/>
        <int32_t name='goal_ent_id' init-value='-1'/>
        <int32_t name='goal_epp_id' init-value='-1'/>
        <int32_t name='goal_ab_id' init-value='-1' comment="abstract building id; monster slayers have -1"/>
        <enum name='reason' type-name='history_event_reason'/>
    </struct-type>

    <struct-type type-name='army_controller_goal_reclaim_sitest' original-name='ac_goal_reclaim_sitest'>
        <bitfield name='flag' base-type='uint32_t'>
            <flag-bit name='RETURNING_HOME'/>
        </bitfield>
        <int32_t name='source_abs_smm_x'/>
        <int32_t name='source_abs_smm_y'/>
        <stl-vector name='camp_profile' pointer-type='army_camp_profilest'/>
    </struct-type>

    <struct-type type-name='army_controller_goal_create_new_sitest' original-name='ac_goal_create_new_sitest'>
        <bitfield name='flag' base-type='uint32_t'>
            <flag-bit name='RETURNING_HOME'/>
        </bitfield>
        <int32_t name='source_abs_smm_x'/>
        <int32_t name='source_abs_smm_y'/>
        <stl-vector name='camp_profile' pointer-type='army_camp_profilest'/>
        <int32_t name='desired_parent_stid' init-value='-1' since='v0.44.11'/>
    </struct-type>

    <struct-type type-name='army_controller_goal_possest' original-name='ac_goal_possest'>
        <int32_t name='arrive_year' init-value='-1'/>
        <int32_t name='arrive_season_count' init-value='-1'/>
        <stl-vector name='camp_profile' pointer-type='army_camp_profilest'/>
        <bitfield name='flag' base-type='uint32_t'>
            <flag-bit name='RETURNING_HOME'/>
        </bitfield>
        <int32_t name='source_abs_smm_x'/>
        <int32_t name='source_abs_smm_y'/>
        <int32_t name='latest_track_base_year' init-value='-1'/>
        <int32_t name='latest_track_rel_sec' init-value='-1'/>
        <int32_t name='latest_track_abs_smm_x' init-value='-1'/>
        <int32_t name='latest_track_abs_smm_y' init-value='-1'/>
        <int32_t name='target_race' init-value='-1'/>
        <int32_t name='target_caste' init-value='-1'/>
        <int32_t name='target_hfid' init-value='-1'/>
    </struct-type>

    <struct-type type-name='army_controller_goal_site_workst' original-name='ac_goal_site_workst'>
        <int32_t name='work_count'/>
    </struct-type>

    <struct-type type-name='army_controller_goal_recover_artifactst' original-name='ac_goal_recover_artifactst'>
        <int32_t name='artifact_id' ref-target="artifact_record"/>
        <int32_t name='return_site_id' init-value='-1'/>
        <int32_t name='return_to_hfid' init-value='-1'/>
        <bitfield name="flag" base-type='uint32_t'>
            <flag-bit name='RETURNING'/>
            <flag-bit name='REMAIN_ANONYMOUS'/>
        </bitfield>
    </struct-type>

    <struct-type type-name='army_controller_goal_rescue_hfst' original-name='ac_goal_rescue_hfst'>
        <int32_t name='hfid' init-value='-1'/>
        <bitfield name="flag" base-type='uint32_t'>
            <flag-bit name='RETURNING'/>
        </bitfield>
    </struct-type>

    <struct-type type-name='army_controller_goal_make_requestst' original-name='ac_goal_make_requestst'>
        <stl-vector name='requested_hfid' type-name='int32_t' comment='sorted'/>
        <bitfield name="flag" base-type='uint32_t'>
            <flag-bit name='RETURNING_HOME'/>
        </bitfield>
        <int32_t name='source_abs_smm_x' init-value='-1'/>
        <int32_t name='source_abs_smm_y' init-value='-1'/>
    </struct-type>

    <struct-type type-name='army_controller_goal_perform_taskst' original-name='ac_goal_perform_taskst'>
        <int32_t name='task_id' init-value='-1'/>
        <int32_t name='task_holder_nem_id' init-value='-1'/>
        <bitfield name="flag" base-type='uint32_t'>
            <flag-bit name='RETURNING'/>
        </bitfield>
    </struct-type>

    <struct-type type-name='army_controller_goal_assassinate_hfst' original-name='ac_goal_assassinate_hfst'>
        <int32_t name='hfid' init-value='-1'/>
        <bitfield name="flag" base-type='uint32_t'>
            <flag-bit name='RETURNING'/>
        </bitfield>
    </struct-type>

    <struct-type type-name='army_controller_goal_abduct_hfst' original-name='ac_goal_abduct_hfst'>
        <int32_t name='target_hfid' init-value='-1'/>
        <bitfield name="flag" base-type='uint32_t'>
            <flag-bit name='RETURNING'/>
        </bitfield>
    </struct-type>

    <struct-type type-name='army_controller_goal_sabotage_entityst' original-name='ac_goal_sabotage_entityst'>
        <int32_t name='target_hfid' init-value='-1'/>
        <int32_t name='target_enid' init-value='-1'/>
        <int32_t name='target_stid' init-value='-1'/>
        <bitfield name="flag" base-type='uint32_t'>
            <flag-bit name='RETURNING'/>
        </bitfield>
    </struct-type>

    <struct-type type-name='army_controller_goal_infiltrate_societyst' original-name='ac_goal_infiltrate_societyst'>
        <int32_t name='target_stid' ref-target='world_site' init-value='-1'/>
        <int32_t name='target_enid' ref-target='historical_entity' init-value='0'/>
        <int32_t name='agoal_ab_id' init-value='-1' comment="abstract building ID, -1 before arrival"/>
        <enum name='reason' type-name='history_event_reason' comment="none before arrival"/>
    </struct-type>

    <enum-type type-name='army_flags'>
        <enum-item name='player'/>
    </enum-type>

    <struct-type type-name='army' key-field='id'
                 instance-vector='$global.world.armies.all'>
        <int32_t name='id'/>
        <compound name='pos' type-name='coord'/>
        <compound name='last_pos' type-name='coord'/>
        <int16_t name='unk_10' init-value='0' comment="1, 2, 5, 10, 15, 20, 21 seen"/>
        <int32_t name='unk_14' init-value='0' comment="When set, large value like army or army_controller id, but no match found"/>
        <int32_t name='unk_18' init-value='0'/>
        <stl-vector name='members'>
            <pointer>
                <int32_t name='nemesis_id' init-value='-1'/>
                <int32_t name='hunger_timer'/>
                <int32_t name='thirst_timer'/>
                <int32_t name='sleepiness_timer'/>
                <int32_t name='stored_fat'/>
                <int32_t name='unk_14'/>
                <int32_t name='unk_18'/>
                <int32_t name='unk_1c' init-value='-1000000'/>
                <int32_t name='unk_20' init-value='-1000000'/>
                <int32_t name='unk_24' init-value='-1000000'/>
                <int32_t name='unk_28'/>
                <int32_t name='unk_1' since='v0.44.01'/>
                <int32_t name='unk_2c' init-value='100'/>
                <int32_t name='unk_30'/>
                <int32_t name='unk_34'/>
                <stl-vector name='unk_38' pointer-type='stl-string'/>
                <int32_t name='unk_v42_1' since='v0.42.01'/>
                <int32_t name='unk_2' init-value='-1' since='v0.47.01'/>
                <int32_t name='unk_3' since='v0.47.01'/>
            </pointer>
        </stl-vector>
        <stl-vector name='squads' pointer-type='world_site_inhabitant'/>
        <int32_t name='unk_3c'/>
        <int32_t name='unk_1' since='v0.44.01'/>
        <int32_t name='unk_2' since='v0.47.03' comment="16 only value seen"/>
        <int32_t name='controller_id' ref-target='army_controller'/>
        <pointer name='controller' type-name="army_controller"/>
        <df-flagarray name='flags' index-enum='army_flags'/>
        <stl-vector name='block_path_x' type-name='int32_t' comment="path in map_block coordinates. Seems to be the near term"/>
        <stl-vector name='block_path_y' type-name='int32_t'/>
        <stl-vector name='path_x' type-name='int32_t' comment="path in world coordinates. Seems to be the extension beyond those laid out in block_path_x/y"/>
        <stl-vector name='path_y' type-name='int32_t'/>
        <int32_t name='unk_90' init-value='-1'/>
        <int32_t name='unk_94' init-value='-1' comment="Number counting down. In examined save starts at 80 for id 38 counting down to 0 at 113, obviously with missing numbers somewhere"/>
        <int32_t name='unk_98' init-value='-1'/>
        <int32_t name='min_smell_trigger'/>
        <int32_t name='max_odor_level' comment='1000 if undead are present'/>
        <int32_t name='max_low_light_vision'/>
        <stl-vector name='sense_creature_classes' pointer-type='stl-string'/>
        <stl-vector name='creature_class' pointer-type='stl-string' comment="Usually 'GENERAL_POISON' and 'MAMMAL'. Seen something else for undead"/>
        <enum type-name='item_type' base-type='int16_t' name='item_type'/>
        <int16_t name='item_subtype' refers-to='(item-subtype-target $$._parent.item_type $)'/>
        <int16_t name='mat_type' ref-target='material' aux-value='$$.mat_index'/>
        <int32_t name='mat_index'/>
        <stl-vector name='unk_4407_1' pointer-type='item' since='v0.44.07'/>
    </struct-type>
</data-definition>

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