.. _structures.item-raws:

#########
item-raws
#########

.. _structures.item-raws.item_type:

item-raws.item_type
===================

.. code-block:: xml

    <enum-type type-name="item_type" base-type="int16_t">
      <enum-attr name="caption"/>
      <enum-attr name="is_rawable" type-name="bool"/>
      <enum-attr name="is_stackable" type-name="bool"/>
      <enum-attr name="is_caste_mat" type-name="bool">
        instead of material, uses a creature/caste pair
      </enum-attr>
      <enum-attr name="classname"/>
      <enum-item name="NONE" value="-1"/>
      <enum-item name="BAR">
        <item-attr name="caption" value="bars"/>
        <item-attr name="classname" value="item_barst"/>
        Bars, such as metal, fuel, or soap.
      </enum-item>
      <enum-item name="SMALLGEM">
        <item-attr name="caption" value="cut gem"/>
        <item-attr name="classname" value="item_smallgemst"/>
        Cut gemstones usable in jewelers workshop
      </enum-item>
      <enum-item name="BLOCKS">
        <item-attr name="caption" value="blocks"/>
        <item-attr name="classname" value="item_blocksst"/>
        Blocks of any kind.
      </enum-item>
      <enum-item name="ROUGH">
        <item-attr name="caption" value="rough gem"/>
        <item-attr name="classname" value="item_roughst"/>
        Rough gemstones.
      </enum-item>
      <enum-item name="BOULDER">
        <item-attr name="caption" value="boulder"/>
        <item-attr name="classname" value="item_boulderst"/>
        Raw mined stone.
      </enum-item>
      <enum-item name="WOOD">
        <item-attr name="caption" value="logs"/>
        <item-attr name="classname" value="item_woodst"/>
        Wooden logs.
      </enum-item>
      <enum-item name="DOOR">
        <item-attr name="caption" value="door"/>
        <item-attr name="classname" value="item_doorst"/>
        Doors.
      </enum-item>
      <enum-item name="FLOODGATE">
        <item-attr name="caption" value="floodgate"/>
        <item-attr name="classname" value="item_floodgatest"/>
        Floodgates.
      </enum-item>
      <enum-item name="BED">
        <item-attr name="caption" value="bed"/>
        <item-attr name="classname" value="item_bedst"/>
        Beds.
      </enum-item>
      <enum-item name="CHAIR">
        <item-attr name="caption" value="chair"/>
        <item-attr name="classname" value="item_chairst"/>
        Chairs and thrones.
      </enum-item>
      <enum-item name="CHAIN">
        <item-attr name="caption" value="chain"/>
        <item-attr name="classname" value="item_chainst"/>
        Restraints.
      </enum-item>
      <enum-item name="FLASK">
        <item-attr name="caption" value="flask"/>
        <item-attr name="classname" value="item_flaskst"/>
        Flasks.
      </enum-item>
      <enum-item name="GOBLET">
        <item-attr name="caption" value="goblet"/>
        <item-attr name="classname" value="item_gobletst"/>
        Goblets.
      </enum-item>
      <enum-item name="INSTRUMENT">
        <item-attr name="caption" value="instrument"/>
        <item-attr name="is_rawable" value="true"/>
        <item-attr name="classname" value="item_instrumentst"/>
        Musical instruments.
      </enum-item>
      <enum-item name="TOY">
        <item-attr name="caption" value="toy"/>
        <item-attr name="is_rawable" value="true"/>
        <item-attr name="classname" value="item_toyst"/>
        Toys.
      </enum-item>
      <enum-item name="WINDOW">
        <item-attr name="caption" value="window"/>
        <item-attr name="classname" value="item_windowst"/>
        Glass windows.
      </enum-item>
      <enum-item name="CAGE">
        <item-attr name="caption" value="cage"/>
        <item-attr name="classname" value="item_cagest"/>
        Cages.
      </enum-item>
      <enum-item name="BARREL">
        <item-attr name="caption" value="barrel"/>
        <item-attr name="classname" value="item_barrelst"/>
        Barrels.
      </enum-item>
      <enum-item name="BUCKET">
        <item-attr name="caption" value="bucket"/>
        <item-attr name="classname" value="item_bucketst"/>
        Buckets.
      </enum-item>
      <enum-item name="ANIMALTRAP">
        <item-attr name="caption" value="animal trap"/>
        <item-attr name="classname" value="item_animaltrapst"/>
        Animal traps.
      </enum-item>
      <enum-item name="TABLE">
        <item-attr name="caption" value="table"/>
        <item-attr name="classname" value="item_tablest"/>
        Tables.
      </enum-item>
      <enum-item name="COFFIN">
        <item-attr name="caption" value="coffin"/>
        <item-attr name="classname" value="item_coffinst"/>
        Coffins.
      </enum-item>
      <enum-item name="STATUE">
        <item-attr name="caption" value="statue"/>
        <item-attr name="classname" value="item_statuest"/>
        Statues.
      </enum-item>
      <enum-item name="CORPSE">
        <item-attr name="caption" value="corpse"/>
        <item-attr name="classname" value="item_corpsest"/>
        Corpses. Does not have a material.
      </enum-item>
      <enum-item name="WEAPON">
        <item-attr name="caption" value="weapon"/>
        <item-attr name="is_rawable" value="true"/>
        <item-attr name="classname" value="item_weaponst"/>
        Weapons.
      </enum-item>
      <enum-item name="ARMOR">
        <item-attr name="caption" value="armor"/>
        <item-attr name="is_rawable" value="true"/>
        <item-attr name="classname" value="item_armorst"/>
        Armor and clothing worn on the upper body.
      </enum-item>
      <enum-item name="SHOES">
        <item-attr name="caption" value="footwear"/>
        <item-attr name="is_rawable" value="true"/>
        <item-attr name="classname" value="item_shoesst"/>
        Armor and clothing worn on the feet.
      </enum-item>
      <enum-item name="SHIELD">
        <item-attr name="caption" value="shield"/>
        <item-attr name="is_rawable" value="true"/>
        <item-attr name="classname" value="item_shieldst"/>
        Shields and bucklers.
      </enum-item>
      <enum-item name="HELM">
        <item-attr name="caption" value="headwear"/>
        <item-attr name="is_rawable" value="true"/>
        <item-attr name="classname" value="item_helmst"/>
        Armor and clothing worn on the head.
      </enum-item>
      <enum-item name="GLOVES">
        <item-attr name="caption" value="handwear"/>
        <item-attr name="is_rawable" value="true"/>
        <item-attr name="classname" value="item_glovesst"/>
        Armor and clothing worn on the hands.
      </enum-item>
      <enum-item name="BOX">
        <item-attr name="caption" value="box/bag"/>
        <item-attr name="classname" value="item_boxst"/>
        Chests (wood), coffers (stone), boxes (glass), and bags (cloth or 
        leather).
      </enum-item>
      <enum-item name="BIN">
        <item-attr name="caption" value="bin"/>
        <item-attr name="classname" value="item_binst"/>
        Bins.
      </enum-item>
      <enum-item name="ARMORSTAND">
        <item-attr name="caption" value="armor stand"/>
        <item-attr name="classname" value="item_armorstandst"/>
        Armor stands.
      </enum-item>
      <enum-item name="WEAPONRACK">
        <item-attr name="caption" value="weapon rack"/>
        <item-attr name="classname" value="item_weaponrackst"/>
        Weapon racks.
      </enum-item>
      <enum-item name="CABINET">
        <item-attr name="caption" value="cabinet"/>
        <item-attr name="classname" value="item_cabinetst"/>
        Cabinets.
      </enum-item>
      <enum-item name="FIGURINE">
        <item-attr name="caption" value="figurine"/>
        <item-attr name="classname" value="item_figurinest"/>
        Figurines.
      </enum-item>
      <enum-item name="AMULET">
        <item-attr name="caption" value="amulet"/>
        <item-attr name="classname" value="item_amuletst"/>
        Amulets.
      </enum-item>
      <enum-item name="SCEPTER">
        <item-attr name="caption" value="scepter"/>
        <item-attr name="classname" value="item_scepterst"/>
        Scepters.
      </enum-item>
      <enum-item name="AMMO">
        <item-attr name="caption" value="ammo"/>
        <item-attr name="is_rawable" value="true"/>
        <item-attr name="is_stackable" value="true"/>
        <item-attr name="classname" value="item_ammost"/>
        Ammunition for hand-held weapons.
      </enum-item>
      <enum-item name="CROWN">
        <item-attr name="caption" value="crown"/>
        <item-attr name="classname" value="item_crownst"/>
        Crowns.
      </enum-item>
      <enum-item name="RING">
        <item-attr name="caption" value="ring"/>
        <item-attr name="classname" value="item_ringst"/>
        Rings.
      </enum-item>
      <enum-item name="EARRING">
        <item-attr name="caption" value="earring"/>
        <item-attr name="classname" value="item_earringst"/>
        Earrings.
      </enum-item>
      <enum-item name="BRACELET">
        <item-attr name="caption" value="bracelet"/>
        <item-attr name="classname" value="item_braceletst"/>
        Bracelets.
      </enum-item>
      <enum-item name="GEM">
        <item-attr name="caption" value="large gem"/>
        <item-attr name="classname" value="item_gemst"/>
        Large gems.
      </enum-item>
      <enum-item name="ANVIL">
        <item-attr name="caption" value="anvil"/>
        <item-attr name="classname" value="item_anvilst"/>
        Anvils.
      </enum-item>
      <enum-item name="CORPSEPIECE">
        <item-attr name="caption" value="body part"/>
        <item-attr name="classname" value="item_corpsepiecest"/>
        Body parts. Does not have a material.
      </enum-item>
      <enum-item name="REMAINS">
        <item-attr name="caption" value="remains"/>
        <item-attr name="is_caste_mat" value="true"/>
        <item-attr name="is_stackable" value="true"/>
        <item-attr name="classname" value="item_remainsst"/>
        Dead vermin bodies. Material is CREATURE_ID:CASTE.
      </enum-item>
      <enum-item name="MEAT">
        <item-attr name="caption" value="meat"/>
        <item-attr name="is_stackable" value="true"/>
        <item-attr name="classname" value="item_meatst"/>
        Butchered meat.
      </enum-item>
      <enum-item name="FISH">
        <item-attr name="caption" value="fish"/>
        <item-attr name="is_caste_mat" value="true"/>
        <item-attr name="is_stackable" value="true"/>
        <item-attr name="classname" value="item_fishst"/>
        Prepared fish. Material is CREATURE_ID:CASTE.
      </enum-item>
      <enum-item name="FISH_RAW">
        <item-attr name="caption" value="raw fish"/>
        <item-attr name="is_caste_mat" value="true"/>
        <item-attr name="is_stackable" value="true"/>
        <item-attr name="classname" value="item_fish_rawst"/>
        Unprepared fish. Material is CREATURE_ID:CASTE.
      </enum-item>
      <enum-item name="VERMIN">
        <item-attr name="caption" value="vermin"/>
        <item-attr name="is_caste_mat" value="true"/>
        <item-attr name="classname" value="item_verminst"/>
        Live vermin. Material is CREATURE_ID:CASTE.
      </enum-item>
      <enum-item name="PET">
        <item-attr name="caption" value="tame vermin"/>
        <item-attr name="is_caste_mat" value="true"/>
        <item-attr name="classname" value="item_petst"/>
        Tame vermin. Material is CREATURE_ID:CASTE.
      </enum-item>
      <enum-item name="SEEDS">
        <item-attr name="caption" value="seeds"/>
        <item-attr name="classname" value="item_seedsst"/>
        Seeds from plants.
      </enum-item>
      <enum-item name="PLANT">
        <item-attr name="caption" value="plant"/>
        <item-attr name="is_stackable" value="true"/>
        <item-attr name="classname" value="item_plantst"/>
        Plants.
      </enum-item>
      <enum-item name="SKIN_TANNED">
        <item-attr name="caption" value="leather"/>
        <item-attr name="classname" value="item_skin_tannedst"/>
        Tanned skins.
      </enum-item>
      <enum-item name="PLANT_GROWTH">
        <item-attr name="caption" value="plant growth"/>
        <item-attr name="is_stackable" value="true"/>
        <item-attr name="classname" value="item_plant_growthst"/>
        Assorted plant growths, including leaves and berries
      </enum-item>
      <enum-item name="THREAD">
        <item-attr name="caption" value="thread"/>
        <item-attr name="classname" value="item_threadst"/>
        Thread gathered from webs or made at the farmers workshop.
      </enum-item>
      <enum-item name="CLOTH">
        <item-attr name="caption" value="cloth"/>
        <item-attr name="classname" value="item_clothst"/>
        Cloth made at the loom.
      </enum-item>
      <enum-item name="TOTEM">
        <item-attr name="caption" value="totem"/>
        <item-attr name="classname" value="item_totemst"/>
        Skull totems.
      </enum-item>
      <enum-item name="PANTS">
        <item-attr name="caption" value="legwear"/>
        <item-attr name="is_rawable" value="true"/>
        <item-attr name="classname" value="item_pantsst"/>
        Armor and clothing worn on the legs.
      </enum-item>
      <enum-item name="BACKPACK">
        <item-attr name="caption" value="backpack"/>
        <item-attr name="classname" value="item_backpackst"/>
        Backpacks.
      </enum-item>
      <enum-item name="QUIVER">
        <item-attr name="caption" value="quiver"/>
        <item-attr name="classname" value="item_quiverst"/>
        Quivers.
      </enum-item>
      <enum-item name="CATAPULTPARTS">
        <item-attr name="caption" value="catapult part"/>
        <item-attr name="classname" value="item_catapultpartsst"/>
        Catapult parts.
      </enum-item>
      <enum-item name="BALLISTAPARTS">
        <item-attr name="caption" value="ballista part"/>
        <item-attr name="classname" value="item_ballistapartsst"/>
        Ballista parts.
      </enum-item>
      <enum-item name="SIEGEAMMO">
        <item-attr name="caption" value="siege ammo"/>
        <item-attr name="is_rawable" value="true"/>
        <item-attr name="classname" value="item_siegeammost"/>
        Siege engine ammunition.
      </enum-item>
      <enum-item name="BALLISTAARROWHEAD">
        <item-attr name="caption" value="ballista arrow head"/>
        <item-attr name="classname" value="item_ballistaarrowheadst"/>
        Ballista arrow heads.
      </enum-item>
      <enum-item name="TRAPPARTS">
        <item-attr name="caption" value="mechanism"/>
        <item-attr name="classname" value="item_trappartsst"/>
        Mechanisms.
      </enum-item>
      <enum-item name="TRAPCOMP">
        <item-attr name="caption" value="trap component"/>
        <item-attr name="is_rawable" value="true"/>
        <item-attr name="classname" value="item_trapcompst"/>
        Trap components.
      </enum-item>
      <enum-item name="DRINK">
        <item-attr name="caption" value="drink"/>
        <item-attr name="is_stackable" value="true"/>
        <item-attr name="classname" value="item_drinkst"/>
        Alcoholic drinks.
      </enum-item>
      <enum-item name="POWDER_MISC">
        <item-attr name="caption" value="powder"/>
        <item-attr name="is_stackable" value="true">
          if plant
        </item-attr>
        <item-attr name="classname" value="item_powder_miscst"/>
        Powders such as flour, gypsum plaster, dye, or sand.
      </enum-item>
      <enum-item name="CHEESE">
        <item-attr name="caption" value="cheese"/>
        <item-attr name="is_stackable" value="true"/>
        <item-attr name="classname" value="item_cheesest"/>
        Pieces of cheese.
      </enum-item>
      <enum-item name="FOOD">
        <item-attr name="caption" value="prepared meal"/>
        <item-attr name="is_stackable" value="true"/>
        <item-attr name="classname" value="item_foodst"/>
        Prepared meals. Subtypes come from item_food.txt
      </enum-item>
      <enum-item name="LIQUID_MISC">
        <item-attr name="caption" value="liquid"/>
        <item-attr name="is_stackable" value="true"/>
        <item-attr name="classname" value="item_liquid_miscst"/>
        Liquids such as water, lye, and extracts.
      </enum-item>
      <enum-item name="COIN">
        <item-attr name="caption" value="coin"/>
        <item-attr name="is_stackable" value="true"/>
        <item-attr name="classname" value="item_coinst"/>
        Coins.
      </enum-item>
      <enum-item name="GLOB">
        <item-attr name="caption" value="glob"/>
        <item-attr name="classname" value="item_globst"/>
        Fat, tallow, pastes/pressed objects, and small bits of molten 
        rock/metal.
      </enum-item>
      <enum-item name="ROCK">
        <item-attr name="caption" value="small rock"/>
        <item-attr name="classname" value="item_rockst"/>
        Small rocks (usually sharpened and/or thrown in adventurer mode)
      </enum-item>
      <enum-item name="PIPE_SECTION">
        <item-attr name="caption" value="pipe section"/>
        <item-attr name="classname" value="item_pipe_sectionst"/>
        Pipe sections.
      </enum-item>
      <enum-item name="HATCH_COVER">
        <item-attr name="caption" value="hatch cover"/>
        <item-attr name="classname" value="item_hatch_coverst"/>
        Hatch covers.
      </enum-item>
      <enum-item name="GRATE">
        <item-attr name="caption" value="grate"/>
        <item-attr name="classname" value="item_gratest"/>
        Grates.
      </enum-item>
      <enum-item name="QUERN">
        <item-attr name="caption" value="quern"/>
        <item-attr name="classname" value="item_quernst"/>
        Querns.
      </enum-item>
      <enum-item name="MILLSTONE">
        <item-attr name="caption" value="millstone"/>
        <item-attr name="classname" value="item_millstonest"/>
        Millstones.
      </enum-item>
      <enum-item name="SPLINT">
        <item-attr name="caption" value="splint"/>
        <item-attr name="classname" value="item_splintst"/>
        Splints.
      </enum-item>
      <enum-item name="CRUTCH">
        <item-attr name="caption" value="crutch"/>
        <item-attr name="classname" value="item_crutchst"/>
        Crutches.
      </enum-item>
      <enum-item name="TRACTION_BENCH">
        <item-attr name="caption" value="traction bench"/>
        <item-attr name="classname" value="item_traction_benchst"/>
        Traction benches.
      </enum-item>
      <enum-item name="ORTHOPEDIC_CAST">
        <item-attr name="caption" value="orthopedic cast"/>
        <item-attr name="classname" value="item_orthopedic_castst"/>
        Casts
      </enum-item>
      <enum-item name="TOOL">
        <item-attr name="caption" value="tool"/>
        <item-attr name="is_rawable" value="true"/>
        <item-attr name="classname" value="item_toolst"/>
        Tools.
      </enum-item>
      <enum-item name="SLAB">
        <item-attr name="caption" value="slab"/>
        <item-attr name="classname" value="item_slabst"/>
        Slabs.
      </enum-item>
      <enum-item name="EGG">
        <item-attr name="caption" value="egg"/>
        <item-attr name="is_caste_mat" value="true"/>
        <item-attr name="is_stackable" value="true"/>
        <item-attr name="classname" value="item_eggst"/>
        Eggs. Material is CREATURE_ID:CASTE.
      </enum-item>
      <enum-item name="BOOK">
        <item-attr name="caption" value="book"/>
        <item-attr name="classname" value="item_bookst"/>
        Books.
      </enum-item>
      <enum-item name="SHEET">
        <item-attr name="caption" value="sheet"/>
        <item-attr name="classname" value="item_sheetst"/>
        Sheets of paper
      </enum-item>
      <enum-item name="BRANCH">
        <item-attr name="caption" value="branch"/>
        <item-attr name="classname" value="item_branchst"/>
        Tree branches
      </enum-item>
    </enum-type>

