Changes between Initial Version and Version 1 of XML.Entity.Traits.Supply

Timestamp:

Feb 23, 2008, 4:19:00 AM (16 years ago)

Author:

trac

Comment:

--

XML.Entity.Traits.Supply

@@ +1 @@
+An object with this attribute contains some kind of resource which can be harvested (generically known as "Supply"). 
+
+'''Example:'''
+
+{{{
+        <Traits>
+                <Supply
+                        max="50"
+                        type="food"
+                        subtype="fruit"
+                        
+                        regen="?"
+                        decay="?"
+                        vacant="?"
+                        lootondeath="0.9"
+                />
+        </Traits>
+}}}
+----
+
+= Max =
+''BRIEF DESCRIPTION ::''The maximum base number of supply the object can have.
+
+Note: A value of zero means that the entity has unlimited supply (no matter how much an entity gathers from it, the entity will never run out of supply).
+
+When the entity is initialised, the property '''Traits.Supply.Curr''' is also generated. This contains the entity's current level of supply (equal to '''Traits.Supply.Max''' by default).
+
+(Some objects start with less than their full supply; Traders for example.)
+
+= Type =
+''BRIEF DESCRIPTION ::'' When an object gathers supply from this object, it is allocated to the specified Resource Pool. Options are:
+
+ * ''Food''
+ * ''Wood''
+ * ''Stone''
+ * ''Ore''
+
+= !SubType =
+''BRIEF DESCRIPTION ::'' Identifies what kind of resource is supplied. The gathering object must have an equivalent '''Actions.Gather.!SubType''' string in order to be able to gather from this supply object.
+
+''Note that if no subtype is specified (for Wood, Stone, etc), the subtype will be initialised to contain the same value as the type.''
+
+= Decay =
+''BRIEF DESCRIPTION ::'' The entity's supply quantity reduces over time (for example, a decaying animal corpse) at this rate in seconds. 
+
+'''Not yet implemented.''' 
+
+Example:
+
+ * 1 - Entity loses 1 Supply every second.
+ * 2 - Entity loses 2 Supply every second.
+ * 30 - Entity loses 30 Supply every second.
+
+= Regen =
+''BRIEF DESCRIPTION ::'' The object regenerates supply at this rate until it reaches its '''Traits.Supply.Max''' maximum.
+
+'''Not yet implemented.''' 
+
+= Vacant =
+''BRIEF DESCRIPTION ::'' The supply object must have someone gathering from it in order to retain its resources. 
+
+'''Not yet implemented.''' 
+
+This value determines the amount of unattended time that can elapse before its supply begins to decay (see '''Traits.Supply.Decay''').
+
+= !LootOnDeath =
+''BRIEF DESCRIPTION ::'' A percentage (eg 10%, 100%), expressed as a value from 0..1, of the entity's current Supply is added to the Resource Pool of the opponent that kills this entity.
+
+'''Not yet implemented.''' 
+
+= Notes: Resources =
+
+== Nature of Resources ==
+
+=== Finite Resources ===
+
+All resources are ''finite.'' A resource object contains a specified number of resources, and once these have been removed from the resource object, the resource object is exhausted (unless it has some means of being replenished). 
+
+=== Non-Shuttling Economy ===
+
+''Econ units do not shuttle resources back to the player's base.'' Instead, as long as they are assigned to a resource, the resources will be transferred from the resource object to the player's Resource Pool without being carried by the unit (similar to '''Rise of Nations'''). 
+
+The unit will remain at the resource and gather until the resource is exhausted or destroyed, the unit is threatened, or another command is given to the unit. 
+
+When a resource is exhausted, the unit will attempt to find another nearby resource within the LOS of the Resource Centre to continue his gathering task. (If resources are exhausted within the area of influence of a given Resource Centre, then a new one will have to be constructed to further enable gathering.) 
+
+As with other economic abilities, multiple units can typically be assigned to gather in an area, but the benefits of each additional unit decreases exponentially.
+
+The feedback loop has been removed in order to decrease the costly pathfinding and AI calculations necessary to maintain econ units on gather routes, especially over long distances. 
+
+=== Resource Gathering Structures ===
+
+Most resources require that a resource-gathering structures be constructed within range of the resource object in order to gather from it. 
+
+There is typically a limit to the number of such structures that may built within each Province, and/or a limit to the number of units that can be assigned to any resource-gathering structure, which helps to control the acquisition of resources. 
+
+=== Resource Gathering Appearance ===
+
+When gathering resources, Citizen Soldiers lose the accoutrements of war and are equipped with the appropriate tool for their task (such as a hoe when harvesting a Field), if any, much like '''AoK''' villagers. Once removed from these tasks or ordered to attack (or responding to the threat of enemy attack), their weapons and shields are restored. 
+
+Units will move from tile to tile when tilling a Field or tending to animals in a Corral, as part of their gathering animation, but other units gathering Wood, Stone, or Ore, will only move from tile to tile when moving from an exhausted object to the next closest resource object. 
+
+=== Trading Resources ===
+
+In addition to the Gather Methods stated below, the resources can also be acquired through: 
+
+a] 2:1 trading at a Trade Centre, 
+b] placing Traders or Merchantmen on a trade route, 
+c] or through tribute using the Diplomacy Panel. 
+
+=== Salvage Reward ===
+
+The player gains a small resource bonus when he destroys an enemy (quantity depending on the unit/structure destroyed).. 
+
+== Resource Types ==
+
+There are four resources that the player will need to harvest in order to accomplish his goals. 
+
+=== Food ===
+
+'''Purpose:''' Food is a primary requirement to train units, and is also necessary for most tech research and advancement. 
+
+'''Gather Methods:''' 
+ * ''Hunt Animals'' in the wild. Unit requires Hunt ability.
+ * ''Milk Domestic Animals'' in a Corral. 
+ * ''Farm crops from a Field''. 
+
+=== Wood ===
+
+'''Purpose:''' Wood is used to construct wooden structures, siege engines and ships, and outfit units with wooden weapons and equipment.   
+
+'''Gather Methods:''' 
+ * ''Chop down Trees''. A Resource Centre must be built within range of a Tree in order for gatherers to gather from it. 
+
+=== Stone ===
+
+'''Purpose:''' Stone is used to construct stone structures (particularly base defenses), and outfit units with stone weapons and equipment. 
+
+'''Gather Methods:''' 
+ * ''Mine Stone''. A Resource Centre must be built within range of mineable Rocks in order for gatherers to gather from it. 
+
+=== Ore ===
+
+'''Purpose:''' Ore (an unrefined combination of precious minerals and metals) is used to outfit units with metal weapons and equipment. Similar to gold in other games, it is also used to purchase services and commodities, and fund expensive research projects. 
+
+'''Gather Methods:''' 
+ * ''Mine Deposits''. A Resource Centre must be built within range of a Deposit in order for gatherers to gather from it. 
+
+=== Population ===
+
+'''Purpose: '''Limits the number of units that a player can have at any time. ''Each unit in the game (other than ships, which do not count towards population) occupies one population slot, regardless of its type.'' 
+
+Consists of: 
+a] Population (the number of units currently in existence); 
+b] Population Limit (the number of units that a player can currently support); and 
+c] Population Cap (the upper limit on the number of units a player can have at any time, regardless of how much the player increases his Population Limit). 
+
+'''Gather Methods:''' 
+ * ''Housing''. Construct structures that increase Population Limit, such as Houses. 
+
+== Resource Gathering Rates and Civ Bonuses ==
+
+To further distinguish them, each civilisation has a unique bonus when using a particular resource gathering method. See the attached table for full attributes of this feature. 
+<table border="1" bordercolor="#000000"><tr> <td> ''Resource''</td> <td> ''Res/sec''</td> <td> ''Civ w/ bonus''</td> <td> </tr> 
+<tr> <td> Hunting (any kill)</td> <td> 0.410</td> <td> Carthaginians</td> </tr> 
+<tr> <td> Animal Husbandry (milking)--Female</td> <td> 0.320</td> <td> Greeks</td> </tr> 
+<tr> <td> Animal Husbandry (milking)--Male</td> <td> 0.310</td> <td> Greeks</td> </tr> 
+<tr> <td> Animal Husbandry--Male w/ Female Aura</td> <td> 0.315</td> <td> Greeks</td> </tr> 
+<tr> <td> Field Farming--Female</td> <td> 0.320</td> <td> Persians</td>  </tr> 
+<tr> <td> Field Farming--Male</td> <td> 0.310</td> <td> Persians</td> </tr> <tr> <td> Field Farming&Male w/ Female Aura</td> <td> 0.315</td> <td> Persians</td> </tr> 
+<tr> <td> Ore (mining)</td> <td> 0.379</td> <td> Romans</td> </tr> 
+<tr> <td> Ore w/ !OreMining Tech</td> <td> 0.435</td> <td> Romans</td>  </tr> 
+<tr> <td> Ore w/ !OreShaft Mining Tech</td> <td> 0.500</td> <td> Romans</td> </tr> 
+<tr> <td> Stone (mining)</td> <td> 0.359</td> <td> Iberians</td> </tr> 
+<tr> <td> Stone w/ Stone Mining Tech</td> <td> 0.412</td> <td> Iberians</td> </tr> 
+<tr> <td> Stone w/ Stone Shaft Mining Tech</td> <td> 0.473</td> <td> Iberians</td> </tr> 
+<tr> <td> Tree Woodcutting</td> <td> 0.388</td> <td> Celts</td> </tr> 
+<tr> <td> Tree Woodcutting w/ Double Bit Axe Tech</td> <td> 0.465</td> <td> Celts</td> </tr> 
+<tr> <td> Tree Woodcutting w/ Bow Saw Tech</td> <td> 0.556</td> <td> Celts</td></tr> 
+<tr> <td> Tree Woodcutting w/ Two Man Saw Tech</td> <td> 0.613</td> <td> Celts</td> </tr> 
+<tr> <td> <i>Note: Female Citizen casts "Allure Aura" over nearby male units to the extent of her LOS causing their gather rate to increase of +.005 Res/sec while under her influence. A corresponding rate of increase is effected for other resource gathering activities, except hunting, if she has male workers within her area of influence (LOS).
+</table>