Editing GAE/Upgrade XML

An upgrade is a "producible" type that a unit may produce to bring about changes in other units or pave the way for other units or upgrade to be produced.  An upgrade may alter many stats of one or more unit types.

 <?xml version="1.0" standalone="no"?>
 
 <upgrade>                                    <font color="green">&lt;!-- Related source code: [http://glest.codemonger.org/docs/gae/classGlest_1_1Game_1_1Upgrade.html Glest::Upgrade] and [http://glest.codemonger.org/docs/gae/classGlest_1_1Game_1_1UpgradeType.html Glest::UpgradeType]
                                                   classes --&gt;</font>
     <image path="images/image.bmp"/>         <font color="green">&lt;!-- UI icon used for the upgrade --&gt;</font>
     <image-cancel path="images/cancel.bmp"/> <font color="green">&lt;!-- UI icon used to cancel the upgrade --&gt;</font>
     <time value="500"/>                      <font color="green">&lt;!-- Time required to upgrade --&gt;</font>
     <unit-requirements/>                     <font color="green">&lt;!-- Units required to be in service before upgrade --&gt;</font>
     <upgrade-requirements>
         <upgrade name="upgrade_name"/>       <font color="green">&lt;!-- Previous upgrades required before upgrade can be initiated --&gt;</font>
     </upgrade-requirements>
     <resource-requirements>
                                              <font color="green">&lt;!-- Resources used for upgrade --&gt;</font>
         <resource name="resource_name" amount="#"/>
     </resource-requirements>
     <effects>
         <unit name="unit_name"/>             <font color="green">&lt;!-- Units affected by the upgrade --&gt;</font>
     </effects>
 
 <font color="green">&lt;!-- The following 8 tags are deprecated in GAE in favor of static-modifiers and multipliers (below) --&gt;</font>
 
     <max-hp value="0"/>
     <max-ep value="0"/>
     <sight value="0"/>
     <attack-strenght value="0"/>             <font color="green">&lt;!-- Note Spelling; Minor bug, not corrected as of 3.1.2 (nor GAE 0.2.8) --&gt;</font>
     <attack-range value="0"/>
     <armor value="0"/>
     <move-speed value="0"/>
     <production-speed value="0"/>
 
 <font color="darkblue">&lt;!-- GAE Only --&gt;
 
     <font color="green">&lt;!-- Notice: under GAE, the above statistics modifiers (max-hp, max-ep, sight, attack-strenght, attack-range,
          armor, move-speed and production-speed) are optional and may be omitted.  If specified, their values will be
          overwritten by any duplicate definitions using the GAE format. --&gt;</font>
 
     <font color="green">&lt;!-- Static modifiers are adjustments to the affected units using fixed values, like 100 hit points (meaning +100)
          and 1 sight.  The following describes each of these parameters, although some of them are probably quite
          obvious).
          ALSO APPEARS IN: [[GAE/Reference#.3Ceffects.3E|&lt;effect&gt;]], [[GAE/Reference#.3Cemanations.3E|&lt;enamation&gt;]] tags in [[GAE/Unit_XML|unit.xml]]
          SEE ALSO: [[GAE/Reference]]
          RELATED SOURCE CODE: [http://glest.codemonger.org/docs/gae/classGlest_1_1Game_1_1EnhancementTypeBase.html Glest::EnhancementTypeBase class] --&gt;</font>
     &lt;static-modifiers&gt;
         &lt;max-hp value="#"/&gt;               <font color="green">&lt;!-- Maximum hit points --&gt;</font>
         &lt;max-ep value="#"/&gt;               <font color="green">&lt;!-- Maximum energy points --&gt;</font>
         &lt;hp-regeneration value="#"/&gt;      <font color="green">&lt;!-- HPs regenerated per second --&gt;</font>
         &lt;ep-regeneration value="#"/&gt;      <font color="green">&lt;!-- EPs regenerated per second --&gt;</font>
         &lt;sight value="#"/&gt;                <font color="green">&lt;!-- How many spaces the unit can see --&gt;</font>
         &lt;armor value="#"/&gt;                <font color="green">&lt;!-- Armor rating (specifically, how many hit points are absorbed by an
                                                attack) --&gt;</font>
         &lt;attack-strength value="#"/&gt;      <font color="green">&lt;!-- How many HPs of damage are done by an attack --&gt;</font>
         &lt;effect-strength value="#"/&gt;      <font color="green">&lt;!-- A multiplier applied to the effects that are generated by a unit.  The
                                                base amount is 100%.  If an upgrade supplies (for example) 20 to this
                                                field, it will add to the current effect-strength of the unit, resulting
                                                in 120%, making all of their effects 20% more powerful than before. --&gt;</font>
         &lt;attack-percent-stolen value="#"/&gt;<font color="green">&lt;!-- How much of the damage dealt by this unit will be transfered into the
                                                unit's own hit points, healing them. --&gt;</font>
         &lt;attack-range value="#"/&gt;         <font color="green">&lt;!-- The maximum distance the unit can attack enemy units from. --&gt;</font>
         &lt;move-speed value="#"/&gt;           <font color="green">&lt;!-- Movement speed --&gt;</font>
         &lt;attack-speed value="#"/&gt;         <font color="green">&lt;!-- Attack speed, the higher the number, the faster the attacks. --&gt;</font>
         &lt;production-speed value="#"/&gt;     <font color="green">&lt;!-- How fast the unit is able to produce other units by either summoning,
                                                creating, etc. or by building. --&gt;</font>
         &lt;repair-speed value="#"/&gt;         <font color="green">&lt;!-- How fast the unit is able to repair other units. --&gt;</font>
         &lt;harvest-speed value="#"/&gt;        <font color="green">&lt;!-- How fast the unit is able to harvest resources. --&gt;</font>
     &lt;/static-modifiers&gt;
 
     <font color="green">&lt;!-- Multipliers are make relative adjustments to a stat based upon it's current value.  When more than one
          multiplier are applied to a unit stats, the multipliers are first added together (i.e., multiplier1 - 1.0
          + multiplier2 - 1.0, etc.) and not multiplied together. The same stats specified in &lt;static-modifiers&gt; can be
          modified under &lt;multipliers&gt;, except that you pass a multiplier instead of a static value.  These nodes do not
          accept value in percentage form (i.e., base 1.0 and not 100).
          ALSO APPEARS IN: [[GAE/Reference#.3Ceffect.3E|&lt;effect&gt;]], [[GAE/Reference#.3Cemanations.3E|&lt;enamation&gt;]] tags in [[GAE/Unit_XML|unit.xml]]
          SEE ALSO: [[GAE/Reference]]
          RELATED SOURCE CODE: [http://glest.codemonger.org/docs/gae/classGlest_1_1Game_1_1EnhancementTypeBase.html Glest::EnhancementTypeBase] class --&gt;</font>
     &lt;multipliers&gt;
         <font color="green">&lt;!-- As an example the below will add 25% to the unit's movement speed.  If another upgrade, effect or
          emanation also supplies a 25% bonus to movement speed, the total multiplier will be 1.5, or +50%, not 1.5625
          (as 125% x 125% would result in). --&gt;</font>
         &lt;move-speed value="1.25"/&gt;        
     &lt;/multipliers&gt;
 
     <font color="green">&lt;!-- Restrict an upgrade to only be available in a specific list of subfactions.  If not supplied, the default is
          all subfactions.  If present, however, the default list is erased and the upgrade will only be available in
          the subfactions you list.  Note that the syntax for this is the same for units and commands.
          RELATED SOURCE CODE: [http://glest.codemonger.org/docs/gae/classGlest_1_1Game_1_1RequirableType.html Glest::RequirableType] class --&gt;</font>
     &lt;subfaction-restrictions&gt;
         &lt;subfaction name="subfaction_name"/&gt; <font color="green">&lt;!-- The subfaction name defined in faction.xml or "base" (note that
             the base faction, without having advance to a subfaction that you defined, is actually considered the
             "base" subfaction. --&gt;</font>
     &lt;/subfaction-restrictions&gt;
 
     <font color="green">&lt;!-- Causes this upgrade to "advance" the subfaction from it's current state to the specified subfaction.  This is
          the node that essentially causes a faction to morph into an altered faction, or even a completely different
          one.  This tag can also be used on any unit or unit's command.  If is-immediate is true, the change will
          occur as soon as the upgrade is started, if false, then it will occur when the upgrade is completed.
          RELATED SOURCE CODE: [http://glest.codemonger.org/docs/gae/classGlest_1_1Game_1_1ProducibleType.html Glest::ProducableType] and [http://glest.codemonger.org/docs/gae/classGlest_1_1Game_1_1FactionType.html Glest::FactionType] classes --&gt;</font>
     &lt;advances-to-subfaction name="subfaction_name" is-immediate="boolean"/&gt;
 
 &lt;!-- /GAE Only --&gt;</font>
 
 </upgrade>

See also Glest::ProducibleType class in source code.

Back to [[GAE/XML|GAE XML Reference]]