.. _structures.item-raws.weapon_attack:

item-raws.weapon_attack
=======================

.. code-block:: xml

    <struct-type type-name="weapon_attack">
      <bool name="edged"/>
      <int32_t name="contact"/>
      <int32_t name="penetration"/>
      <int32_t name="velocity_mult"/>
      <stl-string name="verb_2nd"/>
      <stl-string name="verb_3rd"/>
      <stl-string name="noun"/>
      <int32_t name="prepare">
        v0.40.1
      </int32_t>
      <int32_t name="recover">
        v0.40.1
      </int32_t>
      <bitfield name="flags">
        <flag-bit name="independent_multiattack"/>
        <flag-bit name="bad_multiattack"/>
        v0.40.1
      </bitfield>
    </struct-type>

.. _structures.item-raws.itemdef:

item-raws.itemdef
=================

.. code-block:: xml

    <class-type type-name="itemdef" original-name="itemdefst">
      <stl-string name="id"/>
      <int16_t name="subtype"/>
      <df-flagarray name="base_flags">
        v0.34.08; [0] = generated
      </df-flagarray>
      <int32_t name="source_hfid" ref-target="historical_figure">
        v0.40.01
      </int32_t>
      <int32_t name="source_enid" ref-target="historical_entity">
        v0.42.01
      </int32_t>
      <stl-vector name="raw_strings" pointer-type="stl-string"/>
      <virtual-methods>
        <vmethod/>
        <vmethod name="parseRaws">
          <pointer/>
          <pointer/>
          <pointer/>
          <pointer/>
          <pointer/>
        </vmethod>
        <vmethod name="categorize">
          add to world.raws.itemdefs.whatever
        </vmethod>
        <vmethod name="finalize">
          calculate stuff like base value
        </vmethod>
        <vmethod/>
        <vmethod is-destructor="true"/>
      </virtual-methods>
    </class-type>

