.. _structures.vermin:

######
vermin
######

.. _structures.vermin.vermin_flags:

vermin.vermin_flags
===================

.. code-block:: xml

    <bitfield-type type-name="vermin_flags">
      <flag-bit/>
      <flag-bit name="is_colony">
        A vermin colony. For example an anthill or bee hive.
      </flag-bit>
      <flag-bit/>
      <flag-bit/>
      <flag-bit/>
    </bitfield-type>

.. _structures.vermin.vermin:

vermin.vermin
=============

.. code-block:: xml

    <struct-type type-name="vermin" 
        instance-vector="$global.world.vermin.all">
      <int16_t name="race" ref-target="creature_raw"/>
      <int16_t name="caste" ref-target="caste_raw" aux-value="$$.race"/>
      <compound name="pos" type-name="coord"/>
      <bool name="visible">
        1 = visible vermin
      </bool>
      <int16_t name="countdown"/>
      <pointer name="item" type-name="item"/>
      <compound name="flags" type-name="vermin_flags"/>
      <int32_t name="amount">
        The total number of vermin in this object. Decimal constant 
        10000001 means infinity (probably).
      </int32_t>
      <compound name="population" type-name="world_population_ref"/>
      <int16_t name="unk_34"/>
      <int32_t name="id">
        assigned during Save
      </int32_t>
    </struct-type>