View source for Gamedev:FeatureDefs

==Location==
FeatureDef files are .lua files stored in the <code>Features/</code> directory of a Spring Game.

==Purpose==
FeatureDef files have one purpose; to define the properties of features. They are the main description file for what attributes your features should have and how units interact with them.

==Source==
The engine source code which loads the tags from these files is viewable here:

* {{sourcelink|file=rts/Sim/Features/FeatureHandler.cpp}}

==Data Types==
{{DataTypes}}

==Details==
There follows a comprehensive list of the tags available, their data type, default value and a brief description of what they do. Bear in mind that the source code linked above is the ultimate reference when dealing with these tags. 

In lua tables keys (i.e. the tags) should be lower case, here they are represented in camelCase for readability. In your files you may use the <code>lowerkeys</code> function on your final table to ensure the keys are properly cased.

It is usual to name the returned FeatureDef table the internal <code>featureName</code> desired for the unit.

===General===
{{tag
|name = description
|type = string
|default = ""
|description = This is the tooltip description of the feature seen by the player.
}}

{{tag
|name = damage
|type = float
|default = 0.0
|description = How much damage this feature can take before being destroyed. Analogous to {{xtaglink|Gamedev:UnitDefs|maxDamage}} for units.
}}

{{tag
|name = featureDead
|type = string
|default = ""
|description = The <code>featureName</code> of the feature to spawn when this feature is destroyed. Used to make chains of features which 'disintegrate' as they are further damaged. Analogous to {{xtaglink|Gamedev:UnitDefs|corpse}} for units.
}}

{{tag
|name = indestructible
|type = bool
|default = false
|description = Can the feature be destroyed or not? If <code>true</code> the feature will not even take damage.
}}

{{tag
|name = flammable
|type = bool
|default = false (true for engine trees)
|description = Can the feature be set on fire? The size of the flame particle is determined by the model radius. The duration of the fire in [[frames]] is a random number in the range [200, 230].
}}

{{tag
|name = noSelect
|type = bool
|default = false
|description = If <code>true</code> the cursor won't change to `reclaim` when hovering the feature.
}}

{{tag
|name = mass
|type = float
|default = 0.4 * metal + 0.1 * damage
|description = The mass of the feature, used in unit/feature crushing calculations (See [[Movedefs.lua]]). Minimum value is <code>1.0</code>.
}}

{{tag
|name = crushResistance
|type = float
|default = mass
|special ={{new|85.0}}
|description = How resistant is the feature to being crushed? Any [[Movedefs.lua|'''MoveClass''']] with a {{xtaglink|Movedefs.lua|crushStrength}} greater than this will crush the feature.
}}

===Visual===
{{tag
|name = object
|type = string
|default = ""
|lua = modelname
|description = The filename of the 3D model file for this unit, assumes <code>Objects3D/</code> directory. Analagous to {{xtaglink|Gamedev:UnitDefs|objectName}} for units.
}}

{{tag
|name = smokeTime
|type = int
|default = 300
|description = How many frames a corpse feature should emit smoke for after unit death.
}}

{{tag
|name = drawType
|type = int
|default = 0
|description = What kind of drawing type is the feature. Can be <code>0</code> - A loaded model, <code>-1</code> - Nothing rendered for this feature at all (used for geovents), values >= <code>1</code> are used for the engine default trees. Generally speaking you should ignore this tag.
}}

===Reclaim & Resources===
{{tag
|name = reclaimable
|type = bool
|default = true if not {{taglink|indestructible}}, false otherwise
|description = Can this feature be reclaimed by a construction unit?
}}

{{tag
|name = autoReclaimable
|type = bool
|default = reclaimable
|description = Should this feature be reclaimed by a construction unit executing a patrol or area-reclaim command?
}}

{{tag
|name = reclaimTime
|type = float
|default = (metal + energy) * 6.0
|description = The time taken to reclaim this feature. Related to unit {{xtaglink|Gamedev:UnitDefs|reclaimSpeed}} such that <code>Time taken to reclaim = feature reclaimTime / unit reclaimSpeed</code>.
}}

{{tag
|name = metal
|type = float
|default = 0.0
|description = How much metal resource this feature gives the player when reclaimed.
}}

{{tag
|name = energy
|type = float
|default = 0.0
|description = How much energy resource this feature gives the player when reclaimed.
}}

{{tag
|name = resurrectable
|type = int
|default = -1
|description = Can this feature be resurrected back into a living unit? Can be the following values <code>-1</code> - Only resurrectable if it is the 1st level {{xtaglink|Gamedev:UnitDefs|corpse}} of the [[Gamedev:UnitDefs|UnitDef]], <code>0</code> - Not resurrectable, <code>1</code> - Always ressurrectable.
}}

{{tag
|name = geoThermal
|type = bool
|default = false
|special={{new|83.0}}
|description = Does this feature act as a geothermal vent?
}}

===Placement===
{{tag
|name = footprintX
|type = int
|default = 1
|description = How wide the feature is in footprint units, left to right. 1 footprint unit = 16 [[elmo]]s. Cannot be below <code>1</code>.
}}

{{tag
|name = footprintZ
|type = int
|default = 1
|description = How wide the feature is in footprint units, top to bottom. 1 footprint unit = 16 [[elmo]]s. Cannot be below <code>1</code>.
}}

{{tag
|name = blocking
|type = bool
|default = true
|description = Does this feature block the movement of units or can they pass right through it? Features that are non-blocking are also ignored by weapon aiming.
}}

{{tag
|name = upright
|type = bool
|default = false
|description = Does the feature tilt with the slope of the terrain or remain upright?
}}

{{tag
|name = floating
|type = bool
|default = false
|special = {{new|90.0}}
|description = Does this feature float on the top of water or is it placed on the seabed?
}}

===Decals===
{{tag
|name = useBuildingGroundDecal
|type = bool
|default = false
|description = For structures, do they display a ground decal on the terrain under their model?}}

{{tag
|name = buildingGroundDecalType
|type = string
|default = ""
|description = The filename of the image to be used as ground decal. Assumed to be in <code>Unittextures/</code>.}}

{{tag
|name = buildingGroundDecalSizeX
|type = int
|default = 4
|description = How wide the decal is left to right, in footprint units.}}

{{tag
|name = buildingGroundDecalSizeY
|type = int
|default = 4
|description = How wide the decal is top to bottom, in footprint units.}}

{{tag
|name = buildingGroundDecalDecaySpeed
|type = float
|default = 0.1
|description = A measure of how quickly the decal should fade out if the structure dies. Essentially this value is multiplied by the time since death and subtracted from the original alpha until the decal is fully transparent.}}

===Collision Volumes===
See [[Gamedev:UnitDefs#Collision_Volumes]].

===Selection Volumes===
See [[Gamedev:UnitDefs#Selection_Volumes]].

===Other===

==Sub Tables==

===customParams===
The <code>customParams</code> subtable of a FeatureDef allows the game designer to give their features custom attributes, which can then be accessed via lua gadgets and widgets. It is a map (key-value pair indexed table) of strings. When accessing these attributes in lua the strings can be turned back into numbers, bools or even tables. This gives great control to game designers to essentially implement their own behaviour tags.

There are no additional tags specific to this subtable.

===collisionVolume===
See [[Gamedev:UnitDefs#collisionVolume]].

===selectionVolume===
See [[Gamedev:UnitDefs#selectionVolume]].

==Examples==
Many games include unit corpse features into the UnitDef (See [[Gamedev:UnitDefs#Examples]])

{{ExampleRepoLinks
|path = features/
|entity = FeatureDefs
}}

[[Category: Game Dev]]