.. _structures.item-raws.ammo_flags:

item-raws.ammo_flags
====================

.. code-block:: xml

    <enum-type type-name="ammo_flags">
      <enum-item name="HAS_EDGE_ATTACK"/>
    </enum-type>

.. _structures.item-raws.itemdef_ammost:

item-raws.itemdef_ammost
========================

.. code-block:: xml

    <class-type type-name="itemdef_ammost" inherits-from="itemdef" 
        instance-vector="$global.world.raws.itemdefs.ammo">
      <stl-string name="name"/>
      <stl-string name="name_plural"/>
      <stl-string name="adjective">
        v0.40.1
      </stl-string>
      <stl-string name="ammo_class"/>
      <df-flagarray name="flags" index-enum="ammo_flags"/>
      <int32_t name="size">
        divided by 10
      </int32_t>
      <int32_t name="value"/>
      <stl-vector name="attacks" pointer-type="weapon_attack"/>
    </class-type>

.. _structures.item-raws.armor_general_flags:

item-raws.armor_general_flags
=============================

.. code-block:: xml

    <enum-type type-name="armor_general_flags">
      <enum-item name="SOFT"/>
      <enum-item name="HARD"/>
      <enum-item name="METAL"/>
      <enum-item name="BARRED"/>
      <enum-item name="SCALED"/>
      <enum-item name="LEATHER"/>
      <enum-item name="SHAPED"/>
      <enum-item name="CHAIN_METAL_TEXT"/>
      <enum-item name="STRUCTURAL_ELASTICITY_WOVEN_THREAD"/>
      <enum-item name="STRUCTURAL_ELASTICITY_CHAIN_METAL"/>
      <enum-item name="STRUCTURAL_ELASTICITY_CHAIN_ALL"/>
    </enum-type>

