df.announcement.xml

<data-definition>
    <bitfield-type type-name='announcement_info_flag' base-type='uint32_t'> bay12: ANNOUNCEMENT_INFO_FLAG_*
        <flag-bit name='SPARRING_EVENT' comment='determined by unit_action_data_attack.flags.sparring_hit'/>
    </bitfield-type>

    <enum-type type-name='report_zoom_type' original-name='announcement_location_type' base-type='int32_t'> bay12: AnnouncementLocationType
        <enum-item name='NONE' value='-1'/>
        <enum-item name='Generic' original-name='STANDARD'/>
        <enum-item name='Item' original-name='ITEM'/>
        <enum-item name='Unit' original-name='UNIT'/>
    </enum-type>

    <struct-type type-name='announcement_infost' comment='allocated on the stack, included in df-structures to assist with disassembly'>
        <enum type-name='announcement_type' name='type'/>
        <int16_t name='color'/>
        <bool name='bright'/>
        <compound type-name='coord' name='pos'/>
        <enum type-name='report_zoom_type' name='zoom_type' original-name='loc_type'/>
        <compound type-name='coord' name='pos2'/>
        <enum type-name='report_zoom_type' name='zoom_type2' original-name='loc_type2'/>
        <int16_t name='display_timer' original-name='time' init-value='2000' comment='graphical frames for announcement bar to linger on last line with no new announcement'/>
        <pointer type-name='unit' name='unit_a'/>
        <pointer type-name='unit' name='unit_d'/>
        <int32_t name='activity_id' init-value='-1' comment='same as field in report'/>
        <int32_t name='activity_event_id' init-value='-1' comment='same as field in report'/>
        <int32_t name='speaker_id' original-name='speaker_unid' ref-target='unit'/>
        <bitfield base-type='uint32_t' type-name='announcement_info_flag' name='flags' original-name='flag'/>
        <int32_t name='portrait_hfid' ref-target='historical_figure'/>
    </struct-type>

    <bitfield-type type-name='announcement_flag' base-type='uint8_t'> bay12: ANNOUNCEMENTFLAG_*
        <flag-bit name='continuation' original-name='CONTINUED'
                  comment='When split into multiple lines, set on all but the first'/>
        <flag-bit name='unconscious' original-name='KO' comment='units.active[0]'/>
        <flag-bit name='announcement' original-name='DISPLAYED'/>
    </bitfield-type>

    <struct-type type-name='report' original-name='announcementst'
                 instance-vector='$global.world.status.reports' key-field='id'>
        <enum type-name='announcement_type' name='type'
              comment='valid only if coordinates are'/>

        <stl-string name='text' original-name='str'/>
        <code-helper name='describe'>$.text</code-helper>

        <int16_t name='color' init-value='7'/>
        <bool name='bright' init-value='true'/>

        <int32_t name='duration' original-name='forcedtime' init-value='100' comment='remaining graphical frames to display this report in announcement bar'/>

        <bitfield base-type='uint8_t' type-name='announcement_flag' name='flags' original-name='flag'/>

        <int32_t name='repeat_count' comment='100 => displays: x101'/>

        <enum type-name='report_zoom_type' name='zoom_type' original-name='loc_type' since='v0.44.10'/>
        <compound type-name='coord' name='pos'/>
        <enum type-name='report_zoom_type' name='zoom_type2' original-name='loc_type2' since='v0.44.10'/>
        <compound type-name='coord' name='pos2' since='v0.44.10'/>

        <int32_t name='id' original-name='global_id'/>
        <int32_t name='year'/>
        <int32_t name='time' original-name='season_count'/>

        <int32_t name='activity_id' ref-target='activity_entry' since='v0.40.01'/>
        <int32_t name='activity_event_id' ref-target='activity_event' since='v0.40.01'/>
        <int32_t name='speaker_id' original-name='speaker_unid' ref-target='unit' since='v0.40.01' comment='unit speaking the conversation'/>
    </struct-type>

    <struct-type type-name='popup_message' original-name='mega_announcementst'>
        <stl-string name='text' original-name='str'/>

        <int16_t name='color' init-value='7'/>
        <bool name='bright' init-value='true'/>
        <int32_t name='portrait_hfid' ref-target='historical_figure'/>
    </struct-type>

    <bitfield-type type-name='combat_event_strike_intro_flag' base-type='uint32_t'> bay12: COMBAT_EVENT_STRIKE_INTRO_FLAG_*
        <flag-bit name='behind' original-name='FROM_BEHIND'/>
        <flag-bit name='side' original-name='FROM_SIDE'/>
        <flag-bit name='grapple' original-name='GRAPPLE'/>
        <flag-bit name='item' original-name='TARGET_IS_ITEM'/>
        <flag-bit name='tap' original-name='PULLED'/>
        <flag-bit name='passive' original-name='PASSIVE'/>
        <flag-bit name='liquipowder' original-name='LIQUIPOWDER_ATTACK'/>
    </bitfield-type>

    <enum-type type-name='combat_report_event_type' original-name='combat_event_type' base-type='int16_t'> bay12: CombatEventType
        <enum-item name='NONE' value='-1'/>
        <enum-item name='StruckItem' original-name='ATTACK_STRIKES_INVENTORY'/>
        <enum-item name='Deflected' original-name='INVENTORY_COMPLETELY_BLOCKS_ATTACK'/>
        <enum-item name='ThroughTissue' original-name='THROUGH_TISSUE_HOLE'/>
        <enum-item name='CompoundFracture' original-name='COMPOUND_FRACTURE_THROUGH_TISSUE_HOLE'/>
        <enum-item name='BrokenAway' original-name='MATERIAL_BROKEN_AWAY'/>
        <enum-item name='BasicWound' original-name='BASIC_BP_WOUND'/>
        <enum-item name='Unconscious' original-name='KNOCKED_OUT'/>
        <enum-item name='Stunned' original-name='STUNNED'/>
        <enum-item name='MoreStunned' original-name='STUNNED_AGAIN'/>
        <enum-item name='Winded' original-name='WINDED'/>
        <enum-item name='MoreWinded' original-name='WINDED_AGAIN'/>
        <enum-item name='Nausea' original-name='NAUSEATED'/>
        <enum-item name='MoreNausea' original-name='NAUSEATED_AGAIN'/>
        <enum-item name='SeveredPart' original-name='SEVER'/>
        <enum-item name='PopOut' original-name='POP_OUT'/>
        <enum-item name='ExtractInjected' original-name='BLOOD_CONTAMINANT'/>
        <enum-item name='ExtractSprayed' original-name='EXTERNAL_CONTAMINANT'/>
        <enum-item name='BloodSucked' original-name='SUCK_BLOOD'/>
        <enum-item name='StrikeInto' original-name='STRIKE_INTRO'/>
        <enum-item name='GrabGlances' original-name='GRAB_GLANCES'/>
        <enum-item name='KnockedBack' original-name='PROPELLED_AWAY'/>
        <enum-item name='StuckIn' original-name='STUCKIN'/>
        <enum-item name='LatchOnPart' original-name='LATCH_BP'/>
        <enum-item name='LatchOn' original-name='LATCH_GENERAL'/>
        <enum-item name='Enraged' original-name='ENRAGED'/>
        <enum-item name='PassThrough' original-name='OVERALL_PASS_THROUGH'/>
        <enum-item name='GlancesAway' original-name='OVERALL_GLANCE_AWAY'/>
        <enum-item name='TendonDamaged' original-name='TENDON_DAMAGED'/>
        <enum-item name='LigamentDamaged' original-name='LIGAMENT_DAMAGED'/>
        <enum-item name='MajorArtery' original-name='MAJOR_ARTERY'/>
        <enum-item name='Artery' original-name='ARTERY'/>
        <enum-item name='MotorNerve' original-name='MOTOR_NERVE'/>
        <enum-item name='SensoryNerve' original-name='SENSORY_NERVE'/>
        <enum-item name='NoForce' original-name='OVERALL_ZERO_VELOCITY'/>
        <enum-item name='Interrupted' original-name='ATTACK_INTERRUPTED'/>
        <enum-item name='Pulped' original-name='PULPED_BP'/>
        <enum-item name='Gelded' original-name='GELDED'/>
        <enum-item name='ItemBroke' original-name='ITEM_BREAKS'/>
    </enum-type>

    <struct-type type-name='combat_eventst'>
        <enum type-name='combat_report_event_type' name='type'/>
        -- here be unions!
        <static-array name='field1' type-name='int32_t' count='4' comment='varies by event type'/>
        <static-array name='field2' type-name='int16_t' count='4' comment='varies by event type'/>
        <static-array name='str' type-name='stl-string' count='4'/>
        <bitfield base-type='uint32_t' type-name='combat_event_strike_intro_flag' name='flags' original-name='spec_flag'/>
    </struct-type>

    <struct-type type-name='combat_event_listst'>
        <static-array name='slotdata' original-name='combat_event' count='100' type-name='combat_eventst'/>
        <static-array name='slot_id_used' original-name='type_count' type-name='int16_t' index-enum='combat_report_event_type'/>
        <static-array name='slot_id_idx1' original-name='first_type_index' type-name='int16_t' index-enum='combat_report_event_type'/>
        <static-array name='slot_id_idx2' original-name='last_type_index' type-name='int16_t' index-enum='combat_report_event_type'/>
        <int16_t name='slots_used' original-name='cur_num'/>
    </struct-type>

    <struct-type type-name='announcement_alertst'>
        <enum type-name='announcement_alert_type' name='type'/>
        <stl-vector type-name='int32_t' name='announcement_id' ref-target='report'/>
        <stl-vector type-name='int32_t' name='report_unid' ref-target='unit'/>
        <stl-vector type-name='unit_report_type' name='report_unit_announcement_category' comment='vector must be same length as report_unid'/>
    </struct-type>

    <bitfield-type type-name='report_flag' base-type='uint32_t'> bay12: REPORT_FLAG_*
        <flag-bit name='combat' original-name='COMBAT'/>
        <flag-bit name='hunting' original-name='HUNTING'/>
        <flag-bit name='sparring' original-name='SPARRING'/>
        <flag-bit name='mission' original-name='MISSION'/>
        <flag-bit name='spoils' original-name='SPOILS'/>
        <flag-bit name='tribute' original-name='TRIBUTE'/>
        <flag-bit name='interrogation' original-name='INTERROGATION'/>
    </bitfield-type>

    <struct-type type-name='adv_announcementst'>
        <stl-string name='str'/>
        <pointer type-name='report' name='parent'/>
    </struct-type>

    <bitfield-type type-name='announcement_temp_flag' base-type='uint32_t'> bay12: ANNOUNCEMENT_TEMP_FLAG_*
        <flag-bit name='adv_handle_announcements' original-name='ADV_HANDLE_ANNOUNCEMENTS'/>
        <flag-bit name='adv_doing_more' original-name='ADV_DOING_MORE'/>
        <flag-bit name='adv_preserve_announcements' original-name='ADV_PRESERVE_ANNOUNCEMENTS'/>
        <flag-bit name='adv_have_more' original-name='ADV_HAVE_MORE'/>
        <flag-bit name='adv_showing_announcements' original-name='ADV_SHOWING_ANNOUNCEMENTS'/>
    </bitfield-type>

    <struct-type type-name='announcement_handlerst'>
        <stl-vector pointer-type='report' name='reports' original-name='global'/>
        <stl-vector pointer-type='report' name='announcements' original-name='display'/>
        <stl-vector pointer-type='popup_message' name='popups' original-name='mega'/>
        <compound type-name='markup_text_boxst' name='mega_text'/>
        <int32_t name='mega_portrait_hfid' ref-target='historical_figure'/>

        <int32_t name='next_report_id' original-name='next_announcement_id'/>
        <bitfield base-type='uint32_t' type-name='report_flag' name='flags' original-name='report_flag'/>

        <static-array name='current_numeric_unid' type-name='int32_t' count='9' ref-target='unit' since='v0.40.01'/>

        <stl-vector pointer-type='mission_report' name='mission_reports' original-name='mission_report'/>
        <stl-vector pointer-type='spoils_report' name='spoils_reports' original-name='tribute_report' since='v0.44.06'/>
        <stl-vector pointer-type='interrogation_report' name='interrogation_reports' original-name='interrogation_report' since='v0.47.01'/>

        <stl-vector pointer-type='announcement_alertst' name='announcement_alert'/>

        <stl-vector type-name='int32_t' name='alert_button_announcement_id' comment='entries are report ids'/>

        <int32_t name='display_timer' original-name='announcetime'/>
        <compound type-name='combat_event_listst' name='slots' original-name='combat_event_list'/>
        <bitfield base-type='uint32_t' type-name='announcement_temp_flag' name='temp_flag'/>
        <int32_t name='adv_scroll_position'/>
        <bool name='adv_scrolling'/>
        <int32_t name='adv_highest_scroll_position'/>
        <stl-vector pointer-type='adv_announcementst' name='adv_announcement'/>

        <stl-mutex name='announcement_mutex' original-name='mtx'/>
    </struct-type>
</data-definition>

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