df.itemimprovements.xml

<data-definition>
    <enum-type type-name='improvement_type' base-type='int32_t'> bay12: ItemImprovementType
        <enum-item name='NONE' value='-1'/>
        <enum-item name="ART_IMAGE"/>
        <enum-item name="COVERED"/>
        <enum-item name="RINGS_HANGING"/>
        <enum-item name="BANDS"/>
        <enum-item name="SPIKES"/>
        <enum-item name="ITEMSPECIFIC"/>
        <enum-item name="THREAD"/>
        <enum-item name="CLOTH"/>
        <enum-item name="SEWN_IMAGE"/>
        <enum-item name="PAGES"/>
        <enum-item name="ILLUSTRATION"/>
        <enum-item name="INSTRUMENT_PIECE"/>
        <enum-item name="WRITING"/>
        <enum-item name="IMAGE_SET"/>
    </enum-type>

    <struct-type type-name='dye_info' comment='not actually a real structure'>
        <int16_t name='mat_type' ref-target='material' aux-value='$$.mat_index'/>
        <int32_t name='mat_index'/>
        <int32_t name='dyer' ref-target='historical_figure'/>
        <enum base-type='int16_t' name='quality' type-name='item_quality'/>
        <enum base-type='int16_t' name="skill_rating" type-name='skill_rating'
              comment='at the moment of creation'/>
        <int32_t name='age_counter'/>
    </struct-type>

    <class-type type-name='itemimprovement' original-name='itemimprovementst'>
        <int16_t name='mat_type' ref-target='material' aux-value='$$.mat_index'/>
        <int32_t name='mat_index'/>
        <int32_t name='maker' ref-target='historical_figure'/>
        <int32_t name='masterpiece_event' ref-target='history_event'/>
        <enum base-type='int16_t' name='quality' type-name='item_quality'/>
        <enum base-type='int32_t' name="skill_rating" type-name='skill_rating'
              comment='at the moment of creation'/>
        <int32_t name='age_counter'/>

        <virtual-methods>
            <vmethod name='getImage'><pointer type-name='item'/>
                <ret-type><pointer type-name='art_image'/></ret-type>
            </vmethod>
            <vmethod name='getColorAndShape'>
                <pointer name='colors'><stl-vector type-name='int16_t'/></pointer>
                <pointer name='shapes'><stl-vector type-name='int16_t'/></pointer>
                <pointer name='item' type-name='item'/>
            </vmethod>
            <vmethod name='clone'>
                <ret-type><pointer type-name='itemimprovement'/></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='improvement_type' name='getType'/>
            <vmethod ret-type='bool' name='isDecoration' comment='displayed_improvement'/>
            <vmethod is-destructor='true'/>
            <vmethod ret-type='int32_t' name='getDyeValue'>
                <pointer type-name='caravan_state' name='caravan'/>
            </vmethod>
            <vmethod name='setShape'>
                <int32_t name='shape' ref-target='descriptor_shape'/>
            </vmethod>
        </virtual-methods>
    </class-type>

    <class-type type-name='itemimprovement_art_imagest' inherits-from='itemimprovement'>
        <compound name='image' type-name='art_image_ref'/>
    </class-type>

    <class-type type-name='itemimprovement_coveredst' inherits-from='itemimprovement'>
        <bitfield name='cover_flags' base-type='uint32_t'> bay12: ITEMIMPROVEMENT_COVERED_FLAG_*
            <flag-bit name='glazed'/>
        </bitfield>
        <int32_t name='shape' ref-target='descriptor_shape'/>
    </class-type>

    <class-type type-name='itemimprovement_rings_hangingst' inherits-from='itemimprovement'/>

    <class-type type-name='itemimprovement_bandsst' inherits-from='itemimprovement'>
        <int32_t name='shape' ref-target='descriptor_shape'/>
    </class-type>

    <class-type type-name='itemimprovement_spikesst' inherits-from='itemimprovement'/>

    <enum-type type-name='itemimprovement_specific_type' base-type='int32_t'> bay12: ItemSpecificImprovementType
        <enum-item name='HANDLE'/>
        <enum-item name='ROLLERS'/>
        <enum-item name='TRACTION_BENCH_ROPE'/>
        <enum-item name='TRACTION_BENCH_CHAIN'/>
    </enum-type>

    <class-type type-name='itemimprovement_itemspecificst' inherits-from='itemimprovement'>
        <enum base-type='int32_t' type-name='itemimprovement_specific_type' name='type'/>
    </class-type>

    <class-type type-name='itemimprovement_threadst' inherits-from='itemimprovement'>
        <compound name='dye' type-name='dye_info'/>
    </class-type>

    <class-type type-name='itemimprovement_clothst' inherits-from='itemimprovement'/>

    <class-type type-name='itemimprovement_sewn_imagest' inherits-from='itemimprovement'>
        none of these are actual compounds - beware of potential alignment/padding issues
        <compound name='image' type-name='art_image_ref'/>
        <compound name='cloth'>
            <int32_t name='maker_hf' ref-target='historical_figure'/>
            <int16_t name='quality'/>
            <int16_t name='skill_rating'/>
        </compound>
        <compound name='dye' type-name='dye_info'/>
    </class-type>

    <class-type type-name='itemimprovement_pagesst' inherits-from='itemimprovement'>
        <int32_t name='count'/>
        <stl-vector name='contents' type-name='int32_t' ref-target='written_content'/>
    </class-type>

    <class-type type-name='itemimprovement_illustrationst' inherits-from='itemimprovement'>
        <compound name='image' type-name='art_image_ref'/>
        <int32_t name='page_number' since='v0.34.01'/> bay12: III_PAGE_* for several special negative values
    </class-type>

    <class-type type-name='itemimprovement_instrument_piecest' inherits-from='itemimprovement'>
        <stl-string name='type' comment='instrument_piece.type'/>
    </class-type>

    <class-type type-name='itemimprovement_writingst' inherits-from='itemimprovement'>
        <stl-vector name='contents' type-name='int32_t' ref-target='written_content'/>
    </class-type>

    <class-type type-name='itemimprovement_image_setst' inherits-from='itemimprovement'>
        <int32_t name='image_set_id' init-value='-1' ref-target='image_set'/>
    </class-type>

    <enum-type type-name='written_content_type' base-type='int32_t'> bay12: WritingFormType
        <enum-item name='NONE' value='-1'/>
        <enum-item name='Manual'/>
        <enum-item name='Guide'/>
        <enum-item name='Chronicle'/>
        <enum-item name='ShortStory'/>
        <enum-item name='Novel'/>
        <enum-item name='Biography'/>
        <enum-item name='Autobiography'/>
        <enum-item name='Poem'/>
        <enum-item name='Play'/>
        <enum-item name='Letter'/>
        <enum-item name='Essay'/>
        <enum-item name='Dialog'/>
        <enum-item name='MusicalComposition'/>
        <enum-item name='Choreography'/>
        <enum-item name='ComparativeBiography'/>
        <enum-item name='BiographicalDictionary'/>
        <enum-item name='Genealogy'/>
        <enum-item name='Encyclopedia'/>
        <enum-item name='CulturalHistory'/>
        <enum-item name='CulturalComparison'/>
        <enum-item name='AlternateHistory'/>
        <enum-item name='TreatiseOnTechnologicalEvolution'/>
        <enum-item name='Dictionary'/>
        <enum-item name='StarChart'/>
        <enum-item name='StarCatalogue'/>
        <enum-item name='Atlas'/>
    </enum-type>

    <enum-type type-name='written_content_style' base-type='int32_t'> bay12: WritingStyleType
        <enum-item name='Meandering'/>
        <enum-item name='Cheerful'/>
        <enum-item name='Depressing'/>
        <enum-item name='Rigid'/>
        <enum-item name='Serious'/>
        <enum-item name='Disjointed'/>
        <enum-item name='Ornate'/>
        <enum-item name='Forceful'/>
        <enum-item name='Humorous'/>
        <enum-item name='Immature'/>
        <enum-item name='SelfIndulgent'/>
        <enum-item name='Touching'/>
        <enum-item name='Compassionate'/>
        <enum-item name='Vicious'/>
        <enum-item name='Concise'/>
        <enum-item name='Scornful'/>
        <enum-item name='Witty'/>
        <enum-item name='Ranting'/>
    </enum-type>

    <enum-type type-name='writing_style_modifier_type' base-type='int32_t'> bay12: WritingStyleModifierType
        <enum-item name='NONE' value='-1'/>
        <enum-item name='Thorough'/>
        <enum-item name='Somewhat'/>
        <enum-item name='Hint'/>
    </enum-type>

    <enum-type type-name='writing_role_type' base-type='int32_t'> bay12: WritingRoleType
        <enum-item name='NONE' value='-1'/>
        <enum-item name='Subject'/>
        <enum-item name='Narrator'/>
        <enum-item name='Character'/>
        <enum-item name='Writer'/>
        <enum-item name='Recipient'/>
        <enum-item name='Chapter'/>
        <enum-item name='MoralLesson'/>
        <enum-item name='AssociatedPoem' comment='from MusicalComposition'/>
        <enum-item name='AssociatedMusicalComposition' comment='from Choreography'/>
        <enum-item name='ValueAgenda'/>
    </enum-type>

    <struct-type type-name='written_content' original-name='written_contentst' instance-vector='$global.world.written_contents.all' key-field='id'>
        <int32_t name='id'/>
        <stl-string name='title'/>
        <int32_t name='page_start'/>
        <int32_t name='page_end'/>
        <stl-vector name='refs' pointer-type='general_ref' comment='interactions learned'/>
        <stl-vector name='ref_aux' type-name='writing_role_type'/>
        <int32_t name='chapter_number' init-value='-1'/>
        <int32_t name='section_number' init-value='-1'/>
        <enum type-name='written_content_type' name='type'/>
        <int32_t name='poetic_form' since='v0.42.01' ref-target='poetic_form' comment='or musical composition or dance'/>
        <stl-vector name='styles' type-name='written_content_style'/>
        <stl-vector name='style_strength' type-name='writing_style_modifier_type'/>
        <int32_t name='author' ref-target='historical_figure'/>
        <int32_t name='author_roll' init-value='-1' comment='skill roll for quality'/>
    </struct-type>

    <bitfield-type type-name='engraving_flags' base-type='uint32_t'> bay12: EVENTDETAILFLAG_*
        <flag-bit name='floor'/>
        <flag-bit name='west'/>
        <flag-bit name='east'/>
        <flag-bit name='north'/>
        <flag-bit name='south'/>
        <flag-bit name='hidden'/>
        <flag-bit name='northwest'/>
        <flag-bit name='northeast'/>
        <flag-bit name='southwest'/>
        <flag-bit name='southeast'/>
    </bitfield-type>

    <struct-type type-name='engraving' original-name='event_detailst' instance-vector='$global.world.event.engravings'>
        <int32_t name='artist' ref-target='historical_figure'/>
        <int32_t name='masterpiece_event' ref-target='history_event'/>
        <enum base-type='int32_t' name="skill_rating" type-name='skill_rating'
              comment='at the moment of creation'/>
        <compound name='pos' type-name='coord'/>
        <bitfield name='flags' type-name='engraving_flags'/>
        <uint8_t name='tile'/>
        can't use "art_image_ref" here because Toady put the "quality" field in the middle
        <int32_t name='art_id' ref-target='art_image_chunk'/>
        <int16_t name='art_subid' ref-target='art_image' aux-value='$$.art_id'/>
        <enum base-type='int16_t' name='quality' type-name='item_quality'/>
        <int32_t name='art_civ' ref-target='historical_entity' since='v0.34.06'/>
        <int32_t name='art_site' ref-target='world_site' since='v0.34.06'/>
    </struct-type>

</data-definition>

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