.. _structures.item-raws.armor_properties:

item-raws.armor_properties
==========================

.. code-block:: xml

    <struct-type type-name="armor_properties">
      <df-flagarray name="flags" index-enum="armor_general_flags"/>
      <int32_t name="layer"/>
      <int16_t name="layer_size"/>
      <int16_t name="layer_permit"/>
      <int16_t name="coverage"/>
    </struct-type>

.. _structures.item-raws.armor_flags:

item-raws.armor_flags
=====================

.. code-block:: xml

    <enum-type type-name="armor_flags">
      <enum-item name="METAL_ARMOR_LEVELS"/>
    </enum-type>

.. _structures.item-raws.itemdef_armorst:

item-raws.itemdef_armorst
=========================

.. code-block:: xml

    <class-type type-name="itemdef_armorst" inherits-from="itemdef" 
        instance-vector="$global.world.raws.itemdefs.armor">
      <stl-string name="name"/>
      <stl-string name="name_plural"/>
      <stl-string name="name_preplural"/>
      <stl-string name="material_placeholder"/>
      <stl-string name="adjective">
        v0.40.01
      </stl-string>
      <int32_t name="value"/>
      <int8_t name="armorlevel"/>
      <int16_t name="ubstep"/>
      <int16_t name="lbstep"/>
      <int32_t name="material_size"/>
      <compound name="props" type-name="armor_properties"/>
      <df-flagarray name="flags" index-enum="armor_flags"/>
    </class-type>

