====== Consumable items ======


Consumable items destroys itself when used!
They can trigger many effects(usually powers).

Simply enter the ''consumables'' parameter in the ''basics'' section in [[en:ds:rcdstypitem_family | feature ''family'']].

[[en:ds:rcdsconso_properties | Possible properties of consumables]] can be viewed on this dedicated page.

As usual.. i present contents of the "Data Sheet files" directly, without going through "Georges Editor", to simplify the presentation, but feel free to use this editor if you like. This also allows to have the LOGs filled out, but which i removed for the sake of clarity.

===== Contents of the Data Sheet =====
This simple object contains only the "normal sections" of a .sitem object, namely ''basics'' and ''3D'', plus the section dedicated to consumables: ''Consumable''.

It is therefore appropriate to fill the "DS" with the following sections:

   * [[en:ds:rcdsdfn_item_basics | basics (_item_basics.dfn)]];
   * [[en:ds:rcdsdfn_item_consumable | Consumable (_item_consumable.dfn)]];
   * [[en:ds:rcdsdfn_item_3d | 3d (_item_3d.dfn)]].

As usual, the [[en:ds:rcdsparentage | parentage]] will save repetitions.

===== Sample file =====
Here's an example of a "complete datasheet" for this object type:
<code=xml speedegg01.sitem>
<?xml version="1.0"?>
<FORM Revision="$Revision: 1.2 $" State="modified">
  <STRUCT>
    <COMMENTS>Egg accelerating this type:</COMMENTS>
    <STRUCT Name="basics">
      <ATOM Name="name" Value="Consommable"/>
      <ATOM Name="family" Value="consumable"/>
      <ATOM Name="stackable" Value="99"/>
      <ATOM Name="Drop or Sell" Value="false"/>
      <ATOM Name="Bulk" Value="1"/>
      <ATOM Name="Saleable" Value="false"/>
      <ATOM Name="Consumable" Value="true"/>
    </STRUCT>
    <STRUCT Name="3d">
      <ATOM Name="icon" Value="MP_EGG.tga"/>
      <ATOM Name="icon background" Value="BK_zorai.tga"/>
    </STRUCT>
    <STRUCT Name="Consumable">
      <ATOM Name="EffectPhrase" Value="acceleration01.sphrase"/>
    </STRUCT>
  </STRUCT>
  <STRUCT/>
  <STRUCT/>
  <STRUCT/>
  <STRUCT/>
  <LOG></LOG>
</FORM>
</code>


Note the presence of ''true'' for the ''consumable'' characteristic, in addition to the family type.

<WRAP center round todo 60%>
We should test to set the value to ''False'', to see if the power of the object can be triggered at will
</WRAP>

As usual, remember [[en:ds:rcdsparentage | Parentage]] to be able to decline the series by reducing the seizures.

===== Adding to language files =====
Do not forget to add [[rc_traduire_le_jeu | our new datasheets to the language files]], so the client may be able to dislplay them.
For objects, the file type is: ''item_words_XX.txt'' (XX denoting the ISO code of the language, see [[en:rc_localisation_traduction | part dedicated to localization]]).
The itemID values entered in this file must match the name ending of .sitem' ''speedegg01''.

<WRAP center round tip 60%
It would seem that it is not necessary to name an "entire sitem" if the same ID affects several DS's.
\\ By entering ''speedegg'' as itemID, the corresponding terms of the language file will be used for all DS starting with ''speedegg'' so it will concern all the mission objects that is designated under the same name .
</WRAP>

{{tag>datasheet creature item consumable}}