.. _structures.item-raws.itemdef_foodst:

item-raws.itemdef_foodst
========================

.. code-block:: xml

    <class-type type-name="itemdef_foodst" inherits-from="itemdef" 
        instance-vector="$global.world.raws.itemdefs.food">
      <stl-string name="name"/>
      <int16_t name="level"/>
    </class-type>

.. _structures.item-raws.gloves_flags:

item-raws.gloves_flags
======================

.. code-block:: xml

    <enum-type type-name="gloves_flags">
      <enum-item name="METAL_ARMOR_LEVELS"/>
    </enum-type>

.. _structures.item-raws.itemdef_glovesst:

item-raws.itemdef_glovesst
==========================

.. code-block:: xml

    <class-type type-name="itemdef_glovesst" inherits-from="itemdef" 
        instance-vector="$global.world.raws.itemdefs.gloves">
      <stl-string name="name"/>
      <stl-string name="name_plural"/>
      <stl-string name="adjective">
        v0.40.01
      </stl-string>
      <int32_t name="value"/>
      <int8_t name="armorlevel"/>
      <int16_t name="upstep"/>
      <df-flagarray name="flags" index-enum="gloves_flags"/>
      <int32_t name="material_size"/>
      <compound name="props" type-name="armor_properties"/>
    </class-type>

.. _structures.item-raws.helm_flags:

item-raws.helm_flags
====================

.. code-block:: xml

    <enum-type type-name="helm_flags">
      <enum-item name="METAL_ARMOR_LEVELS"/>
    </enum-type>

.. _structures.item-raws.itemdef_helmst:

item-raws.itemdef_helmst
========================

.. code-block:: xml

    <class-type type-name="itemdef_helmst" inherits-from="itemdef" 
        instance-vector="$global.world.raws.itemdefs.helms">
      <stl-string name="name"/>
      <stl-string name="name_plural"/>
      <stl-string name="adjective">
        v0.40.01
      </stl-string>
      <int32_t name="value"/>
      <int8_t name="armorlevel"/>
      <df-flagarray name="flags" index-enum="helm_flags"/>
      <int32_t name="material_size"/>
      <compound name="props" type-name="armor_properties"/>
    </class-type>

.. _structures.item-raws.instrument_flags:

item-raws.instrument_flags
==========================

.. code-block:: xml

    <enum-type type-name="instrument_flags">
      <enum-item name="INDEFINITE_PITCH"/>
      <enum-item name="PLACED_AS_BUILDING"/>
      <enum-item name="METAL_MAT"/>
      <enum-item name="STONE_MAT"/>
      <enum-item name="WOOD_MAT"/>
      <enum-item name="GLASS_MAT"/>
      <enum-item name="CERAMIC_MAT"/>
      <enum-item name="SHELL_MAT"/>
      <enum-item name="BONE_MAT"/>
    </enum-type>

.. _structures.item-raws.itemdef_instrumentst:

item-raws.itemdef_instrumentst
==============================

.. code-block:: xml

    <class-type type-name="itemdef_instrumentst" inherits-from="itemdef" 
        instance-vector="$global.world.raws.itemdefs.instruments">
      <stl-string name="name"/>
      <stl-string name="name_plural"/>
      <df-flagarray name="flags" index-enum="instrument_flags"/>
      <enum type-name="job_skill" name="music_skill"/>
      <int32_t name="size"/>
      <int32_t name="value"/>
      <int32_t name="material_size"/>
      <stl-vector pointer-type="instrument_piece" name="pieces"/>
      <stl-string name="dominant_instrument_piece"/>
      <int32_t name="pitch_range_min"/>
      <int32_t name="pitch_range_max"/>
      <int32_t name="volume_mb_min"/>
      <int32_t name="volume_mb_max"/>
      <stl-vector type-name="sound_production_type" 
          name="sound_production"/>
      <stl-vector pointer-type="stl-string" 
          name="sound_production_parm1"/>
      <stl-vector pointer-type="stl-string" 
          name="sound_production_parm2"/>
      <stl-vector name="unk_100"/>
      <stl-vector name="unk_110"/>
      <stl-vector type-name="pitch_choice_type" name="pitch_choice"/>
      <stl-vector pointer-type="stl-string" name="pitch_choice_parm1"/>
      <stl-vector pointer-type="stl-string" name="pitch_choice_parm2"/>
      <stl-vector name="unk_150"/>
      <stl-vector name="unk_160"/>
      <stl-vector type-name="tuning_type" name="tuning"/>
      <stl-vector pointer-type="stl-string" name="tuning_parm"/>
      <stl-vector name="unk_190"/>
      <stl-vector pointer-type="instrument_register" name="registers"/>
      <stl-vector type-name="timbre_type" name="timbre"/>
      <stl-string name="description"/>
    </class-type>

.. _structures.item-raws.sound_production_type:

item-raws.sound_production_type
===============================

.. code-block:: xml

    <enum-type type-name="sound_production_type">
      <enum-item name="PLUCKED_BY_BP"/>
      <enum-item name="PLUCKED"/>
      <enum-item name="BOWED"/>
      <enum-item name="STRUCK_BY_BP"/>
      <enum-item name="STRUCK"/>
      <enum-item name="VIBRATE_BP_AGAINST_OPENING"/>
      <enum-item name="BLOW_AGAINST_FIPPLE"/>
      <enum-item name="BLOW_OVER_OPENING_SIDE"/>
      <enum-item name="BLOW_OVER_OPENING_END"/>
      <enum-item name="BLOW_OVER_SINGLE_REED"/>
      <enum-item name="BLOW_OVER_DOUBLE_REED"/>
      <enum-item name="BLOW_OVER_FREE_REED"/>
      <enum-item name="STRUCK_TOGETHER"/>
      <enum-item name="SHAKEN"/>
      <enum-item name="SCRAPED"/>
      <enum-item name="FRICTION"/>
      <enum-item name="RESONATOR"/>
      <enum-item name="BAG_OVER_REED"/>
      <enum-item name="AIR_OVER_REED"/>
      <enum-item name="AIR_OVER_FREE_REED"/>
      <enum-item name="AIR_AGAINST_FIPPLE"/>
    </enum-type>

.. _structures.item-raws.pitch_choice_type:

item-raws.pitch_choice_type
===========================

.. code-block:: xml

    <enum-type type-name="pitch_choice_type">
      <enum-item name="MEMBRANE_POSITION"/>
      <enum-item name="SUBPART_CHOICE"/>
      <enum-item name="KEYBOARD"/>
      <enum-item name="STOPPING_FRET"/>
      <enum-item name="STOPPING_AGAINST_BODY"/>
      <enum-item name="STOPPING_HOLE"/>
      <enum-item name="STOPPING_HOLE_KEY"/>
      <enum-item name="SLIDE"/>
      <enum-item name="HARMONIC_SERIES"/>
      <enum-item name="VALVE_ROUTES_AIR"/>
      <enum-item name="BP_IN_BELL"/>
      <enum-item name="FOOT_PEDALS"/>
    </enum-type>

.. _structures.item-raws.tuning_type:

item-raws.tuning_type
=====================

.. code-block:: xml

    <enum-type type-name="tuning_type">
      <enum-item name="PEGS"/>
      <enum-item name="ADJUSTABLE_BRIDGES"/>
      <enum-item name="CROOKS"/>
      <enum-item name="TIGHTENING"/>
      <enum-item name="LEVERS"/>
    </enum-type>

.. _structures.item-raws.timbre_type:

item-raws.timbre_type
=====================

.. code-block:: xml

    <enum-type type-name="timbre_type">
      <enum-item name="CLEAR"/>
      <enum-item name="NOISY"/>
      <enum-item name="FULL"/>
      <enum-item name="THIN"/>
      <enum-item name="ROUND"/>
      <enum-item name="SHARP"/>
      <enum-item name="SMOOTH"/>
      <enum-item name="CHOPPY"/>
      <enum-item name="STEADY"/>
      <enum-item name="EVOLVING"/>
      <enum-item name="STRONG"/>
      <enum-item name="DELICATE"/>
      <enum-item name="BRIGHT"/>
      <enum-item name="GRACEFUL"/>
      <enum-item name="SPARSE"/>
      <enum-item name="BREATHY"/>
      <enum-item name="STRAINED"/>
      <enum-item name="BROAD"/>
      <enum-item name="LIGHT"/>
      <enum-item name="MELLOW"/>
      <enum-item name="WOBBLING"/>
      <enum-item name="FOCUSED"/>
      <enum-item name="EVEN"/>
      <enum-item name="FLUID"/>
      <enum-item name="VIBRATING"/>
      <enum-item name="QUAVERING"/>
      <enum-item name="EERIE"/>
      <enum-item name="FRAGILE"/>
      <enum-item name="BRITTLE"/>
      <enum-item name="PURE_"/>
      <enum-item name="PIERCING"/>
      <enum-item name="STRIDENT"/>
      <enum-item name="WAVERING"/>
      <enum-item name="HARSH"/>
      <enum-item name="REEDY"/>
      <enum-item name="NASAL"/>
      <enum-item name="BUZZY"/>
      <enum-item name="ROUGH"/>
      <enum-item name="WARM"/>
      <enum-item name="RUGGED"/>
      <enum-item name="HEAVY"/>
      <enum-item name="FLAT"/>
      <enum-item name="DARK"/>
      <enum-item name="CRISP"/>
      <enum-item name="SONOROUS"/>
      <enum-item name="WATERY"/>
      <enum-item name="GENTLE"/>
      <enum-item name="SLICING"/>
      <enum-item name="LIQUID"/>
      <enum-item name="RAUCOUS"/>
      <enum-item name="BREEZY"/>
      <enum-item name="RASPY"/>
      <enum-item name="WISPY"/>
      <enum-item name="SHRILL"/>
      <enum-item name="MUDDY"/>
      <enum-item name="RICH"/>
      <enum-item name="DULL"/>
      <enum-item name="FLOATING"/>
      <enum-item name="RINGING"/>
      <enum-item name="RESONANT"/>
      <enum-item name="SWEET"/>
      <enum-item name="RIPPLING"/>
      <enum-item name="SPARKLING"/>
    </enum-type>

.. _structures.item-raws.instrument_piece:

item-raws.instrument_piece
==========================

.. code-block:: xml

    <struct-type type-name="instrument_piece">
      <stl-string/>
      <stl-string/>
      <int32_t/>
      <stl-string/>
      <stl-string/>
      <bitfield base-type="uint32_t" name="flags">
        <flag-bit name="always_singular"/>
        <flag-bit name="always_plural"/>
      </bitfield>
    </struct-type>

.. _structures.item-raws.instrument_register:

item-raws.instrument_register
=============================

.. code-block:: xml

    <struct-type type-name="instrument_register">
      <int32_t/>
      <int32_t/>
      <stl-vector type-name="timbre_type" name="timbres"/>
    </struct-type>

.. _structures.item-raws.pants_flags:

item-raws.pants_flags
=====================

.. code-block:: xml

    <enum-type type-name="pants_flags">
      <enum-item name="METAL_ARMOR_LEVELS"/>
    </enum-type>

.. _structures.item-raws.itemdef_pantsst:

item-raws.itemdef_pantsst
=========================

.. code-block:: xml

    <class-type type-name="itemdef_pantsst" inherits-from="itemdef" 
        instance-vector="$global.world.raws.itemdefs.pants">
      <stl-string name="name"/>
      <stl-string name="name_plural"/>
      <stl-string name="name_preplural"/>
      <stl-string name="material_placeholder"/>
      <stl-string name="adjective">
        v0.40.01
      </stl-string>
      <int32_t name="value"/>
      <int8_t name="armorlevel"/>
      <df-flagarray name="flags" index-enum="pants_flags"/>
      <int32_t name="material_size"/>
      <int16_t name="lbstep"/>
      <compound name="props" type-name="armor_properties"/>
    </class-type>

.. _structures.item-raws.itemdef_shieldst:

item-raws.itemdef_shieldst
==========================

.. code-block:: xml

    <class-type type-name="itemdef_shieldst" inherits-from="itemdef" 
        instance-vector="$global.world.raws.itemdefs.shields">
      <stl-string name="name"/>
      <stl-string name="name_plural"/>
      <stl-string name="adjective">
        v0.40.01
      </stl-string>
      <int32_t name="value"/>
      <int32_t name="blockchance"/>
      <int8_t name="armorlevel"/>
      <int16_t name="upstep"/>
      <int32_t name="material_size"/>
    </class-type>

.. _structures.item-raws.shoes_flags:

item-raws.shoes_flags
=====================

.. code-block:: xml

    <enum-type type-name="shoes_flags">
      <enum-item name="METAL_ARMOR_LEVELS"/>
    </enum-type>

.. _structures.item-raws.itemdef_shoesst:

item-raws.itemdef_shoesst
=========================

.. code-block:: xml

    <class-type type-name="itemdef_shoesst" inherits-from="itemdef" 
        instance-vector="$global.world.raws.itemdefs.shoes">
      <stl-string name="name"/>
      <stl-string name="name_plural"/>
      <stl-string name="adjective">
        v0.40.01
      </stl-string>
      <int32_t name="value"/>
      <int8_t name="armorlevel"/>
      <int16_t name="upstep"/>
      <df-flagarray name="flags" index-enum="shoes_flags"/>
      <int32_t name="material_size"/>
      <compound name="props" type-name="armor_properties"/>
    </class-type>

.. _structures.item-raws.itemdef_siegeammost:

item-raws.itemdef_siegeammost
=============================

.. code-block:: xml

    <class-type type-name="itemdef_siegeammost" inherits-from="itemdef" 
        instance-vector="$global.world.raws.itemdefs.siege_ammo">
      <stl-string name="name"/>
      <stl-string name="name_plural"/>
      <stl-string name="ammo_class"/>
    </class-type>

.. _structures.item-raws.tool_flags:

item-raws.tool_flags
====================

.. code-block:: xml

    <enum-type type-name="tool_flags">
      <enum-item name="HARD_MAT"/>
      <enum-item name="METAL_MAT"/>
      <enum-item name="HAS_EDGE_ATTACK"/>
      <enum-item name="METAL_WEAPON_MAT"/>
      <enum-item name="UNIMPROVABLE"/>
      <enum-item name="SOFT_MAT"/>
      <enum-item name="WOOD_MAT"/>
      <enum-item name="INVERTED_TILE"/>
      <enum-item name="FURNITURE"/>
      <enum-item name="LEATHER_MAT"/>
      <enum-item name="SILK_MAT"/>
      <enum-item name="THREAD_PLANT_MAT"/>
      <enum-item name="GLASS_MAT"/>
      <enum-item name="CERAMIC_MAT"/>
      <enum-item name="STONE_MAT"/>
      <enum-item name="SHELL_MAT"/>
      <enum-item name="BONE_MAT"/>
      <enum-item name="NO_DEFAULT_JOB"/>
      <enum-item name="INCOMPLETE_ITEM"/>
      <enum-item name="SHEET_MAT"/>
    </enum-type>

.. _structures.item-raws.tool_uses:

item-raws.tool_uses
===================

.. code-block:: xml

    <enum-type type-name="tool_uses" base-type="int16_t">
      <enum-item name="NONE" value="-1"/>
      <enum-item name="LIQUID_COOKING"/>
      <enum-item name="LIQUID_SCOOP"/>
      <enum-item name="GRIND_POWDER_RECEPTACLE"/>
      <enum-item name="GRIND_POWDER_GRINDER"/>
      <enum-item name="MEAT_CARVING"/>
      <enum-item name="MEAT_BONING"/>
      <enum-item name="MEAT_SLICING"/>
      <enum-item name="MEAT_CLEAVING"/>
      <enum-item name="HOLD_MEAT_FOR_CARVING"/>
      <enum-item name="MEAL_CONTAINER"/>
      <enum-item name="LIQUID_CONTAINER"/>
      <enum-item name="FOOD_STORAGE"/>
      <enum-item name="HIVE"/>
      <enum-item name="NEST_BOX"/>
      <enum-item name="SMALL_OBJECT_STORAGE"/>
      <enum-item name="TRACK_CART"/>
      <enum-item name="HEAVY_OBJECT_HAULING"/>
      <enum-item name="STAND_AND_WORK_ABOVE"/>
      <enum-item name="ROLL_UP_SHEET"/>
      <enum-item name="PROTECT_FOLDED_SHEETS"/>
      <enum-item name="CONTAIN_WRITING"/>
      <enum-item name="BOOKCASE"/>
    </enum-type>

.. _structures.item-raws.itemdef_toolst:

item-raws.itemdef_toolst
========================

.. code-block:: xml

    <class-type type-name="itemdef_toolst" inherits-from="itemdef" 
        instance-vector="$global.world.raws.itemdefs.tools">
      <stl-string name="name"/>
      <stl-string name="name_plural"/>
      <df-flagarray name="flags" index-enum="tool_flags"/>
      <int32_t name="value"/>
      <uint8_t name="tile"/>
      <stl-vector name="tool_use">
        <enum base-type="int16_t" type-name="tool_uses"/>
      </stl-vector>
      <stl-string name="adjective"/>
      <int32_t name="size"/>
      <enum base-type="int16_t" type-name="job_skill" name="skill_melee"/>
      <enum base-type="int16_t" type-name="job_skill" 
          name="skill_ranged"/>
      <stl-string name="ranged_ammo"/>
      <int32_t name="two_handed"/>
      <int32_t name="minimum_size"/>
      <int32_t name="material_size"/>
      <stl-vector name="attacks" pointer-type="weapon_attack"/>
      <int32_t name="shoot_force"/>
      <int32_t name="shoot_maxvel"/>
      <int32_t name="container_capacity"/>
      <stl-string name="description">
        v0.42.01
      </stl-string>
      <stl-vector name="default_improvements">
        <pointer>
          <enum base-type="int32_t" type-name="improvement_type" 
              name="type"/>
          <enum base-type="int32_t" 
              type-name="itemimprovement_specific_type" 
              name="specific_type"/>
          <stl-string name="instrument_part"/>
          <enum base-type="int32_t" type-name="tool_flags" 
              name="restriction"/>
        </pointer>
        v0.42.01
      </stl-vector>
    </class-type>

.. _structures.item-raws.toy_flags:

item-raws.toy_flags
===================

.. code-block:: xml

    <enum-type type-name="toy_flags">
      <enum-item name="HARD_MAT"/>
    </enum-type>

.. _structures.item-raws.itemdef_toyst:

item-raws.itemdef_toyst
=======================

.. code-block:: xml

    <class-type type-name="itemdef_toyst" inherits-from="itemdef" 
        instance-vector="$global.world.raws.itemdefs.toys">
      <stl-string name="name"/>
      <stl-string name="name_plural"/>
      <df-flagarray name="flags" index-enum="toy_flags"/>
    </class-type>

.. _structures.item-raws.trapcomp_flags:

item-raws.trapcomp_flags
========================

.. code-block:: xml

    <enum-type type-name="trapcomp_flags">
      <enum-item name="IS_SCREW"/>
      <enum-item name="IS_SPIKE"/>
      <enum-item name="WOOD"/>
      <enum-item name="METAL"/>
      <enum-item name="HAS_EDGE_ATTACK"/>
    </enum-type>

.. _structures.item-raws.itemdef_trapcompst:

item-raws.itemdef_trapcompst
============================

.. code-block:: xml

    <class-type type-name="itemdef_trapcompst" inherits-from="itemdef" 
        instance-vector="$global.world.raws.itemdefs.trapcomps">
      <stl-string name="name"/>
      <stl-string name="name_plural"/>
      <stl-string name="adjective"/>
      <int32_t name="size"/>
      <int32_t name="value"/>
      <int32_t name="hits"/>
      <int32_t name="material_size"/>
      <df-flagarray name="flags" index-enum="trapcomp_flags"/>
      <stl-vector name="attacks" pointer-type="weapon_attack"/>
    </class-type>

.. _structures.item-raws.weapon_flags:

item-raws.weapon_flags
======================

.. code-block:: xml

    <enum-type type-name="weapon_flags">
      <enum-item name="CAN_STONE"/>
      <enum-item name="HAS_EDGE_ATTACK"/>
      <enum-item name="TRAINING"/>
    </enum-type>

.. _structures.item-raws.itemdef_weaponst:

item-raws.itemdef_weaponst
==========================

.. code-block:: xml

    <class-type type-name="itemdef_weaponst" inherits-from="itemdef" 
        instance-vector="$global.world.raws.itemdefs.weapons">
      <stl-string name="name"/>
      <stl-string name="name_plural"/>
      <stl-string name="adjective"/>
      <int32_t name="size"/>
      <int32_t name="value"/>
      <enum base-type="int16_t" type-name="job_skill" name="skill_melee"/>
      <enum base-type="int16_t" type-name="job_skill" 
          name="skill_ranged"/>
      <stl-string name="ranged_ammo"/>
      <int32_t name="two_handed"/>
      <int32_t name="minimum_size"/>
      <int32_t name="material_size"/>
      <df-flagarray name="flags" index-enum="weapon_flags"/>
      <stl-vector name="attacks" pointer-type="weapon_attack"/>
      <int32_t name="shoot_force"/>
      <int32_t name="shoot_maxvel"/>
    </class-type>