Modrules.lua

2013-02-25T18:10:19Z

Smoth: Alphabetized and spaced out a bit. Sorry this page was unwieldy

==Location==
<code>modrules.lua</code> is a file in the <code>Gamedata/</code> directory of a Spring game.

==Purpose==
This file controls various global parameters of the game, for example how fast units gain experience, what unit types can be transported, how fine grained the LOS system is, etc.

==Source==
The engine source code which parses the data from this file is viewable here:{{sourcelink|file=rts/Sim/Misc/ModInfo.cpp}}

==Details==
<code>Modrules.lua</code> is divided into several sub-tables containing tags specific to each section, as follows:

===capture===
{{tag
|name = energyCostFactor
|type = float
|default = 0.0
|description = How much of the original energy cost it requires to capture something.
}}

===construction===
{{tag
|name = constructionDecay
|type = bool
|default = true
|description = Do uncompleted building frames begin to decay if no builder is working on them?
}}

{{tag
|name = constructionDecayTime
|type = float
|default = 6.66
|description = The time in seconds before abandoned building frames begin to decay.
}}

{{tag
|name = constructionDecaySpeed
|type = float
|default = 0.03
|description = How fast build progress decays for abandoned building frames. Note that the rate is inversely proportional to the {{xtaglink|Units-UnitDefs|buildtime}} i.e. a building with a larger {{xtaglink|Units-UnitDefs|buildtime}} will decay more slowly for a given value of this tag than a building with a shorter {{xtaglink|Units-UnitDefs|buildtime}}.
}}

===experience===
{{tag
|name = experienceMult
|type = float
|default = 1.0
|description = Controls the amount of experience gained by units engaging in combat. The formulae used are:
::<code>xp for damage = 0.1 * experienceMult * damage / target_HP * target_power / attacker_power</code>
::<code>xp for kill = 0.1 * experienceMult * target_power / attacker_power</code>.
: Where {{xtaglink|Units-UnitDefs|power}} can be set by the UnitDef tag.
}}

{{tag
|name = powerScale
|type = float
|default = 1.0
|description = Controls how gaining experience changes the relative {{xtaglink|Units-UnitDefs|power}} of the unit. The formula used is <code>Power multiplier = powerScale * (1 + xp / (xp + 1))</code>.
}}

{{tag
|name = healthScale
|type = float
|default = 0.7
|description = Controls how gaining experience increases the {{xtaglink|Units-UnitDefs|maxDamage}} (total hitpoints) of the unit. The formula used is <code>Health multiplier = healthScale * (1 + xp / (xp + 1))</code>.
}}

{{tag
|name = reloadScale
|type = float
|default = 0.4
|description = Controls how gaining experience decreases the {{xtaglink|Units-UnitDefs|reloadTime}} of the unit's weapons. The formula used is <code>Rate of fire multiplier = reloadScale * (1 + xp / (xp + 1))</code>.
}}

===featureLOS===
{{tag
|name = featureVisibility
|type = int
|default = 3
|description = Controls the visibility of features. Can be <code>0</code> - no default LOS for features, <code>1</code> - Gaia features always visible, <code>2</code> - allyteam & Gaia features always visible, or <code>3</code> - all features always visible.
}}

===fireAtDead===
{{tag
|name = fireAtKilled
|type = bool
|default = false
|description = Will units continue to target and fire on enemies which are running their <code>Killed()</code> animation? (See [[Animation-LuaCallins#Generic]])
}}

{{tag
|name = fireAtCrashing
|type = bool
|default = false
|description = Will units continue to target and fire on enemy aircraft which are in the 'crashing' state? (See [[Lua_SyncedCtrl#Unit_Control]])
}}

===flankingBonus===
For a deeper explanation of the flanking system, see [[Units:FlankingBonus]].

{{tag
|name = defaultMode
|type = int
|default = 1
|description = The default {{xtaglink|Units-UnitDefs|flankingBonusMode}} for units. Can be <code>0</code> - No flanking bonus. Mode <code>1</code> builds up the ability to move over time, and swings to face attacks, but does not respect the way the unit is facing. Mode <code>2</code> also can swing, but moves with the unit as it turns. Mode <code>3</code> stays with the unit as it turns and otherwise doesn't move, the ideal mode to simulate something such as tank armour.
}}

====los====
{{tag
|name = losMipLevel
|type = int
|default = 1
|description = Controls the resolution of the LOS calculations. A higher value means lower resolution but increased performance. An increase by one level means half the resolution of the LOS map in both x and y direction. Must be between <code>0</code> and <code>6</code> inclusive.
}}

{{tag
|name = losMul
|type = float
|default = 1.0
|description = Multiplies all unit's {{xtaglink|Units-UnitDefs|sightDistance}} by this value. Generally speaking you should always use the default.
}}

{{tag
|name = airMipLevel
|type = int
|default = 2
|description = Controls the resolution of the LOS vs. aircraft calculations. A higher value means lower resolution but increased performance. An increase by one level means half the resolution of the air-LOS map in both x and y direction. Must be between <code>0</code> and <code>30</code> inclusive.
}}

{{tag
|name = airLosMul
|type = float
|default = 1.0
|description = Multiplies all unit's {{xtaglink|Units-UnitDefs|airSightDistance}} by this value. Generally speaking you should always use the default.
}}

===movement===
{{tag
|name = allowAirPlanesToLeaveMap
|type = bool
|default = true
|description = Are (gunship) aircraft allowed to fly outside the bounds of the map?
}}

{{tag
|name = allowAircraftToHitGround
|type = bool
|default = true
|special = {{new|90.0}}
|description = Are aircraft allowed to hit the ground whilst manoeuvring?
}}

{{tag
|name = allowPushingEnemyUnits
|type = bool
|default = false
|special = {{new|83.0}}
|description = Can enemy ground units push each other during collisions?
}}

{{tag
|name = allowCrushingAlliedUnits
|type = bool
|default = false
|special = {{new|85.0}}
|description = Can allied ground units crush each other during collisions? Units still have to be explicitly set as crushable using the <code>crushable</code> parameter of [[Lua_SyncedCtrl#Unit_Control|Spring.SetUnitBlocking]].
}}

{{tag
|name = allowUnitCollisionDamage
|type = bool
|default = false
|special = {{new|85.0}}
|description = Do unit-unit (skidding) collisions cause damage?
}}

{{tag
|name = allowUnitCollisionOverlap
|type = bool
|default = true
|special = {{new|89.0}}
|description = Can mobile units collision volumes overlap one another? Allows unit movement like [http://www.youtube.com/watch?v=mRtePUdVk2o this (video)] at the cost of more 'clumping'.
}}

{{tag
|name = allowGroundUnitGravity
|type = bool
|default = true
|special = {{new|92.0}}
|description = Allows fast moving mobile units to 'catch air' as they move over terrain.
}}

{{tag
|name = allowHoverUnitStrafing
|type = bool
|default = true if using QTPFS pathfinder
|special = {{new|92.0}}
|description = Allows hovercraft units to slide in turns.
}}

{{tag
|name = useClassicGroundMoveType
|type = bool
|default = false
|special = {{new|89.0}}
|description = A ticket back to unit movement circa 2009: no reversing, no {{xtaglink|Units-UnitDefs|turninplace|false}}, no smooth collision handling, no nothing. For comparison of pathfinding code.
}}

===nanospray===
{{tag
|name = allow_team_colors
|type = bool
|default = true
|description = Are players allowed to use teamcolour nanospray? Set by the <code>TeamNanoSpray</code> key in the [[Springrc|config file]].
}}

===paralyze===
{{tag
|name = paralyzeOnMaxHealth
|type = bool
|default = true
|description = Are units paralyzed when the level of emp is greater than their current health or their maximum health?
}}

===reclaim===
{{tag
|name = multiReclaim
|type = int
|default = 0
|description = Can multiple units reclaim a feature or only one? <code>0</code> implies the latter, all other values the former.
}}

{{tag
|name = reclaimMethod
|type = int
|default = 1
|description = Controls how features are reclaimed. Can be <code>0</code> - gradual reclaim, <code>1</code> - all reclaimed at end, any other positive value <code>n</code> - reclaim in <code>n</code> chunks.
}}

{{tag
|name = unitMethod
|type = int
|default = 1
|description = Controls how units are reclaimed. Can be <code>0</code> - gradual reclaim, <code>1</code> - all reclaimed at end, any other positive value <code>n</code> - reclaim in <code>n</code> chunks.
}}

{{tag
|name = featureEnergyCostFactor
|type = float
|default = 0.0
|description = How much energy should reclaiming a feature cost? Multiplier against the fraction of the features' {{xtaglink|Units-FeatureDefs|metal}} content reclaimed.
}}

{{tag
|name = unitEnergyCostFactor
|type = float
|default = 0.0
|description = How much energy should reclaiming a unit cost? Multiplier against the fraction of the unit's {{xtaglink|Units-UnitDefs|buildCostEnergy}} reclaimed.
}}

{{tag
|name = unitEfficiency
|type = float
|default = 1.0
|description = How much metal should reclaiming a unit return? Multiplier against the unit's {{xtaglink|Units-UnitDefs|buildCostMetal}}.
}}

{{tag
|name = allowEnemies
|type = bool
|default = true
|description = Can enemy units be reclaimed?
}}

{{tag
|name = allowAllies
|type = bool
|default = true
|description = Can allied units be reclaimed?
}}

===repair===
{{tag
|name = energyCostFactor
|type = float
|default = 0.0
|description = How much of the original energy cost it requires to repair something.
}}

===resurrect===
{{tag
|name = energyCostFactor
|type = float
|default = 0.5
|description = How much of the original energy cost it requires to resurrect something.
}}

===sensors===
{{tag
|name = requireSonarUnderWater
|type = bool
|default = true
|description = If <code>true</code> then when underwater, units only get LOS if they also have sonar.
}}

===system===
{{tag
|name = luaThreadingModel
|type = int
|default = 2
|description = Controls which Lua MT optimizations the mod will use by default, for a more detailed explanation see [[Spring_Multithreaded_Lua#Lua_Threading_Models|here]]. Can be:
::<code>0</code> - No MT, single threaded;
::<code>1</code> - Single state;
::<code>2</code> - Single state, batching of unsynced events;
::<code>3</code> - Dual states for synced, batching of unsynced events, synced/unsynced communication via EXPORT table and SendToUnsynced;
::<code>4</code> - Dual states for synced, batching of unsynced events, synced/unsynced communication via SendToUnsynced only;
::<code>5</code> - Dual states for all, all synced/unsynced communication (widgets included) via SendToUnsynced only;
::<code>6</code> - Dual states for all, all synced/unsynced communication (widgets included) is unmanaged and via SendToUnsynced only.}}

{{tag
|name = pathFinderSystem
|type = int
|default = 0
|special={{new|85.0}}
|description = Which pathfinder does the game use? Can be <code>0</code> - The legacy default pathfinder or <code>1</code> - Quad-Tree Pathfinder System ([[QTPFS]]).}}

===transportability===
{{tag
|name = transportAir
|type = bool
|default = false
|description = Can aircraft be transported?
}}

{{tag
|name = transportShip
|type = bool
|default = false
|description = Can ships be transported?
}}

{{tag
|name = transportHover
|type = bool
|default = false
|description = Can hovercraft be transported?
}}

{{tag
|name = transportGround
|type = bool
|default = true
|description = Can ground units be transported?
}}

{{tag
|name = targetableTransportedUnits
|type = bool
|default = false
|special = {{new|89.0}}
|description = Can transported units be targeted by weapons? <code>true</code> allows both manual and automatic targeting.
}}

==Examples==

===Empty===

<code>modrules.lua</code> can simply return an empty table like this:
<code><pre>
return {}
</pre></code>
If you do this, Spring will use the default values.

===Configurable by modoptions===
Interestingly <code>modrules.lua</code> can read [[Modoptions.lua|modoptions]], so these parameters can be scripted to be configurable from the lobby.
For example to allow selecting either legacy default pathfinder or [[QTPFS]] via a modoption:
<code>
system = {
pathFinderSystem = (Spring.GetModOptions() and (Spring.GetModOptions().qtpfs == "1") and 1) or 0,
},
</code>

===External Examples===
[http://imolarpg.dyndns.org/trac/balatest/browser/trunk/gamedata/modrules.lua 'Balanced Annihilation' Modrules.lua]

[http://trac.caspring.org/browser/trunk/mods/ca/gamedata/modrules.lua 'Complete Annihilation' Modrules.lua]

[http://code.google.com/p/conflictterra/source/browse/games/CT/gamedata/modrules.lua 'Conflict Terra' Modrules.lua]

[https://code.google.com/p/evolutionrts/source/browse/trunk/evolutiondev.sdd/Gamedata/modrules.lua 'Evolution RTS' Modrules.lua]

[http://spring1944.svn.sourceforge.net/viewvc/spring1944/trunk/S44Main.sdd/gamedata/modrules.lua?&view=markup 'Spring: 1944' Modrules.lua]

[http://code.google.com/p/zero-k/source/browse/trunk/mods/zk/gamedata/modrules.lua 'ZeroK' Modrules.lua]

[[Category:Game development]]
[[Category:gamedata]]

Talk:Mapdev:skybox

2012-12-21T06:09:43Z

Smoth: Created page with "not 100% sure that was the skybox tiles for THAT skybox but it is pretty damn close."

not 100% sure that was the skybox tiles for THAT skybox but it is pretty damn close.

Mapdev:skybox

2012-12-21T05:58:40Z

Smoth: /* Sky Box */

= Sky Box =
Is a [http://en.wikipedia.org/wiki/Cube_mapping cubemap] projection of a skyline used to enhance the background of the map.
<center>
{| class="wikitable"
|+ Example
| [[File:Skyboxsimple.gif|256px]] || [[File:Cloudysunset.jpg|256px]]
|-
! Example cube cross before assembling to dds cubemap format !! Ingame Result
|}</center>

= Location of File =
Relative to the root directory of the map:
: ./maps/skybox.dds

= Specification =
== mapinfo.lua ==
The relevant sections of the mapinfo.lua file that effect the colour of the ground are in the [[Map_Making:mapinfo.lua#Atmosphere|atmosphere subtable]]

<code><pre>
local mapinfo = {
...
atmosphere = {
...
skyBox = "",
...
},
...
}
</pre></code>

= Additional Information =
== Howto's ==
* [[Mapdev:Howto_skybox]]
* [http://judegodin.wordpress.com/2011/12/06/how-the-hell-do-i-make-a-cubemap/ howto with 3dsmax]

[[Category:Mapdev]]
[[Category:Development]]

File:Cloudysunset.jpg

2012-12-21T05:57:58Z

Smoth: Skybox example image

Skybox example image

Animation-LuaCallouts

2012-10-29T06:32:56Z

Smoth: /* Effects */

== Introduction ==

The new callouts are defined in the Spring.UnitScript table.

Types for arguments are only shown where they're ambiguous. For a number of (common) arguments, the types are:

* unitID: number
* piece: number
* axis: number (1 = x axis, 2 = y axis, 3 = z axis)
* destination: number (elmos, or radians)
* speed: number (elmos, or radians per second)
* accel/decel: number (radians per second per frame)

== Animation ==

'''Spring.UnitScript.SetPieceVisibility''' ( piece, boolean visible ) -> nil 
'''Spring.UnitScript.Show''' ( piece ) -> nil 
'''Spring.UnitScript.Hide''' ( piece ) -> nil

These may be used to show/hide pieces of the unit's model.

'''Spring.UnitScript.Move''' ( piece, axis, destination[, speed] ) -> nil

Move piece along axis to the destination position. If speed is given, the piece isn't moved immediately, but will move there at the desired speed. The X axis is mirrored compared to BOS/COB scripts, to match the direction of the X axis in Spring world space.

'''Spring.UnitScript.Turn''' ( piece, axis, destination[, speed] ) -> nil

Turn piece around axis to the destination angle. If speed is given, the piece isn't rotated immediately, but will turn at the desired angular velocity. Angles are in radians.
Always uses the shortest angular towards destinationdegree, and if at exactly 180 degrees opposide, will go counterclockwise.

'''Spring.UnitScript.Spin''' ( piece, axis, speed[, accel] ) -> nil

Makes piece spin around axis at the desired angular velocity. If accel is given, the piece does not start at this velocity at once, but will accelerate to it. Both negative and positive angular velocities are supported. Accel should always be positive, even if speed is negative.

Beware gimbal lock: http://en.wikipedia.org/wiki/Gimbal_lock

'''Spring.UnitScript.StopSpin''' ( piece, axis[, decel] ) -> nil

Stops a piece from spinning around the given axis. If decel is given, the piece does not stop at once, but will decelerate to it. Decel should always be positive. This function is similar to Spin(piece, axis, 0, decel), however, StopSpin also frees up the animation record.

'''Spring.UnitScript.IsInTurn''' (number piece, number axis) -> boolean 
'''Spring.UnitScript.IsInMove''' (number piece, number axis) -> boolean 
'''Spring.UnitScript.IsInSpin''' (number piece, number axis) -> boolean

Returns true if such an animation exists, false otherwise.

'''Spring.UnitScript.GetPieceTranslation''' ( piece ) -> number x, y, z 
'''Spring.UnitScript.GetPieceRotation''' ( piece ) -> number x, y, z

Get the current translation/rotation of a piece. The returned numbers match the values passed into Move and Turn.

'''Spring.UnitScript.GetPiecePosDir''' ( piece ) -> number px, py, pz, dx, dy, dz

Get the piece's position (px, py, pz) and direction (dx, dy, dz) in '''unit space'''. This is quite similar to ''Spring.GetUnitPiecePosDir'', however that function returns in '''world space'''.

== Threads ==

'''Spring.UnitScript.StartThread''' ( function fun, ... ) -> nil

Starts a new (animation) thread, which will execute the function 'fun'. All arguments except the function to run are passed as-is as arguments to 'fun'. [[Animation-CobThreads|COB-Threads]] has a decent description on COB threads, which are mimicked here in Lua using coroutines.

'''Spring.UnitScript.SetSignalMask''' ( number mask ) -> nil 
'''Spring.UnitScript.Signal''' ( number signal ) -> nil

These two support functions offer a powerful way to kill running threads. SetSignalMask assigns a mask to the currently running thread (any new threads started by this one will inherit the signal mask). Signal immediately stops all threads of this unit for which the bitwise and of mask and signal is not zero.

[http://springrts.com/phpbb/viewtopic.php?f=14&t=26274&start=2| What signal will stop which threads?]

'''Spring.UnitScript.WaitForMove''' ( piece, axis ) -> nil 
'''Spring.UnitScript.WaitForTurn''' ( piece, axis ) -> nil

Waits until the piece has stopped moving along / turning around the axis. If the piece is not animating, this functions return at once. You can not wait for a spin, because a spin does never finish.

'''Spring.UnitScript.Sleep''' ( number milliseconds ) -> nil

Waits a number of milliseconds before returning.

== Effects ==

'''Spring.UnitScript.EmitSfx''' ( piece, number id ) -> nil

Emits a [[CEG]] effect or weapon from the given piece. The id is based on one of the effect or weapon ids defined in the units unitdef. 
Example:

<pre>
--get the id of the CEG effects:
local smokecloud = SFX.CEG --the first effect from the list in the unitdef
local smokecloud2 = SFX.CEG +1 --the second effect from the list in the unitdef
local fire = SFX.CEG +2 --the third effect from the list in the unitdef
--get the id of the emiter piece:
local turret = piece "turret"
EmitSfx(turret, smokecloud) --emit the first effect
</pre>

'''Spring.UnitScript.ShowFlare''' ( number piece ) -> nil

Same as COB's show _inside_ FireWeaponX.

'''Spring.UnitScript.Explode''' ( piece, number flags ) -> nil

Explodes a piece, optionally creating a particle which flies off. Typically used inside Killed. Explode does not hide the piece by itself; if using it outside Killed you may want to Hide the piece immediately after. The flags may be any combination of:
* '''SFX.NONE''': do nothing after creating a heatcloud. Other flags have no effect, except NO_HEATCLOUD. If that is given too, the call is a no-op.
* '''SFX.SHATTER''': shatter the piece in many fragments. Only the NO_HEATCLOUD flag has any effect if this is present.
* '''SFX.EXPLODE''' | '''SFX.EXPLODE_ON_HIT''': the piece that flies of should explode when it hits something.
* '''SFX.FALL''': the piece should be affected by gravity (this is currently always forced on by Spring, to prevent pieces that float in air indefinitely).
* '''SFX.SMOKE''': leave smoke trail.
* '''SFX.FIRE''': the piece is on fire when it flies off.
* '''SFX.NO_CEG_TRAIL''': disable a CEG trail, if present.
* '''SFX.NO_HEATCLOUD''': suppress the heat cloud that's shown by default.

== Other ==

'''Spring.UnitScript.AttachUnit''' ( piece, passengerID ) -> nil 
'''Spring.UnitScript.DropUnit''' ( passengerID ) -> nil

Attaches or detaches another unit (a passenger, as this is designed for transports) to this unit. For AttachUnit, piece specifies the attachment point.

'''Spring.UnitScript.GetUnitValue''' ( ... ) -> number | number, number 
'''Spring.UnitScript.SetUnitValue''' ( ... ) -> nil

This may be used instead of COB's get and set codes. It is recommended however, to use dedicated Lua functions (e.g. Spring.GetUnitHealth(unitID) instead of GetUnitValue(4)): these functions should be considered a relic of the past.

Note that these are identical to Spring.GetUnitCOBValue and Spring.SetUnitCOBValue (see also [[Lua_SyncedCtrl#Lua_to_COB]] for the signature of those functions), except that an unitID argument shouldn't be passed to the versions in the Spring.UnitScript table.

'''Spring.UnitScript.GetLongestReloadTime''' ( unitID ) -> number reloadTime

Returns max(reload time) of all the unit's weapons in milliseconds. This utility function exists to aid in porting BOS scripts, which have a SetMaxReloadTime call-in that is called immediately after Create.

== Internal ==

You generally shouldn't need any of the following call-outs, they are provided by the engine to allow the Lua framework to do it's work.

'''Spring.UnitScript.CreateScript''' ( unitID, table callIns ) -> nil

This deletes the unit's current script (whether it's a COB or Lua script doesn't matter), and sets it up with a brand new Lua unit script, initially registering the call-ins given in the table as (string, function) pairs.

'''Spring.UnitScript.UpdateCallIn''' ( unitID, string name[, function callIn] ) -> nil

This updates a single call-in for the unit's current '''Lua''' unit script. If the unit does not currently have a Lua unit script, an error is raised. If the callIn argument is not given (or nil), the call-in with the given name is removed.

'''Spring.UnitScript.CallAsUnit''' ( unitID, function fun, ... ) -> nil

As none of the call-outs takes a unitID, the engine needs to know the ''active unit'' when one of those is called. Using this function another function can be called with the active unit set arbitrarily.

'''Spring.UnitScript.SetDeathScriptFinished''' ( [number wreckLevel] )

Tells Spring the Killed script finished, and which wreckLevel to use. If wreckLevel is not given no wreck is created. May only be called after Killed has been called. DO NOT USE, the framework handles this transparently (it passes the return value of Killed into this function.)
[[Category:Unit_development]]
[[Category:Animation]]
[[Category:Lua]]

Gamedev:UnitDefs

2012-07-08T21:34:15Z

Smoth: /* General */

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

==Purpose==
UnitDef files have one purpose; to define the properties of units. They are the main description file for what attributes your unit should have and how it should behave.

==Source==
The engine source code which loads the tags from these files is viewable here:{{sourcelink|file=rts/Sim/Units/UnitDef.cpp}}

The engine source which reads the [[#sounds]] subtable can be found here:{{sourcelink|file=rts/Sim/Units/UnitDefHandler.cpp}}

==Data Types==
Tags may be one of the following data types:
* <code>int</code> - An integer number
* <code>float</code> - A number with decimals.
* <code>bool</code> - A value which can be <code>true</code> or <code>false</code>.
* <code>string</code> - Text, or more precisely a string of alphanumeric characters.
* <code>float[3]</code> - A vector, with three <code>float</code> components, representing x, y and z axes (y is 'up').

==Details==
There follows a comprehensive (certain deprecated tags are not present) 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 UnitDef table the internal <code>unitName</code> desired for the unit.

===General===
{{tag
|name = name
|type = string
|default = ""
|description = This is simply the name of the unit as it appears to the player.}}

{{tag
|name = description
|type = string
|default = name
|description = This is the tooltip description of the unit seen by the player. It defaults to the <code>name</code> of the unit.}}

{{tag
|name = buildPic
|type = string
|default = ""
|description = The filename of the image(stored in /unitpics/) to be used as the build picture.}}

{{tag
|name = objectName
|type = string
|default = ""
|description = The filename of the 3D model file for this unit, assumes <code>Objects3D/</code> directory.}}

{{tag
|name = script
|type = string
|default = unitName + ".cob"
|description = The filename of the animation script file for this unit, assumes <code>Scripts/</code> directory. Default assumes .cob file but [[Animation-LuaScripting | LUS]] should be preferred.}}

{{tag
|name = maxDamage
|type = float
|default = 0.0
|description = The base 'hitpoints' the unit will have.}}

{{tag
|name = autoHeal
|type = float
|default = 0.0
|description = How much health the unit will regain every second.}}

{{tag
|name = idleAutoHeal
|type = float
|default = 10.0
|description = How much health the unit will regain every second whilst it is idle.}}

{{tag
|name = idleTime
|type = int
|default = 600
|description = The time in [[frames]] taken until a unit is considered to be idle.}}

{{tag
|name = buildCostMetal
|type = float
|default = 1.0
|description = The amount of metal resource the unit costs to build. Cannot be below <code>1.0</code>.}}

{{tag
|name = buildCostEnergy
|type = float
|default = 0.0
|description = The amount of energy resource the unit costs to build.}}

{{tag
|name = buildTime
|type = float
|default = 0.0
|description = The time taken to build the unit, in conjunction with the <code>workerTime</code> of the constructor. Effectively, ''Time to build = unit <code>buildTime</code> / constructor <code>workerTime</code>''. Defaults to <code>0.0</code> but cannot actually be below <code>1.0</code>.}}

{{tag
|name = mass
|type = float
|default = buildCostMetal
|description = The mass of the unit, used in weapon impulse calculations. Cannot be less than <code>1.0</code>.}}

{{tag
|name = reclaimable
|type = bool
|default = true
|description = Can the unit be reclaimed by a builder?}}

{{tag
|name = capturable
|type = bool
|default = true
|description = Can a unit be stolen by a builder using the capture command?}}

{{tag
|name = repairable
|type = bool
|default = true
|description = Can the unit be repaired by a builder?}}

{{tag
|name = maxRepairSpeed
|type = float
|default = 1e20
|description = The maximum cumulative speed at which this unit can be repaired.}}

{{tag
|name = iconType
|type = string
|default = "default"
|description = The name of the radar icon type this unit should use. See [[Icontypes.lua]].}}

{{tag
|name = corpse
|type = string
|default = ""
|description = The name of the feature this unit should leave behind as a wreck when it dies (See [[Units-FeatureDefs]]).}}

{{tag
|name = explodeAs
|type = string
|default = ""
|description = The name of the weapon this unit should explode as when it is killed (See [[Units-WeaponDefs]]).}}

{{tag
|name = selfDestructAs
|type = string
|default = ""
|description = The name of the weapon this unit should explode as when it self destructs (See [[Units-WeaponDefs]]). Also used as the <code>kamikaze</code> weapon.}}

===Resources===
{{tag
|name = metalStorage
|type = float
|default = 0.0
|description = The amount of the metal resource storage the unit contributes.}}

{{tag
|name = energyStorage
|type = float
|default = 0.0
|description = The amount of the energy resource storage the unit contributes.}}

{{tag
|name = extractsMetal
|type = float
|default = 0.0
|description = The amount of the metal resource the unit extracts from the ground. The amount extracted depends on the metal map defined in the map itself. Works only for structures.}}

{{tag
|name = extractSquare
|type = bool
|default = false
|description = Is the metal extractors extraction area circular or square?}}

{{tag
|name = windGenerator
|type = float
|default = 0.0
|description = The amount of the energy resource the unit generates which is dependant on the map wind. Works only for structures.}}

{{tag
|name = tidalGenerator
|type = float
|default = 0.0
|description = The amount of the energy resource the unit generates which is dependant on the maps tidal power. Clearly, this only works on water structures.}}

{{tag
|name = metalUse
|type = float
|default = 0.0
|description = The amount of the metal resource the unit consumes per game 'tick'.}}

{{tag
|name = energyUse
|type = float
|default = 0.0
|description = The amount of the energy resource the unit consumes per game 'tick'.}}

{{tag
|name = metalMake
|type = float
|default = 0.0
|description = The amount of the metal resource the unit generates unconditionally per game 'tick'.}}

{{tag
|name = energyMake
|type = float
|default = 0.0
|description = The amount of the energy resource the unit generates unconditionally per game 'tick'.}}

{{tag
|name = makesMetal
|type = float
|default = 0.0
|description = The amount of the energy resource the unit turns into the metal resource per game 'tick'.}}

===Sensors===
{{tag
|name = onoffable
|type = bool
|default = false
|description = Does the unit have an on/off button? Currently the activation status tied to this button also turns sensors (other than LOS) on and off.}}

{{tag
|name = activateWhenBuilt
|type = bool
|default = false
|description = Should the unit's activation status be on or off when it is created?}}

{{tag
|name = sightDistance
|type = float
|default = 0.0
|description = The radius of the units sight (LOS is circular in Spring)}}

{{tag
|name = airSightDistance
|type = float
|default = 1.5 * sightDistance
|description = How far away the unit can see aircraft (and some FX).}}

{{tag
|name = losEmitHeight
|type = float
|default = 20.0
|special={{new|83.0}}
|description = How high up the unit is the point used to calculate it's LOS vs. the terrain?}}

{{tag
|name = radarEmitHeight
|type = float
|default = 20.0
|special={{new|83.0}}
|description = How high up the unit is the point used to calculate it's radar vs. the terrain?}}

{{tag
|name = radarDistance
|type = int
|default = 0
|description = The radius of the units radar.}}

{{tag
|name = sonarDistance
|type = int
|default = 0
|description = The radius of the units sonar.}}

{{tag
|name = radarDistanceJam
|type = int
|default = 0
|description = The radius of the units radar jamming.}}

{{tag
|name = sonarDistance
|type = int
|default = 0
|description = The radius of the units sonar jamming.}}

{{tag
|name = stealth
|type = bool
|default = false
|description = Is the unit undetectable by radar?}}

{{tag
|name = sonarStealth
|type = bool
|default = false
|description = Is the unit undetectable by sonar?}}

{{tag
|name = seismicDistance
|type = int
|default = 0
|description = The radius of the unit's seismic (movement) sensor.}}

{{tag
|name = seismicSignature
|type = float
|default = 0 for units with <code>floater</code>, <code>canHover</code> or <code>canFly</code>, otherwise sqrt(mass / 100.0)
|description = How fast the seismic ring expands in [[Units-UnitsOfMeasurement | elmos per frame]]. Each ping always lasts 15 [[frames]], so this also determines the maximum radius of the seismic ring.}}

====Cloaking====
For units with [[Units-UnitDefs#Commands|canCloak]] set to <code>true</code>:
{{tag
|name = cloakCost
|type = float
|default = 0.0
|description = The energy cost per tick to cloak the unit while it is stationary.}}

{{tag
|name = cloakCostMoving
|type = float
|default = cloakCost
|description = The energy cost per tick to cloak the unit while it is moving.}}

{{tag
|name = initCloaked
|type = bool
|default = false
|description = Is the unit cloaked as soon as it is created?}}

{{tag
|name = minCloakDistance
|type = float
|default = 0.0
|description = The minimum distance (radius) which the unit must be from any enemy units to remain cloaked.}}

{{tag
|name = decloakSpherical
|type = bool
|default = true
|description = Does <code>minCloakDistance</code> apply in 3D or only 2D? i.e. can aircraft flying above the unit decloak it?}}

{{tag
|name = decloakOnFire
|type = bool
|default = true
|description = Does the unit deloak when it fires a weapon?}}

{{tag
|name = cloakTimeout
|type = int
|default = 128
|description = The minimum time, in [[frames]], between a decloak and subsequent re-cloak.}}

===Commands===
{{tag
|name = canMove
|type = bool
|default = false
|description = Can the unit be issued Move orders?}}

{{tag
|name = canAttack
|type = bool
|default = true
|description = Can the unit be issued Attack orders?}}

{{tag
|name = canFight
|type = bool
|default = true
|description = Can the unit be issued Fight orders?}}

{{tag
|name = canPatrol
|type = bool
|default = true
|description = Can the unit be issued Patrol orders?}}

{{tag
|name = canGuard
|type = bool
|default = true
|description = Can the unit be issued Guard orders?}}

{{tag
| name = canCloak
| type = bool
| default = false
| description =
Can the unit be issued Cloak orders?}}

{{tag
|name = canRepeat
|type = bool
|default = true
|description = Can the unit be issued Repeat orders?}}

{{tag
|name = canSelfDestruct
|type = bool
|default = true
|description = Can the unit be issued a self destruct order?}}

{{tag
|name = moveState
|type = int
|default = -1 for mobile units, <code>1</code> for structures
|description = The initial movement state for the unit. Can be <code>-1</code> - Inherits from factory, <code>0</code> - Hold Position, <code>1</code> - Manoeuvre or <code>2</code> - Roam.}}

{{tag
|name = fireState
|type = int
|default = -1 for units without <code>noAutoFire</code>, <code>2</code> otherwise
|description = The initial firing state for the unit. Can be <code>-1</code> - Inherits from factory, <code>0</code> - Hold Fire, <code>1</code> - Return Fire or <code>2</code> - Fire At Will.}}

{{tag
|name = noAutoFire
|type = bool
|default = false
|description = Controls whether or not the unit has a fire state button.}}

{{tag
|name = canManualFire
|type = bool
|default = false
|description = Can the unit be issued ManualFire commands? A ManualFire command will fire any weapons with the <code>commandfire</code> tag (See [[Units-WeaponDefs]]).}}

====Builder Commands====
{{tag
|name = canRestore
|type = bool
|default = builder
|description = Can the unit be issued restore terrain commands? For builders only.}}

{{tag
|name = canRepair
|type = bool
|default = builder
|description = Can the unit be issued repair commands? For builders only.}}

{{tag
|name = canReclaim
|type = bool
|default = builder
|description = Can the unit be issued reclaim commands? For builders only.}}

{{tag
|name = canResurrect
|type = bool
|default = false
|description = Can the unit be issued resurrection commands? For builders only.}}

{{tag
|name = canCapture
|type = bool
|default = false
|description = Can the unit be issued capture commands? For builders only.}}

===Builder===
{{tag
|name = builder
|type = bool
|default = false
|description = Is the unit a builder?}}

{{tag
|name = buildDistance
|type = float
|default = 128.0
|description = How far away from itself the unit can build, measured to the centre of the unit being built. The minimum value is <code>38.0</code>.}}

{{tag
|name = buildRange3D
|type = bool
|default = false
|description = Does the builders <code>buildDistance</code> apply in all 3 dimensions or only 2?}}

{{tag
|name = workerTime
|type = float
|default = 0.0
|description = How fast the builder builds, used in conjunction with the <code>buildTime</code> of the unit being built. Effectively, ''Time to build = unit <code>buildTime</code> / constructor <code>workerTime</code>''. If this value is <= <code>0.0</code> then <code>builder</code> is set to false.}}

{{tag
|name = repairSpeed
|type = float
|default = workerTime
|description = How fast the builder can repair other units.}}

{{tag
|name = reclaimSpeed
|type = float
|default = workerTime
|description = How fast the builder can reclaim other units and features.}}

{{tag
|name = resurrectSpeed
|type = float
|default = workerTime
|description = How fast the builder can resurrect corpse features back into living units.}}

{{tag
|name = captureSpeed
|type = float
|default = workerTime
|description = How fast the builder can capture other units.}}

{{tag
|name = terraformSpeed
|type = float
|default = workerTime
|description = How fast the builder levels and restores terrain.}}

{{tag
|name = canAssist
|type = bool
|default = builder
|description = Can the builder assist other constructions?}}

{{tag
|name = canBeAssisted
|type = bool
|default = true
|description = Can the builder be assisted by other builders?}}

{{tag
|name = canSelfRepair
|type = bool
|default = false
|description = Can the builder repair itself?}}

{{tag
|name = showNanoSpray
|type = bool
|default = true
|description = Does the builder emit OTA-style nanospray whilst constructing?}}

{{tag
|name = nanoColor
|type = float[3]
|default = {0.2, 0.7, 0.2} aka green
|description = The RGB colour of a builders' emitted nano particles if <code>showNanoSpray</code> is <code>true</code>. Also controls the RBG colour of a unit's own nanoframe if <code>showNanoFrame</code> is <code>true</code>.}}

{{tag
|name = fullHealthFactory
|type = bool
|default = false
|description = If <code>true</code>, units are repaired before they are allowed to leave the factory i.e. units from this factory will be healed back to 100% health if they are damaged during construction.}}

{{tag
|name = isAirbase
|type = bool
|default = false
|description = Is this unit an airbase? Aircraft may land and repair on units which are airbases.}}

===Movement & Placement===
{{tag
|name = footprintX
|type = int
|default = 1
|description =
How wide the unit is in footprint units, left to right. 1 footprint unit = 16 [[elmos]]. Cannot be below <code>1</code>. For mobile units this should be the same as the <code>footprintX</code> of its <code>movementClass</code>. Also used for obstacle avoidance.}}

{{tag
|name = footprintZ
|type = int
|default = 1
|description =
How wide the unit is in footprint units, top to bottom. 1 footprint unit = 16 [[elmos]]. Cannot be below <code>1</code>. For mobile units this should be the same as the <code>footprintZ</code> of its <code>movementClass</code>. Also used for obstacle avoidance.}}

{{tag
|name = yardmap
|type = string
|default = ""
|description =
Used to determine a structure from a mobile unit. A string of characters which defines in detail each 'footprint square' of the structure. Each footprint square may be:
:: <code>y</code> - 'Yard' - Always open, unblocking,
:: <code>c</code> - 'Construction' - Open and unblocking only while constructing (for factories, controlled via <code>COB.YARD_OPEN</code> see [[Animation-LuaCallouts#Other]]),
:: <code>i</code> - 'Inversed Construction' - Closed and blocking only while constructing (for factories, controlled via <code>COB.YARD_OPEN</code> see [[Animation-LuaCallouts#Other]]) ({{new|89.0}}),
:: <code>g</code> - 'Geothermal' - Flags that the unit must be placed over a <code>geoThermal</code> feature, does not actually count as a square (See [[Units-FeatureDefs]]),
::<code>o</code> - 'Obstacle' - Always closed, blocking, all other chars are treated the same way.
: Tip: 'Draw' out the yardmap over multiple lines. Prior to 89.0 newlines should be replaced with spaces as newlines are treated as <code>o</code>.

{{tag
|name = levelGround
|type = bool
|default = false
|description = For structures. Does the constructor have to level the ground underneath the build area before beginning to build the structure?}}

{{tag
|name = movementClass
|type = string
|default = ""
|description = The name of the movement type a mobile, non aircraft, unit should use. See [[Movedefs.lua]]. Other tag usage should be consistent with this i.e. <code>canHover = true</code> IFF using a <code>HOVER</code> based movetype.}}

{{tag
|name = canHover
|type = bool
|default = false
|description = Is the unit a hovercraft? Hovercraft can cross water of any depth without a speed penalty. Hover's must also have <code>HOVER</code> within the name of their <code>movementClass</code> (see [[Movedefs.lua]]).}}

{{tag
|name = floater
|type = bool
|default = true if the unit has the <code>waterline</code> tag, <code>false</code> otherwise
|description = When a mobile unit is crossing water, or a structure is placed on water, does it float on top of the water or crawl / lay on the sea bed?}}

{{tag
|name = upright
|type = bool
|default = false
|description = Does the unit follow the terrain or always remain upright? Generally used for walkers.}}

{{tag
|name = maxSlope
|type = float
|default = 0.0
|description = The maximum slope a building can be placed on. Mobile unit's use the <code>maxSlope</code> set in their <code>movementClass</code> (see [[Movedefs.lua]]). The value is in degrees and is clamped between <code>0.0</code> and <code>89.0</code>. This value is converted to a "maximum allowed height difference" (call it M), which involves a hard-coded constant. When a building gets placed, the height of each of its footprint squares is compared to a reference height (calculated for the build position). If the difference exceeds M for any square, that build position is rejected.}}

{{tag
|name = minWaterDepth
|type = float
|default = -10e6
|description = The minimum depth of water a building can be placed on. Mobile unit's use the <code>minWaterDepth</code> set in their <code>movementClass</code> (see [[Movedefs.lua]]).}}

{{tag
|name = maxWaterDepth
|type = float
|default = 10e6
|description = The maximum depth of water a building can be placed on. Mobile unit's use the <code>maxWaterDepth</code> set in their <code>movementClass</code> (see [[Movedefs.lua]]).}}

{{tag
|name = waterline
|type = float
|default = 0.0
|description = How low in the water does a ship sit? Higher values means the ship is lower in the water.}}

{{tag
|name = minCollisionSpeed
|type = float
|default = 1.0
|description = The minimum net impact speed that will cause a unit to be damaged by collisions with another unit.}}

{{tag
|name = pushResistant
|type = bool
|default = false
|description = Can the unit be pushed around by other units? Turning it on doesn't remove all pushing but is a marked improvement.}}

{{tag
|name = maxVelocity
|type = float
|default = 0.0
|description = The maximum speed attainable by the unit in [[Units-UnitsOfMeasurement | elmos per frame]]. If the value is -ve, the absolute value is used.}}

{{tag
|name = maxReverseVelocity
|type = float
|default = 0.0
|description = The maximum speed attainable by the unit in reverse in [[Units-UnitsOfMeasurement | elmos per frame]]. If the value is -ve, the absolute value is used.}}

{{tag
|name = acceleration
|type = float
|default = 0.5
|description = The acceleration of the unit, in [[Units-UnitsOfMeasurement | elmos per frame2]]. If the value is -ve, the absolute value is used.}}

{{tag
|name = brakeRate
|type = float
|default = 3.0 * acceleration
|description = The deceleration of the unit, in [[Units-UnitsOfMeasurement | elmos per frame2]]. If the value is -ve, the absolute value is used. For units with <code>canFly</code> this is multiplied by <code>0.1</code>.}}

{{tag
|name = turnRate
|type = float
|default = 0.0
|description = How fast the unit can turn. ''degrees per seconds = 0.16 * <code>turnRate</code>''}}

{{tag
|name = turnInPlace
|type = bool
|default = true
|description = Does the unit turn on the spot (like a person or tank) or must it be moving forwards to turn (like a car).}}

{{tag
|name = turnInPlaceSpeedLimit
|type = float
|default = A complex formula based on <code>turnRate</code> and <code>maxVelocity</code>
|description = For units with <code>turnInPlace = false</code>, this defines the minimum speed it will slow down to (the speed at which the turn is actually performed can be higher depending on the angular difference and <code>turnRate</code>).}}

{{tag
| name = turnInPlaceAngleLimit
| type = float
| default = 0.0
| special = {{new|86.0}}
| description = For units with <code>turnInPlace = true</code>, defines the maximum angle (in degrees) of a turn above which it starts to brake.}}

{{tag
|name = blocking
|type = bool
|default = true
|description =Does the unit block the movement of other units? (Mines, i.e. non-mobile units with the <code>kamikaze</code> tag default to <code>false</code>)}}

{{tag
|name = crushResistance
|type = float
|default = mass
|special = {{new|85.0}}
|description = How resistant is the unit to being crushed? Any [[Movedefs.lua|'''MoveClass''']] with a <code>crushStrength</code> greater than this will crush the unit - if and only if this has been enabled via [[Lua_SyncedCtrl#Unit_Control|Spring.SetUnitBlocking]].}}

===Flanking===
For a deeper explanation of these tags, see [[Units:FlankingBonus]].

{{tag
|name = flankingBonusMode
|type = int
|default = flankingBonus.defaultMode set in [[Modrules.lua]]
|description = The mode of operation of Spring's inbuilt flanking system. Can be <code>0</code> - No flanking bonus. Mode <code>1</code> builds up the ability to move over time, and swings to face attacks, but does not respect the way the unit is facing. Mode <code>2</code> also can swing, but moves with the unit as it turns. Mode <code>3</code> stays with the unit as it turns and otherwise doesn't move, the ideal mode to simulate something such as tank armour.}}

{{tag
|name = flankingBonusDir
|type = float[3]
|default = {0.0, 0.0, 1.0}
|description = This is the direction vector where the armour is facing; i.e. where the least damage is applied. The default is straight forwards.}}

{{tag
|name = flankingBonusMax
|type = float
|default = 1.9
|description = The maximum multiplier to the damage dealt, when a unit is hit from the opposite direction to <code>flankingBonusDir</code>.}}

{{tag
|name = flankingBonusMin
|type = float
|default = 0.9
|description = The minimum multiplier to the damage dealt, when a unit is hit from the opposite direction to <code>flankingBonusDir</code>.}}

{{tag
|name = flankingBonusMobilityAdd
|type = float
|default = 0.01
|description = This defines the ability of <code>flankingBonusDir</code> to move over time. Its value is added to the mobility every [[SlowUpdate]]. When the unit is attacked, the build up mobility value is multiplied by a vector facing the attack, which is added to <code>flankingBonusDir</code>.}}

===Aircraft===
{{tag
|name = canFly
|type = bool
|default = false
|description = Can the unit fly, i.e. is it an aircraft?}}

{{tag
|name = canSubmerge
|type = bool
|default = false
|description = Can the aircraft land underwater?}}

{{tag
|name = factoryHeadingTakeoff
|type = bool
|default = true
|description = Controls the take-off behaviour of aircraft with <code>hoverAttack</code>. <code>true</code> means planes start matching their factory's heading right after taking off from the pad, <code>false</code> means they maintain the heading of the pad until reaching <code>cruiseAlt</code>.}}

{{tag
|name = collide
|type = bool
|default = true
|description = Does the unit collide with other aircraft, or can it occupy the same space?}}

{{tag
|name = hoverAttack
|type = bool
|default = false
|description = Controls whether the aircraft flys and attacks like a fighter/bomber or a helicopter/gunship.}}

{{tag
|name = airStrafe
|type = bool
|default = true
|description = For aircraft with <code>hoverAttack = true</code>, controls if the unit strafes side to side while attacking or remains stationary.}}

{{tag
|name = cruiseAlt
|type = float
|default = 0.0
|description = The altitude in [[elmos]] which the unit attempts to fly at while cruising.}}

{{tag
|name = airHoverFactor
|type = float
|default = -1.0
|description = For aircraft with <code>hoverAttack = true</code>, less then <code>0</code> means it can land and >= <code>0</code> indicates how much the unit will move during hovering on the spot.}}

{{tag
|name = bankingAllowed
|type = bool
|default = true
|description = For aircraft with <code>hoverAttack = true</code>, controls whether or not the unit banks when moving turning.}}

{{tag
|name = useSmoothMesh
|type = bool
|default = true
|description = Does the aircraft follow the real map terrain or the special smoothed out navigation mesh generated by Spring specifically for aircraft?}}

{{tag
|name = maxFuel
|type = float
|default = 0.0
|description = The maximum flight time in seconds before aircraft must return to an airbase to refuel.}}

{{tag
|name = refuelTime
|type = float
|default = 5.0
|description = The time in seconds required to refuel the aircraft at an airbase.}}

{{tag
|name = minAirbasePower
|type = float
|default = 0.0
|description = The minimum <code>workerTime</code> an airbase must have to repair / refuel this aircraft.}}

{{tag
|name = canLoopbackAttack
|type = bool
|default = false
|description = Can the aircraft perform an [http://en.wikipedia.org/wiki/Immelmann_turn Immelmann turn]?}}

====Advanced Air Tags====
The following set of tags are not well understood and using non-default values can lead to undesired flight behaviours.
{{tag
|name = wingDrag
|type = float
|default = 0.07
|description = The drag caused by the aircraft's wing. Clamped between <code>0.0</code> and <code>1.0</code>.}}

{{tag
|name = wingAngle
|type = float
|default = 0.08
|description = The angle between the front and the wing plane.}}

{{tag
|name = frontToSpeed
|type = float
|default = 0.1
|description = Fudge factor for lining up speed and front of plane.}}

{{tag
|name = speedToFront
|type = float
|default = 0.07
|description = Fudge factor for lining up speed and front of plane.}}

{{tag
|name = myGravity
|type = float
|default = 0.4
|description = As Spring aircraft are slower than real aircraft this tag allows to lower gravity to compensate. Multiplies against map gravity.}}

{{tag
|name = crashDrag
|type = float
|default = 0.005
|description = The drag used when crashing. Clamped between <code>0.0</code> and <code>1.0</code>.}}

{{tag
|name = maxBank
|type = float
|default = 0.8
|description = The maximum roll (z-axis rotation) the aircraft can achieve.}}

{{tag
|name = maxPitch
|type = float
|default = 0.45
|description = The maximum pitch (x-axis rotation) the aircraft tries to keep.}}

{{tag
|name = turnRadius
|type = float
|default = 500.0
|description = Hint to Spring unit AI about the required turning radius.}}

{{tag
|name = verticalSpeed
|type = float
|default = 3.0
|description = The speed of takeoff and landing, at least for gunships (<code>hoverAttack = true</code>)}}

{{tag
|name = maxAileron
|type = float
|default = 0.015
|description = The maximum turn speed around the roll (z) axis.}}

{{tag
|name = maxElevator
|type = float
|default = 0.01
|description = The maximum turn speed around the pitch (x) axis.}}

{{tag
|name = maxRudder
|type = float
|default = 0.004
|description = The maximum turn speed around the yaw (y) axis.}}

{{tag
|name = maxAcc
|type = float
|default = 0.065
|description = The maximum acceleration or 'engine power' of the aircraft.}}

====Flares====
The following set of tags are rarely used and are hardcoded to only work vs. missile weapons. The texture is hardcoded to be <code>flareprojectiletexture</code> defined in [[Resources.lua]].
{{tag
|name = canDropFlare
|type = bool
|default = false
|description = Can this aircraft drop flares to distract missile weapons?}}

{{tag
|name = flareReload
|type = float
|default = 5.0
|description = The time in seconds between successive flare drops.}}

{{tag
|name = flareDelay
|type = float
|default = 0.3
|description = The delay between detecting an incoming missile and launching flares. Multiplied by a random number between 1 and 16.}}

{{tag
|name = flareEfficiency
|type = float
|default = 0.5
|description = The probability that an incoming missile will target the flare instead of the aircraft.}}

{{tag
|name = flareDropVector
|type = float[3]
|default = {0.0, 0.0, 0.0}
|description = The direction vector which flares are emitted in.}}

{{tag
|name = flareTime
|type = int
|default = 3
|description = The lifetime of a dropped flare in [[frames]].}}

{{tag
|name = flareSalvoSize
|type = int
|default = 4
|description = How many flares are dropped at once?}}

{{tag
|name = flareSalvoDelay
|type = int
|default = 0
|description = The delay in [[frames]] between the release of each individual flare in a burst.}}

===Transports===
{{tag
|name = transportSize
|type = int
|default = 0
|description = The size of units that the transport can pick up, in terms of the passengers <code>footprintX</code>.}}

{{tag
|name = minTransportSize
|type = int
|default = 0
|description = The smallest size of unit that the transport can pick up, in terms of the passengers <code>footprintX</code>.}}

{{tag
|name = transportCapacity
|type = int
|default = 0
|description = The total number of units that the transport can pick up, with each unit multiplied by it's <code>footprintX</code> size. If this tag is not present, then any AttachUnit and DropUnit call in the animation script will be ignored (See [[Animation-LuaCallouts#Other]])}}

{{tag
|name = transportMass
|type = float
|default = 100000.0
|description = The total cumulative <code>mass</code> of passengers the transport can carry.}}

{{tag
|name = minTransportMass
|type = float
|default = 0.0
|description = The total minimum <code>mass</code> passenger the transport can carry.}}

{{tag
|name = loadingRadius
|type = float
|default = 220.0
|description = How far away in [[elmos]] can the transporter pick up and drop units?}}

{{tag
|name = unloadSpread
|type = float
|default = 1.0
|description = How spread out the passengers are when unloaded. Is multiplied by the passengers radius.}}

{{tag
|name = isFirePlatform
|type = bool
|default = false
|description = Can transported units still aim and shoot while loaded by this transport?}}

{{tag
|name = holdSteady
|type = bool
|default = false
|description = If <code>true</code> - passengers are slaved to orientation of transporter attachment piece, if <code>false</code> - passengers are slaved to orientation of transporter body.}}

{{tag
|name = releaseHeld
|type = bool
|default = false
|description = Does the transporter unload it's passengers when it dies?}}

{{tag
|name = cantBeTransported
|type = bool
|default = false</code> for mobile units <code>true</code> for structures
|description = Controls if a unit is transportable at all or not. If <code>false</code> it is overridden by [[Modrules.lua]] <code>transportability</code> subtable tags.}}

{{tag
|name = transportByEnemy
|type = bool
|default = true
|description = Controls if a unit can be transported by an enemy transport. i.e. can it be kidnapped.}}

{{tag
|name = transportUnloadMethod
|type = int
|default = 0
|description = For air transports. Can be <code>0</code> - Land to unload individually, <code>1</code> - Flyover drop (i.e. Parachute), or <code>2</code> - Land and flood unload all passengers. Can be used on ground transports with mixed results.}}

{{tag
|name = fallSpeed
|type = float
|default = 0.2
|description = For air transports with <code>transportUnloadMethod = 1</code>. The speed in [[elmos]] per second which units will fall at when released from the transport.}}

{{tag
|name = unitFallSpeed
|type = float
|default = 0.0
|description = Allows you to override <code>fallSpeed</code> for an individual passenger.}}

===Categories===
For a deeper explanation of these tags, see [[Unit_Categories]].
{{tag
|name = category
|type = string
|default = ""
|description = The category tag is a string of separate words, each representing a category of units. There are a maximum of 32 categories. The primary purpose of categories is weapon targeting (See [[#weapons]]).}}

{{tag
|name = noChaseCategory
|type = string
|default = ""
|description = The unit will still target enemies with a matching <code>category</code>, but will not chase after it if it moves out of weapon range.}}

===Decals===
{{tag
|name = leaveTracks
|type = bool
|default = false
|description = Does the unit leave a track mark decal behind it when it moves? For mobile units.}}

{{tag
|name = trackType
|type = string
|default = "stdTank"
|description = The filename of the image, without extension, assumed to be in <code>Bitmaps/Tracks/</code>, to be used as the track decal. The red channel of the image controls the brightness and the green channel the alpha (how visible it is) of the track. Blue channel is unused.}}

{{tag
|name = trackWidth
|type = float
|default = 32.0
|description = The width of the track decal left on the ground, in [[elmos]].}}

{{tag
|name = trackOffset
|type = float
|default = 0.0
|description = How far back in [[elmos]] the track should be drawn from the centre of the unit.}}

{{tag
|name = trackStrength
|type = float
|default = 32.0
|description = How visible or 'deep' the track mark should be. Also used to determine how long the decal should last.}}

{{tag
|name = trackStretch
|type = float
|default = 1.0
|description = How much the track is stretched in the forward direction compared to the sides (i.e. used to change aspect ratio).}}

{{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===
For a deeper explanation of these tags, see [[Unit_collision_volumes | Unit Collision Volumes]].
{{tag
|name = modelCenterOffset
|type = float[3]
|default = {0.0, 0.0, 0.0}
|description = How far from the model's defined centre should the centre of the unit be?}}

{{tag
|name = usePieceCollisionVolumes
|type = bool
|default = false
|description = When turned on the model and unitDef collision volumes are ignored and Spring generates a bounding box volume for each piece of the unit model. These volumes can be manipulated or replaced by [[Lua_SyncedCtrl#Unit_Control | Spring.SetUnitPieceCollisionVolumeData]]. Increases the performance cost of collision calculations.}}

{{tag
|name = collisionVolumeType
|type = string
|default = ""
|description = What shape should the unit's collision volume be? Can be <code>box</code>, <code>ellipsoid</code> or a cylinder aligned to an axis; <code>cylX</code>, <code>cylY</code>, <code>cylZ</code>.}}

{{tag
|name = collisionVolumeScales
|type = float[3]
|default = {0.0, 0.0, 0.0}
|description = The length of the collision volume in each of the three axes.}}

{{tag
|name = collisionVolumeOffsets
|type = float[3]
|default = {0.0, 0.0, 0.0}
|description = The offset from the unit centre to the hit volume centre in each axis.}}

{{tag
|name = collisionVolumeTest
|type = int
|default = 0
|description = The type of test used to detect collisions. Can be <code>0</code> (discrete) or <code>1</code> (continuous). Use the latter for catching high speed projectiles which may otherwise 'skip through' small collision volumes, but beware of the increased performance cost.}}

===Attack Behaviours===
{{tag
|name = highTrajectory
|type = int
|default = 0
|description = Can the unit fire it's (ballistic) weapons in a high trajectory arc? Can be <code>0</code> - Low trajectory only, <code>1</code> - High trajectory only, or <code>2</code> - Toggle button.}}

{{tag
|name = kamikaze
|type = bool
|default = false
|description = Does the unit attack its target by blowing itself up?}}

{{tag
|name = kamikazeDistance
|type = float
|default = 0.0
|description = How close to the target, in [[elmos]], the unit must get before detonating. Measured in 3D, not 2D.}}

{{tag
|name = kamikazeUseLOS
|type = bool
|default = false
|description = Does the target unit have to be in LOS when detonating or only within <code>kamikazeDistance</code>.}}

{{tag
|name = strafeToAttack
|type = bool
|default = false
|description = Should the unit move sideways when it can't shoot?}}

===Other===
{{tag
|name = decoyFor
|type = string
|default = ""
|description = The unitdef name (not human <code>name</code>) which this unit is a decoy for.}}

{{tag
|name = selfDestructCountdown
|type = int
|default = 5
|description = The length in seconds taken between issuing self destruct order and the unit exploding.}}

{{tag
|name = damageModifier
|type = float
|default = 1.0
|description = The multiplier applied to weapon damage when the units ARMORED status (See [[Lua_ConstCOB]]) is turned on.}}

{{tag
|name = isTargetingUpgrade
|type = bool
|default = false
|description = Does the unit upgrade the targeting so that units shoot accurately at enemy units which are in radar but not in LOS.}}

{{tag
|name = isFeature
|type = bool
|default = false
|description = Does the unit immediately die into it's <code>corpse</code> feature when built? Used mainly for making walls.}}

{{tag
|name = hideDamage
|type = bool
|default = false
|description = Should the units current health be invisible to enemy players?}}

{{tag
|name = showPlayerName
|type = bool
|default = false
|description = Should the unit display it's controlling player as its name instead of <code>name</code>. Generally used for commander or hero units.}}

{{tag
|name = showNanoFrame
|type = bool
|default = true
|description = Does the unit show an OTA-style nanoframe whilst being constructed?}}

{{tag
|name = unitRestricted
|type = int
|default = MAX_UNITS
|description = How many of this unit type may a player control at once? Defaults to being the maximum amount of units controllable. Is overridden by lobby unit restrictions.}}

{{tag
|name = power
|type = float
|default = buildCostMetal + (buildCostEnergy / 60.0)
|description = The relative power of the unit. Used in weapon targeting priority and experience gain calculations.}}

==Sub Tables==

===weapons===
The <code>weapons</code> subtable of a UnitDef tells Spring which weapons the unit has. It is a simple array (number indexed table) of <code>weaponName</code>s (not the human readable <code>name</code>!).

The following additional tags are associated with this subtable:

{{tag
|name = name
|type = string
|default = ""
|description = The <code>weaponName</code> of the weapon (See [[Units-WeaponDefs]]). If using the [[weapondefs_post.lua]] provided by [[springcontent.sdz]], you may include the WeaponDef tables within the UnitDef as the <code>weaponDefs</code> subtable, and refer to them with <code>def</code> rather than <code>name</code>. This can be a useful way to organise definitions if units do not generally share weapons.}}

{{tag
|name = badTargetCategory
|type = string
|default = ""
|description = A string of unit <code>category</code> entries which this weapon prefers to avoid targeting. i.e. given two units which ''can'' be targeted, any unit whose <code>category</code> matches any entry in this tag, will be targeted last. (See [[#Categories]])}}

{{tag
|name = onlyTargetCategory
|type = string
|default = ""
|description = A string of unit <code>category</code> entries which this weapon can target. i.e. any unit whose <code>category</code> does not match any entry in this tag, cannot be targeted by this weapon. (See [[#Categories]])}}

{{tag
|name = slaveTo
|type = int
|default = 0
|description = The number of the weapon which this weapon is slaved to. A slaved weapon can only target what it's master is targeting. Weapon numbers start at <code>1</code> and correspond to the index of the weapon within the subtable.}}

{{tag
|name = mainDir
|type = float[3]
|default = {1.0, 0.0, 0.0} i.e. forwards
|description = A vector representing the firing direction of this weapon if it has a limited firing arc. Used in conjunction with <code>maxAngleDif</code> (See [[Units:WeaponMainDir]]).}}

{{tag
|name = maxAngleDif
|type = float
|default = 180.0
|description = How wide this weapons limited firing arc is in degrees. Symmetrical about <code>mainDir</code> i.e. <code>180.0</code> is 90 degree freedom either way (See [[Units:WeaponMainDir]]).}}

{{tag
|name = fuelUsage
|type = float
|default = 0.0
|description = How much fuel in seconds is deducted from the units initial <code>maxFuel</code> when this weapon fires.}}

===buildOptions===
The <code>buildOptions</code> subtable of a UnitDef tells Spring which other units the unit can build (in the case of a builder) or produce (in the case of a factory).
It is a simple array (number indexed table) of <code>unitName</code>s (not the human readable <code>name</code>!).

There are no additional tags specific to this subtable.

===SFXTypes===
The <code>SFXTypes</code> subtable of a UnitDef tells Spring which [[CEG]] effects are associated with the unit. It consists of two further subtables, with no additional tags specific to them.

====explosionGenerators====

The <code>explosionGenerators</code> subtable of <code>SFXTypes</code> tells Spring which [[CEG]]s the unit's script can call, via the <code>EmitSFX()</code> callout (See [[Animation-LuaCallouts#Effects]]). It is a simple array (number indexed table) of CEG names, prefaced by the string <code>"custom:"</code>.

====pieceExplosionGenerators====
{{new|83.0}}

The <code>pieceExplosionGenerators</code> subtable of <code>SFXTypes</code> tells Spring which [[CEG]]s the unit's script can pick at random to attach to a flying unit piece, created from the <code>Explode()</code> callout (See [[Animation-LuaCallouts#Effects]]). It is a simple array (number indexed table) of CEG names, with no prefix.

Forum thread (with examples): {{forumlink|topic=27554|title=pieceExplosionGenerators}}

===sounds===

The <code>sounds</code> subtable of a UnitDef tells Spring which sound files to play when the unit triggers various events.

Files are assumed to be in the <code>Sounds/</code> directory; accepted formats are .wav and .ogg, the former being assumed if no extension is given.

Sounds can be defined in one of three ways:

# Each event can be used as though it were a <code>string</code> tag referring to the filename.
# Each event can be the name of a subtable, which is a simple array containing the filenames. One sound is picked at random from the list each time the event occurs.
# Each event can be the name of a subtable, which is a simple array containing further tables, which contain the following tags:
{{tag
|name = file
|type = string
|default = ""
|description = The filename of the sound to play.}}

{{tag
|name = volume
|type = float
|default = 1.0
|description = The default volume of the sound.}}

Spring checks any referenced sound filename to see if a SoundItem has been created, which allows greater control over how it is played (See [[Sounds.lua]]).

====sounds Example====

For clarification, here is an example of all three methods:

<code><pre>sounds = {
-- Method 1
ok = 'oksound', -- .wav appended
-- Method 2
arrived = {
'arrived1.wav',
'arrived2.wav',
},
-- Method 3
select = {
{ file = 'selsound1.ogg', volume = 2.0 },
{ file = 'selsound2.ogg', volume = 2.5 },
},
}</pre></code>

====sounds Events====

The events called by the engine are as follows:

* '''<code>ok</code>'''
: Unit is issued a command.

* '''<code>select</code>'''
: Unit is selected by the player.

* '''<code>arrived</code>
: Unit has arrived at its destination. Mobile ground units only.

* '''<code>build</code>'''
: Unit begins building. Called for both factories and mobile construction units.

* '''<code>activate</code>'''
: Unit is activated, i.e. Is turned on. Also called when a mobile ground unit starts moving.

* '''<code>deactivate</code>'''
: Unit deactivates, i.e. Is turned off.

* '''<code>cant</code>'''
: Unit cannot carry out this order. Loaded but not currently called by the engine.

* '''<code>underattack</code>'''
: Unit gets attacked. Loaded but not currently called by the engine.

===customParams===
The <code>customParams</code> subtable of a UnitDef allows the game designer to give their units 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

==Examples==
[http://imolarpg.dyndns.org/trac/balatest/browser/trunk/units 'Balanced Annihilation' UnitDefs]

[http://trac.caspring.org/browser/trunk/mods/ca/units 'Complete Annihilation' UnitDefs]

[http://code.google.com/p/conflictterra/source/browse/#svn%2Fgames%2FCT%2Funits 'Conflict Terra' UnitDefs]

[https://code.google.com/p/evolutionrts/source/browse/#svn%2Ftrunk%2Fevolutiondev.sdd%2FUnits 'Evolution RTS' UnitDefs]

[http://code.google.com/p/springtutorialgame/source/browse/#svn%2Ftrunk%2FSpringTutorialGame.sdd%2FUnits 'Spring Tutorial Game' UnitDefs]

[http://code.google.com/p/zero-k/source/browse/trunk#trunk%2Fmods%2Fzk%2Funits 'ZeroK' UnitDefs]

[[Category: Unit_development]]
[[Category: Game development]]

Air Domination

2012-05-14T02:31:04Z

Smoth:

Air Domination is an tactic best employed on maps with little land or large areas on which land units cannot act. It's simple - build an attack group of aircraft suitable for taking out your targets, and support with units that minimize the weakness of air.

Alternatively, build up a tremendous force of the cheapest effective air units for a task and mass your targets, using shock and awe to augment your activities.

'''Connections'''

This tactic is viable in most games with advanced air units and independent air technology, such as AA or XTA. The relative weakness of air units in E&E and may make this a poor tactical choice despite the access to a variety of aircraft.

'''Notes'''

Do not put hundreds of flying units in patrol mode, you'll cause the game to run very slow for everyone

Some mods have aircraft units that can overlap. Try to spread out your aircraft so they do not "chain explode", as they are very delicate machines.

''' [[Strategy_and_Tactics|<- Back to Strategy and Tactics page]]'''

[[category:Strategy]]

Games

2012-05-14T02:26:25Z

Smoth: /* Proprietary */

__NOTOC__There are a number of games made for the Spring Engine. Some of the more popular ones are listed below, sorted by their terms of use. 

=Freeware/Open Source=
''These games are all free to download and play and may be open to modifications, however, be sure to read the licenses before doing so.''
{|
|-
| align="center" | <h2>[http://zero-k.info/ Zero-K]</h2>
([http://code.google.com/p/zero-k/source/browse/trunk/mods/zk/legal.txt GPL, PD])
| width=40 |
| align="center" | <h2>'''[http://www.spring1944.org/ Spring: 1944]'''</h2>([http://spring1944.svn.sourceforge.net/viewvc/spring1944/trunk/S44Main.sdd/docs/License.txt CC-BY-NC])
|-
| align="center" | {{navimgx|xsize=300|ysize=225|image=Zero-k_image.jpg|link=http://zero-k.info/}}
|
| align="center" |{{navimgx|xsize=300|ysize=225|image=S44_tigers.jpg|link=http://www.spring1944.org}}
|-
| align="justify" valign="top" | Zero-K is a fast, competitive game with a focus on a streamlined economy and advanced interface that takes the focus off tedious tasks and back on the action. A huge roster of interesting, unique units and a variety of unit abilities provides tremendous tactical and strategic depth to the game. [http://zero-k.info Download link]
|
| align="justify" valign="top" | Spring:1944 is a WWII themed game with four fully functional sides (US, Germany, USSR, Britain), period-accurate units and strengths. Realism comes second only to creating a game that is fun and accessible to play.
|-
| align="center" | <h2>[http://www.evolutionrts.info Evolution RTS]</h2>([http://creativecommons.org/licenses/by-nc-nd/3.0/us/ CC-BY-NC-ND])
| width=40 |
| align="center" | <h2>[[Kernel Panic]]</h2>([[Kernel_Panic#License:|FOSS, with only 2 FOSS maps]])
|-
| align="center" | {{navimgx|xsize=300|ysize=188|image=Evoimg.jpg|link=http://www.evolutionrts.info}}
|
| align="center" | {{navimg|xsize=300|ysize=225|image=Kernel_Panic_3.4.jpg|link=Kernel Panic}}
|-
| align="justify" valign="top" | A new war is brewing. A violent conflict, between the Six Colonies, each one convinced that it was in the right, each one sure of its own ability to defeat its enemies. But they need Generals. They need soldiers. They need you.
|
| align="justify" valign="top" | A game based around combat '''inside''' a computer, with 3 unique sides: the System, the Hacker and the Network waging war in a matrix of DOOM! No resource economy exists in KP, with the only constraints being time and space.
|-
| align="center" | <h2>'''[http://www.moddb.com/games/conflict-terra Conflict Terra]'''</h2>([http://code.google.com/p/conflictterra/source/browse/games/CT/License.txt FOSS])
|
| align="center" | <h2>[[Spring Tanks]]</h2>([http://pastebin.com/Wpub9wWw undecided, some obscure free license])
|-
| align="center" |{{navimgx|xsize=300|ysize=225|image=CT_Hojos.png|link=http://www.moddb.com/games/conflict-terra}}
|
| align="center" | {{navimg|xsize=300|ysize=221|image=Springtanks_wikipreview.jpg|link=Spring Tanks}}
|-
| align="justify" valign="top" | A unique game with heavy emphasis on mobility and featuring Spring's first major "collect and drop-off" economy, Conflict Terra boasts a distinctive art style. Play as one of two factions in an ever-changing battlefield as you struggle to come out on top.
|
| align="justify" valign="top" | Some guys decided to attack each other with tanks and you can be one of them.
Build-in Single Player!
|}

=Proprietary=
''These games may or may not be free to play. Modifying their content (i.e. the art assets) is not allowed without the game authors explicit permission, although the code is GPL and some games (P.U.R.E.) include large GPL-friendly content collections.''

{|
|-
| align="center" | <h2>[http://www.imperialwinter.com Star Wars: Imperial Winter]</h2>
| width=40 |
| align="center" | <h2>[http://www.indiedb.com/games/the-cursed The Cursed]</h2>
|-
| align="center" | {{navimgx|xsize=300|ysize=225|image=Imperial Winter assault.jpg|link=http://www.imperialwinter.com}}
|
| align="center" |{{navimgx|xsize=300|ysize=225|image=cursed_logo.jpg|link=http://www.indiedb.com/games/the-cursed}}
|-
| align="justify" valign="top" | A Star Wars themed game set in the troubled post-Return of the Jedi era. SW:IW is currently [http://springrts.com/phpbb/viewtopic.php?f=46&t=25108|in closed development and not playable for the public.]
|
| align="justify" valign="top" | The game is about bones, undead, demons, space marines and magic settled in a futuristic environment. It is a fresh mixture of gameplay elements from many popular RTS games like Starcraft and C&C.
|}

=TA-derived=
''At least parts of these games are derived from data of the Total Annihilation game (copyright Atari). As such, their distribution is potentially in breach of copyright laws and therefore not officially endorsed by the Spring RTS team.''

{|
|-
| align="center" | <h2>[http://balancedannihilation.org Balanced Annihilation]</h2>
| width=40 |
| align="center" | <h2> [http://springfiles.com/spring/games/tech-annihilation-8 Tech Annihilation] </h2>
|-
| align="center" | {{navimgx|xsize=300|ysize=225|image=BAScreenShot.jpg|link=http://balancedannihilation.org}}
|
| align="center" |{{navimgx|xsize=300|ysize=200|image=Tech_Annihilation.png|link=http://springfiles.com/spring/games/tech-annihilation-8}}
|-
| align="justify" valign="top" |
Balanced Annihilation (BA) is a mature game and new versions feature only minor balance tweaks.

BA gameplay develops in stages of progressively heavier units with a growing economy. Many strategies are viable in BA, including focusing on map control, aggression, defense, air power, sea power, or mobility.

|
| align="justify" valign="top" | This Game is bigger, greater and more epic! Tech your Commander from a tiny Commander to a Galactic Commander! (by ''[BoS]Senna'', currently no homepage)
|}

{|
|-
| align="center" | <h2>[http://nota.machys.net/ NOTA]</h2>
| width=40 |
| align="center" | <h2>[[XTA]]</h2>
|-
| align="center" |{{navimgx|xsize=300|ysize=225|image=Nota2nukes.jpg|link=http://nota.machys.net/}}
|
| align="center" | {{navimg|xsize=300|ysize=225|image=Screen508_s.jpg|link=XTA}}
|-
| align="justify" valign="top" | Not Original Total Annihilation is a rethink of the Total Annihilation universe with a focus on strategic, base oriented gameplay. With its revised unit scale, huge battles erupt engaging hundreds of units and scores of unit types. NOTA's completely rethought air and sea gameplay forces participation in all elements and places the tide of conflict in your hands.
|
| align="justify" valign="top" | Originally developed as a Total Annihilation game by the Swedish Yankspankers, XTA is the Original Public Game released with first versions of Spring. Development of this game by the SYs has stopped a while ago, but it is still played and actively developed by the community.
|
|}

=Installing Games in Spring=
Quite a few of the games listed above come with standalone installers, which makes things easy. Check their website to find out!

In some cases however, the game will only distribute a game-file, for example ''BA750'''''.sd7''' or ''XTA'''''.sdz'''. For these games, you have to [[Download|install the stand-alone Spring-Engine]] first, and then place the game-file in the ''...\My Documents\My Games\Spring\Games\'' or ''...\Spring\games\'' folder (''~/.spring/games/'' on Linux/Unix/Mac).
You may install multiple games in the same engine installation.

To play a game, you also need a [[Maps|map]].

Still not enough Games? There are [[Getting_Spring_Content_and_Links|some more]], not listed here or make your [[Game_and_Unit_development|own Game]]!

[[Category: Games]]

GamesDownloads

2012-05-14T02:25:38Z

Smoth: /* Game installers (for players) */

{{#css:
table.glossy {
width: 200px;
margin: 9px; padding:3px;
border: 1px solid rgba(0,0,0,0.5);
border-radius: 10px 10px 10px 10px;
box-shadow: 0 2px 6px rgba(0,0,0,0.5), inset 0 1px rgba(255,255,255,0.3), inset 0 10px rgba(255,255,255,0.2), inset 0 10px 20px rgba(255,255,255,0.25), inset 0 -15px 30px rgba(0,0,0,0.3);
text-align: center;
}

/*#installers img {
border: 1px solid rgba(0,0,0,0.5);
box-shadow: 0px -1px 3px rgba(0,0,0,0.8), 0px 1px 3px rgba(255,255,255,0.5);
}*/

/*table.glossy:hover {
background: rgba(160,160,220,0.4);
}*/
}}
[[Download]] < {{FULLPAGENAME}}

= Game installers (for players) =
Below are three Spring games that comes with complete installer (containing all the files you need to play those games):
<div id="installers" style="padding-left:7px">
{{Template:GamesDownload|name=Zero K + Lobby (windows only)|image=eclipse.jpg|url=http://zero-k.info/Wiki/Download}}
{{Template:GamesDownload|name=Kernel Panic|image=Kernel_Panic_3.4.jpg|url=http://springfiles.com/spring/game-installers/kernel-panic-installer}}
</div>

(!) Old engine version included. Experience of online play might be hampered.

For more Spring games, check out the [[Games]] page. Please note that some of them will require you to have the engine installed in order to work, as well as some maps, as they don't come with their own installer.

= Universal Downloaders =
As Spring itself is just an engine and does not contain game content. 
There are several options for getting games/maps though, one is using the internal downloaders of the lobbies:

<div style="padding-left:7px">
{{Template:GamesDownload|name=SpringLobby|image=Springlobby_64.png|url=http://www.springlobby.info/windows/latest.zip}}
(Multiplatform, no rapid support yet)

{{Template:GamesDownload|name=Zero-K lobby|image=eclipse.jpg|url=http://zero-k.info/Wiki/Download}}
(Windows only, rapid included, multi-engine support - uncheck 'official games' to see all)

{{Template:GamesDownload|name=rapid (command-line)|url=http://github.com/tvo/rapid}}
(currently only downloads games)
</div>

Notes: All above mentioned tools are included in the [[Download#Spring_Engine_Updates|Spring installer]].

User:Smoth

2012-05-05T14:11:12Z

Smoth:

[09:09:47] <[LCC]jK> truth is there are only 2 facts: synced can never READ unsynced data, and unsynced can never WRITE synced data
[09:10:02] <[LCC]jK> everything else is allowed

Plans for game developer restructure: 3 sections, beginer, intermediate and advanced.

Game creation: Beginner:(1 star)

#focus on how does I get my game in spring
#how can I alter what is already there
#stay within knorkes beginner game, we want to have the user in a sort of sandbox.
#think mutator

Intermediate:(2 stars)

#focus on creating your own content and using it in game
#introduce them into existing resources lua/models/art
#most tutorials will be located here.
#think mod

Advanced:(3 stars)

#person is experience programmer or familiar with spring already.
#no tutorials, just informational links, this person wants information not how tos.

 Map creation:

#pretty much just a big dump of all the map related resources for now.

'''Notes for SimpleParticleSystem:'''

*[[Testpageforforb|a label]]

*'''float3 pos''' Origon point for your particle system.
*'''[[AtlasedTexture]] texture''' Texture for the particles, defined in resources.tdf.
*'''float3 emitVector''' Use DIR to have it acquire a direction, this will utilize a poly on your object that you choose as an emitter. See my notes on vectors to understand how to use the vectors of this: ''i.e. 0,1,0 is straight up''
*'''[[CColorMap]] colorMap''' This will give your system a range of colors spread over time. it has 4 parts: RED, GREEN, BLUE, ALPHA note: For additive blend use values that are low like: 0.1 or 0.05 For overlay use 1.0 see notes on overlay versus additive blend.
*'''float3 gravity''' Gravity applied along a vector. For example, if you want your particles to fall after being emmited. Emitvector would be: 0,1,0 and gravity would need to be 0,-1,0 This would result in particles falling straight down.
*'''float airdrag''' Constant multiplier on the particle each frame, a value of 1.0 means the particles will keep their current momentum, a value bellow 1 and they will slow down each frame.
*'''float particleLife''' Life of the particles in frames.
*'''float particleLifeSpread''' Random number between 0 and particleLifeSpread added to particleLife.
*'''int numParticles''' Number of particles that will be spawned.
*'''float particleSpeed''' Initial speed of the particles.
*'''float particleSpeedSpread''' Random number between 0 and particleSpeedSpread added to particleSpeed.
*'''float particleSize''' Size of the particles.
*'''float particleSizeSpread''' Random number between 0 and particleSizeSpread added to particleSize.
*'''float sizeGrowth''' Size added to particles each frame.
*'''float sizeMod''' Size frame multiplier.
*'''float emitRot''' Rotation in degree from emitVector that particles will be spawned from, a value of 90 will emmit particles in a plane perpendicular to the emitVector.
*'''float emitRotSpread''' Random number between 0 and emitRotSpread added to emitRot, a value of 180 will make the particles spawn in a full sphere.
*'''bool directional''' If the particles should be oriented to point at the direction of their velocity.

'''Notes vectors:'''

*Vectors are directional systems represented by a 3d graph here: [[File:Untitled-1.png]] See how each vector points along it's own line? We have 6 possible directions: <center></center>

X = right -X = left Z = Front -Z = Rear Y = Up -Y = Down

WORK IN PROGRESS!

 '''Notes Additive blend versus overlay blend:''' WORK IN PROGRESS!

*ADDTITIVE
*OVERLAY

 IsShield=1; // if 1 mean the weapon is a shield and not a weapon shieldrepulser=1; // 0=destroy projectile,1=repulse (bounce) projectile smartshield=1; // 1=shield doesnt affect allies weapons exteriorshield=1; // 1=shield doesnt affect weapons fired from within shield visibleshield=1; // 1=see a visible shell representing the shield visibleshieldrepulse=1; // 1=see a beam showing when shield repulses something shieldenergyuse=10; // how much energy the shield use when repulsing/destroying something shieldforce=1000; // how hard shield can accelerate some sort of projectiles away shieldradius=30; // size of shield effect shieldmaxspeed=1100; // maximum speed the shield can push some sort of projectiles away shieldpower=300; // how much power the shield can store, power is drained by the affected weapons damage, 0=infinite shieldpowerregen=5; // how fast the shield regenerates power shieldpowerregenenergy=10; // how much energy the shield uses when regenerating power shieldintercepttype=2; // which types of weapon the shield can affect (bitfield) //interceptedbyshieldtype=; // which types of shields can affect this weapon, if (shieldInterceptType & interceptedByShieldType) is not zero the shield can affect the weapon, default 1 for plasma, 2 for laser, 4 for missiles, 0 for other shieldgoodcolor=0.0 0.05 0.75; // color of shield when power is full shieldbadcolor=0.6 0.05 0.75; // color of shield when power is empty shieldalpha=1; // how visible the shield shell is with visibleshield=1

User:Smoth

2012-04-10T15:38:16Z

Smoth:

Plans for game developer restructure: 3 sections, beginer, intermediate and advanced.

Game creation: Beginner:(1 star)

#focus on how does I get my game in spring
#how can I alter what is already there
#stay within knorkes beginner game, we want to have the user in a sort of sandbox.
#think mutator

Intermediate:(2 stars)

#focus on creating your own content and using it in game
#introduce them into existing resources lua/models/art
#most tutorials will be located here.
#think mod

Advanced:(3 stars)

#person is experience programmer or familiar with spring already.
#no tutorials, just informational links, this person wants information not how tos.

 Map creation:

#pretty much just a big dump of all the map related resources for now.

'''Notes for SimpleParticleSystem:'''

*[[Testpageforforb|a label]]

*'''float3 pos''' Origon point for your particle system.
*'''[[AtlasedTexture]] texture''' Texture for the particles, defined in resources.tdf.
*'''float3 emitVector''' Use DIR to have it acquire a direction, this will utilize a poly on your object that you choose as an emitter. See my notes on vectors to understand how to use the vectors of this: ''i.e. 0,1,0 is straight up''
*'''[[CColorMap]] colorMap''' This will give your system a range of colors spread over time. it has 4 parts: RED, GREEN, BLUE, ALPHA note: For additive blend use values that are low like: 0.1 or 0.05 For overlay use 1.0 see notes on overlay versus additive blend.
*'''float3 gravity''' Gravity applied along a vector. For example, if you want your particles to fall after being emmited. Emitvector would be: 0,1,0 and gravity would need to be 0,-1,0 This would result in particles falling straight down.
*'''float airdrag''' Constant multiplier on the particle each frame, a value of 1.0 means the particles will keep their current momentum, a value bellow 1 and they will slow down each frame.
*'''float particleLife''' Life of the particles in frames.
*'''float particleLifeSpread''' Random number between 0 and particleLifeSpread added to particleLife.
*'''int numParticles''' Number of particles that will be spawned.
*'''float particleSpeed''' Initial speed of the particles.
*'''float particleSpeedSpread''' Random number between 0 and particleSpeedSpread added to particleSpeed.
*'''float particleSize''' Size of the particles.
*'''float particleSizeSpread''' Random number between 0 and particleSizeSpread added to particleSize.
*'''float sizeGrowth''' Size added to particles each frame.
*'''float sizeMod''' Size frame multiplier.
*'''float emitRot''' Rotation in degree from emitVector that particles will be spawned from, a value of 90 will emmit particles in a plane perpendicular to the emitVector.
*'''float emitRotSpread''' Random number between 0 and emitRotSpread added to emitRot, a value of 180 will make the particles spawn in a full sphere.
*'''bool directional''' If the particles should be oriented to point at the direction of their velocity.

'''Notes vectors:'''

*Vectors are directional systems represented by a 3d graph here: [[File:Untitled-1.png]] See how each vector points along it's own line? We have 6 possible directions: <center></center>

X = right -X = left Z = Front -Z = Rear Y = Up -Y = Down

WORK IN PROGRESS!

 '''Notes Additive blend versus overlay blend:''' WORK IN PROGRESS!

*ADDTITIVE
*OVERLAY

 IsShield=1; // if 1 mean the weapon is a shield and not a weapon shieldrepulser=1; // 0=destroy projectile,1=repulse (bounce) projectile smartshield=1; // 1=shield doesnt affect allies weapons exteriorshield=1; // 1=shield doesnt affect weapons fired from within shield visibleshield=1; // 1=see a visible shell representing the shield visibleshieldrepulse=1; // 1=see a beam showing when shield repulses something shieldenergyuse=10; // how much energy the shield use when repulsing/destroying something shieldforce=1000; // how hard shield can accelerate some sort of projectiles away shieldradius=30; // size of shield effect shieldmaxspeed=1100; // maximum speed the shield can push some sort of projectiles away shieldpower=300; // how much power the shield can store, power is drained by the affected weapons damage, 0=infinite shieldpowerregen=5; // how fast the shield regenerates power shieldpowerregenenergy=10; // how much energy the shield uses when regenerating power shieldintercepttype=2; // which types of weapon the shield can affect (bitfield) //interceptedbyshieldtype=; // which types of shields can affect this weapon, if (shieldInterceptType & interceptedByShieldType) is not zero the shield can affect the weapon, default 1 for plasma, 2 for laser, 4 for missiles, 0 for other shieldgoodcolor=0.0 0.05 0.75; // color of shield when power is full shieldbadcolor=0.6 0.05 0.75; // color of shield when power is empty shieldalpha=1; // how visible the shield shell is with visibleshield=1

User:Smoth

2012-04-10T15:21:08Z

Smoth:

Plans for game developer restructure: 3 sections, beginer, intermediate and advanced. Beginner:(1 star)

#focus on how does I get my game in spring
#how can I alter what is already there
#stay within knorkes beginner game, we want to have the user in a sort of sandbox.
#think mutator

Intermediate:(2 stars)

#focus on creating your own content and using it in game
#introduce them into existing resources lua/models/art
#most tutorials will be located here.
#think mod

Advanced:(3 stars)

#person is experience programmer or familiar with spring already.
#no tutorials, just informational links, this person wants information not how tos.

SmothSmoth is Smmmmmmmmmmoooootttthhhhh!!

'''Notes for SimpleParticleSystem:'''

*[[Testpageforforb|a label]]

*'''float3 pos''' Origon point for your particle system. 
*'''[[AtlasedTexture]] texture''' Texture for the particles, defined in resources.tdf. 
*'''float3 emitVector''' Use DIR to have it acquire a direction, this will utilize a poly on your object that you choose as an emitter. See my notes on vectors to understand how to use the vectors of this: ''i.e. 0,1,0 is straight up'' 
*'''[[CColorMap]] colorMap''' This will give your system a range of colors spread over time. it has 4 parts: RED, GREEN, BLUE, ALPHA note: For additive blend use values that are low like: 0.1 or 0.05 For overlay use 1.0 see notes on overlay versus additive blend. 
*'''float3 gravity''' Gravity applied along a vector. For example, if you want your particles to fall after being emmited. Emitvector would be: 0,1,0 and gravity would need to be 0,-1,0 This would result in particles falling straight down. 
*'''float airdrag''' Constant multiplier on the particle each frame, a value of 1.0 means the particles will keep their current momentum, a value bellow 1 and they will slow down each frame. 
*'''float particleLife''' Life of the particles in frames. 
*'''float particleLifeSpread''' Random number between 0 and particleLifeSpread added to particleLife. 
*'''int numParticles''' Number of particles that will be spawned. 
*'''float particleSpeed''' Initial speed of the particles. 
*'''float particleSpeedSpread''' Random number between 0 and particleSpeedSpread added to particleSpeed. 
*'''float particleSize''' Size of the particles. 
*'''float particleSizeSpread''' Random number between 0 and particleSizeSpread added to particleSize. 
*'''float sizeGrowth''' Size added to particles each frame. 
*'''float sizeMod''' Size frame multiplier. 
*'''float emitRot''' Rotation in degree from emitVector that particles will be spawned from, a value of 90 will emmit particles in a plane perpendicular to the emitVector. 
*'''float emitRotSpread''' Random number between 0 and emitRotSpread added to emitRot, a value of 180 will make the particles spawn in a full sphere. 
*'''bool directional''' If the particles should be oriented to point at the direction of their velocity. 

'''Notes vectors:'''

*Vectors are directional systems represented by a 3d graph here: [[File:Untitled-1.png]] See how each vector points along it's own line? We have 6 possible directions: <center>
X = right -X = left Z = Front -Z = Rear Y = Up -Y = Down
</center>
WORK IN PROGRESS!
 

 '''Notes Additive blend versus overlay blend:'''
WORK IN PROGRESS! 
*ADDTITIVE 
*OVERLAY 

 IsShield=1; // if 1 mean the weapon is a shield and not a weapon shieldrepulser=1; // 0=destroy projectile,1=repulse (bounce) projectile smartshield=1; // 1=shield doesnt affect allies weapons exteriorshield=1; // 1=shield doesnt affect weapons fired from within shield visibleshield=1; // 1=see a visible shell representing the shield visibleshieldrepulse=1; // 1=see a beam showing when shield repulses something shieldenergyuse=10; // how much energy the shield use when repulsing/destroying something shieldforce=1000; // how hard shield can accelerate some sort of projectiles away shieldradius=30; // size of shield effect shieldmaxspeed=1100; // maximum speed the shield can push some sort of projectiles away shieldpower=300; // how much power the shield can store, power is drained by the affected weapons damage, 0=infinite shieldpowerregen=5; // how fast the shield regenerates power shieldpowerregenenergy=10; // how much energy the shield uses when regenerating power shieldintercepttype=2; // which types of weapon the shield can affect (bitfield) //interceptedbyshieldtype=; // which types of shields can affect this weapon, if (shieldInterceptType & interceptedByShieldType) is not zero the shield can affect the weapon, default 1 for plasma, 2 for laser, 4 for missiles, 0 for other shieldgoodcolor=0.0 0.05 0.75; // color of shield when power is full shieldbadcolor=0.6 0.05 0.75; // color of shield when power is empty shieldalpha=1; // how visible the shield shell is with visibleshield=1

Movedefs.lua

2012-02-12T17:15:33Z

Smoth: /* MoveClass Tags */

==Location==
<code>movedefs.lua</code> is a file in the <code>Gamedata/</code> directory of a Spring Game.

==Purpose==
This file defines '''MoveClasses''' which are used to determine pathing for units.

==Source==
The engine source code which parses the data from this file is viewable here: {{sourcelink|file=rts/Sim/MoveTypes/MoveInfo.cpp}}

==Details==
A mobile unit is assigned a '''MoveClass''' using the <code>movementClass</code> [[Units-UnitDefs#Movement_.26_Placement|UnitDef]] tag. The engine determines the unit's pathfinding based on the properties of the '''MoveClass''', so analogous properties (e.g. <code>FootprintX</code>) in the [[Units-UnitDefs|UnitDef]] should be the same for optimal behaviour.

All '''MoveClasses''' must belong to one of four possible types. A '''MoveClass''' is assigned a type simply by including it within the name string e.g. <code>Tank_MyMoveClassName</code>. Types are used in '''TypeMaps''' of Spring maps, which allow mappers to set per-type speed multipliers.

===Types===
* <code>Bot</code> - A ground based '''MoveClass'''. The default type if no matching type string is found.
* <code>Tank</code> - A ground based '''MoveClass'''. Identical to <code>Bot</code> other than interaction with '''TypeMaps'''.
* <code>Ship</code> or <code>Boat</code> - Are synonyms. All ships / boat '''MoveClasses''' must belong to this type to behave as ships.
* <code>Hover</code> - All hovercraft '''MoveClasses''' (traverse any depth of water without speed reduction) must belong to this class, as well as having <code>canHover</code> in their [[Units-UnitDefs#Movement_.26_Placement|UnitDef]] to behave as hovers.

==MoveClass Tags==
{{tag|name=name|type=string|default=""}} The name of the '''MoveClass'''. Usually passed by the sub-table variable name rather than using the <code>name</code> tag (See [[#Example]]). Must contain "tank", "hover", "ship" or "boat" respectively for non-Bot types.

{{tag|name=footprintX|type=int|default=1}} How wide the '''MoveClass''' is in footprint units, left to right. 1 footprint unit = 16 [[elmos]]. Cannot be below <code>1</code>. For mobile units this should be the same as the <code>footprintX</code> of its [[Units-UnitDefs#Movement_.26_Placement|UnitDef]].

{{tag|name=footprintZ|type=int|default=footprintX}} How wide the '''MoveClass''' is in footprint units, top to bottom. 1 footprint unit = 16 [[elmos]]. Cannot be below <code>1</code>. For mobile units this should be the same as the <code>footprintZ</code> of its [[Units-UnitDefs#Movement_.26_Placement|UnitDef]].

{{tag|name=crushStrength|type=float|default=10.0}} Power of a unit with this '''MoveClass''' to crush features and units. Any features (and units with crushing enabled via [[Lua_SyncedCtrl#Unit_Control|Spring.SetUnitBlocking]]) with a <code>crushResistance</code> less than this value will be crushed on contact (See [[Units-FeatureDefs#General]] and [[Units-UnitDefs#General]]).

{{tag|name=maxSlope|type=float|default=60.0</code> (<code>15.0</code> for hover types)<code>}} The maximum steepness of slope a unit with this '''MoveClass''' can climb. Spring doesn't calculate this in degrees, see [[#How_slope_is_determined]].

{{tag|name=slopeMod|type=float|default=4.0 / (maxSlope + 0.001)}} How much a slope will slow a unit, <code>0</code> means no slowdown.

=== Heat Tags ===
These tags are used in unit avoidance.
* '''<code>heatMapping</code>''' - type: <code>bool</code> - default: <code>false</code>
: This enables/disables generation and usage of path heats.
* '''<code>heatMod</code>''' - type: <code>float</code> - default: <code>0.05</code>
: The pathfinder cost modifier that is multiplied by the heat of the current square.
* '''<code>heatProduced</code>''' - type: <code>int</code> - default: <code>30</code>
: How much heat to place on a square if a path goes through it. ''heat set = max(currentSquareHeat, <code>heatProduced</code>)''.

=== Tank & Bot-Only Tags ===
*DepthMod
**how much to slow down amphibian speed when they're underwater
*MaxWaterDepth

=== Ship-Only Tags ===
*MinWaterDepth
*SubMarine

==Special notes==
* depth is measured in elmos
* Slope is not measured in degrees.
* CrushStrength uses mass to determine if a feature can be crushed by a unit.
** default feature: mass = metal * 0.4 + maxHealth * 0.1
** default unit: mass = metalCost
* Slope/Depth mod
** This value applies directly based on the slope/depth, meaning the deeper or higher the slope, the MORE it slows a unit down.

==How slope is determined==
Spring doesn't represent terrain slopes in degrees, internally it uses
<code>(1.0 - the terrain normal's y-component)</code> so the slope of vertical faces is <code>1</code> and that of horizontal ones <code>0</code>. A unit's <code>maxSlope</code> value (which is in
degrees in its movedef) is converted so that the "can we go here?" (ie
"<code>maxSlope > terrainSlope</code>?") comparisons are meaningful, the formula
is <code>1.0 - cos(DEG2RAD(maxSlope * 1.5))</code>. If you want to know the terrain angle in degrees, compute <code>RAD2DEG(arccos(1.0 - terrainSlope))</code>. For a bot with a <code>maxSlope</code> of 36 degrees (~0.41221 in "Spring format"), the maximum tolerable terrain angle is approximately

<code>RAD2DEG(arccos(1.0 - 0.41221))</code>

or 54 degrees. If <code>maxSlope</code> was <code>30</code>, the MTTA would be 45, and if it was <code>60</code> (the highest sensible value due to that 1.5 scalar and the absence of overhanging cliffs) the bot could mount any terrain. In other words you do not need the long mathematical derivation, just remember that
<code>maxTerrainAngle = maxSlope * 1.5</code>

--kloot, Thu Jul 31, 2008

==Example==
===External Examples===
[http://imolarpg.dyndns.org/trac/balatest/browser/trunk/gamedata/movedefs.lua 'Balanced Annihilation' movedefs.lua]

[http://trac.caspring.org/browser/trunk/mods/ca/gamedata/movedefs.lua 'Complete Annihilation' movedefs.lua]

[http://spring1944.svn.sourceforge.net/viewvc/spring1944/trunk/S44Main.sdd/gamedata/movedefs.lua?&view=markup 'Spring: 1944' movedefs.lua]

[http://code.google.com/p/springtutorialgame/source/browse/trunk/SpringTutorialGame.sdd/Gamedata/movedefs.lua 'Spring Tutorial Game' movedefs.lua]

[http://code.google.com/p/zero-k/source/browse/trunk/mods/zk/gamedata/movedefs.lua 'ZeroK' movedefs.lua]
[[Category: Unit_development]]
[[Category:Gamedata]]

Movedefs.lua

2012-02-12T17:14:50Z

Smoth: /* MoveClass Tags */

==Location==
<code>movedefs.lua</code> is a file in the <code>Gamedata/</code> directory of a Spring Game.

==Purpose==
This file defines '''MoveClasses''' which are used to determine pathing for units.

==Source==
The engine source code which parses the data from this file is viewable here: {{sourcelink|file=rts/Sim/MoveTypes/MoveInfo.cpp}}

==Details==
A mobile unit is assigned a '''MoveClass''' using the <code>movementClass</code> [[Units-UnitDefs#Movement_.26_Placement|UnitDef]] tag. The engine determines the unit's pathfinding based on the properties of the '''MoveClass''', so analogous properties (e.g. <code>FootprintX</code>) in the [[Units-UnitDefs|UnitDef]] should be the same for optimal behaviour.

All '''MoveClasses''' must belong to one of four possible types. A '''MoveClass''' is assigned a type simply by including it within the name string e.g. <code>Tank_MyMoveClassName</code>. Types are used in '''TypeMaps''' of Spring maps, which allow mappers to set per-type speed multipliers.

===Types===
* <code>Bot</code> - A ground based '''MoveClass'''. The default type if no matching type string is found.
* <code>Tank</code> - A ground based '''MoveClass'''. Identical to <code>Bot</code> other than interaction with '''TypeMaps'''.
* <code>Ship</code> or <code>Boat</code> - Are synonyms. All ships / boat '''MoveClasses''' must belong to this type to behave as ships.
* <code>Hover</code> - All hovercraft '''MoveClasses''' (traverse any depth of water without speed reduction) must belong to this class, as well as having <code>canHover</code> in their [[Units-UnitDefs#Movement_.26_Placement|UnitDef]] to behave as hovers.

==MoveClass Tags==
{{tag|name=name|type=string|default=""}} The name of the '''MoveClass'''. Usually passed by the sub-table variable name rather than using the <code>name</code> tag (See [[#Example]]). Must contain "tank", "hover", "ship" or "boat" respectively for non-Bot types.

{{tag|name=footprintX|type=int|default=1}}
**How wide the '''MoveClass''' is in footprint units, left to right. 1 footprint unit = 16 [[elmos]]. Cannot be below <code>1</code>. For mobile units this should be the same as the <code>footprintX</code> of its [[Units-UnitDefs#Movement_.26_Placement|UnitDef]].

{{tag|name=footprintZ|type=int|default=footprintX}} How wide the '''MoveClass''' is in footprint units, top to bottom. 1 footprint unit = 16 [[elmos]]. Cannot be below <code>1</code>. For mobile units this should be the same as the <code>footprintZ</code> of its [[Units-UnitDefs#Movement_.26_Placement|UnitDef]].

{{tag|name=crushStrength|type=float|default=10.0}} Power of a unit with this '''MoveClass''' to crush features and units. Any features (and units with crushing enabled via [[Lua_SyncedCtrl#Unit_Control|Spring.SetUnitBlocking]]) with a <code>crushResistance</code> less than this value will be crushed on contact (See [[Units-FeatureDefs#General]] and [[Units-UnitDefs#General]]).

{{tag|name=maxSlope|type=float|default=60.0</code> (<code>15.0</code> for hover types)<code>}} The maximum steepness of slope a unit with this '''MoveClass''' can climb. Spring doesn't calculate this in degrees, see [[#How_slope_is_determined]].

{{tag|name=slopeMod|type=float|default=4.0 / (maxSlope + 0.001)}} How much a slope will slow a unit, <code>0</code> means no slowdown.

=== Heat Tags ===
These tags are used in unit avoidance.
* '''<code>heatMapping</code>''' - type: <code>bool</code> - default: <code>false</code>
: This enables/disables generation and usage of path heats.
* '''<code>heatMod</code>''' - type: <code>float</code> - default: <code>0.05</code>
: The pathfinder cost modifier that is multiplied by the heat of the current square.
* '''<code>heatProduced</code>''' - type: <code>int</code> - default: <code>30</code>
: How much heat to place on a square if a path goes through it. ''heat set = max(currentSquareHeat, <code>heatProduced</code>)''.

=== Tank & Bot-Only Tags ===
*DepthMod
**how much to slow down amphibian speed when they're underwater
*MaxWaterDepth

=== Ship-Only Tags ===
*MinWaterDepth
*SubMarine

==Special notes==
* depth is measured in elmos
* Slope is not measured in degrees.
* CrushStrength uses mass to determine if a feature can be crushed by a unit.
** default feature: mass = metal * 0.4 + maxHealth * 0.1
** default unit: mass = metalCost
* Slope/Depth mod
** This value applies directly based on the slope/depth, meaning the deeper or higher the slope, the MORE it slows a unit down.

==How slope is determined==
Spring doesn't represent terrain slopes in degrees, internally it uses
<code>(1.0 - the terrain normal's y-component)</code> so the slope of vertical faces is <code>1</code> and that of horizontal ones <code>0</code>. A unit's <code>maxSlope</code> value (which is in
degrees in its movedef) is converted so that the "can we go here?" (ie
"<code>maxSlope > terrainSlope</code>?") comparisons are meaningful, the formula
is <code>1.0 - cos(DEG2RAD(maxSlope * 1.5))</code>. If you want to know the terrain angle in degrees, compute <code>RAD2DEG(arccos(1.0 - terrainSlope))</code>. For a bot with a <code>maxSlope</code> of 36 degrees (~0.41221 in "Spring format"), the maximum tolerable terrain angle is approximately

<code>RAD2DEG(arccos(1.0 - 0.41221))</code>

or 54 degrees. If <code>maxSlope</code> was <code>30</code>, the MTTA would be 45, and if it was <code>60</code> (the highest sensible value due to that 1.5 scalar and the absence of overhanging cliffs) the bot could mount any terrain. In other words you do not need the long mathematical derivation, just remember that
<code>maxTerrainAngle = maxSlope * 1.5</code>

--kloot, Thu Jul 31, 2008

==Example==
===External Examples===
[http://imolarpg.dyndns.org/trac/balatest/browser/trunk/gamedata/movedefs.lua 'Balanced Annihilation' movedefs.lua]

[http://trac.caspring.org/browser/trunk/mods/ca/gamedata/movedefs.lua 'Complete Annihilation' movedefs.lua]

[http://spring1944.svn.sourceforge.net/viewvc/spring1944/trunk/S44Main.sdd/gamedata/movedefs.lua?&view=markup 'Spring: 1944' movedefs.lua]

[http://code.google.com/p/springtutorialgame/source/browse/trunk/SpringTutorialGame.sdd/Gamedata/movedefs.lua 'Spring Tutorial Game' movedefs.lua]

[http://code.google.com/p/zero-k/source/browse/trunk/mods/zk/gamedata/movedefs.lua 'ZeroK' movedefs.lua]
[[Category: Unit_development]]
[[Category:Gamedata]]

Movedefs.lua

2012-02-12T17:14:35Z

Smoth: /* MoveClass Tags */

==Location==
<code>movedefs.lua</code> is a file in the <code>Gamedata/</code> directory of a Spring Game.

==Purpose==
This file defines '''MoveClasses''' which are used to determine pathing for units.

==Source==
The engine source code which parses the data from this file is viewable here: {{sourcelink|file=rts/Sim/MoveTypes/MoveInfo.cpp}}

==Details==
A mobile unit is assigned a '''MoveClass''' using the <code>movementClass</code> [[Units-UnitDefs#Movement_.26_Placement|UnitDef]] tag. The engine determines the unit's pathfinding based on the properties of the '''MoveClass''', so analogous properties (e.g. <code>FootprintX</code>) in the [[Units-UnitDefs|UnitDef]] should be the same for optimal behaviour.

All '''MoveClasses''' must belong to one of four possible types. A '''MoveClass''' is assigned a type simply by including it within the name string e.g. <code>Tank_MyMoveClassName</code>. Types are used in '''TypeMaps''' of Spring maps, which allow mappers to set per-type speed multipliers.

===Types===
* <code>Bot</code> - A ground based '''MoveClass'''. The default type if no matching type string is found.
* <code>Tank</code> - A ground based '''MoveClass'''. Identical to <code>Bot</code> other than interaction with '''TypeMaps'''.
* <code>Ship</code> or <code>Boat</code> - Are synonyms. All ships / boat '''MoveClasses''' must belong to this type to behave as ships.
* <code>Hover</code> - All hovercraft '''MoveClasses''' (traverse any depth of water without speed reduction) must belong to this class, as well as having <code>canHover</code> in their [[Units-UnitDefs#Movement_.26_Placement|UnitDef]] to behave as hovers.

==MoveClass Tags==
{{tag|name=name|type=string|default=""}} The name of the '''MoveClass'''. Usually passed by the sub-table variable name rather than using the <code>name</code> tag (See [[#Example]]). Must contain "tank", "hover", "ship" or "boat" respectively for non-Bot types.

{{tag|name=footprintX|type=int|default=1}} **How wide the '''MoveClass''' is in footprint units, left to right. 1 footprint unit = 16 [[elmos]]. Cannot be below <code>1</code>. For mobile units this should be the same as the <code>footprintX</code> of its [[Units-UnitDefs#Movement_.26_Placement|UnitDef]].

{{tag|name=footprintZ|type=int|default=footprintX}} How wide the '''MoveClass''' is in footprint units, top to bottom. 1 footprint unit = 16 [[elmos]]. Cannot be below <code>1</code>. For mobile units this should be the same as the <code>footprintZ</code> of its [[Units-UnitDefs#Movement_.26_Placement|UnitDef]].

{{tag|name=crushStrength|type=float|default=10.0}} Power of a unit with this '''MoveClass''' to crush features and units. Any features (and units with crushing enabled via [[Lua_SyncedCtrl#Unit_Control|Spring.SetUnitBlocking]]) with a <code>crushResistance</code> less than this value will be crushed on contact (See [[Units-FeatureDefs#General]] and [[Units-UnitDefs#General]]).

{{tag|name=maxSlope|type=float|default=60.0</code> (<code>15.0</code> for hover types)<code>}} The maximum steepness of slope a unit with this '''MoveClass''' can climb. Spring doesn't calculate this in degrees, see [[#How_slope_is_determined]].

{{tag|name=slopeMod|type=float|default=4.0 / (maxSlope + 0.001)}} How much a slope will slow a unit, <code>0</code> means no slowdown.

=== Heat Tags ===
These tags are used in unit avoidance.
* '''<code>heatMapping</code>''' - type: <code>bool</code> - default: <code>false</code>
: This enables/disables generation and usage of path heats.
* '''<code>heatMod</code>''' - type: <code>float</code> - default: <code>0.05</code>
: The pathfinder cost modifier that is multiplied by the heat of the current square.
* '''<code>heatProduced</code>''' - type: <code>int</code> - default: <code>30</code>
: How much heat to place on a square if a path goes through it. ''heat set = max(currentSquareHeat, <code>heatProduced</code>)''.

=== Tank & Bot-Only Tags ===
*DepthMod
**how much to slow down amphibian speed when they're underwater
*MaxWaterDepth

=== Ship-Only Tags ===
*MinWaterDepth
*SubMarine

==Special notes==
* depth is measured in elmos
* Slope is not measured in degrees.
* CrushStrength uses mass to determine if a feature can be crushed by a unit.
** default feature: mass = metal * 0.4 + maxHealth * 0.1
** default unit: mass = metalCost
* Slope/Depth mod
** This value applies directly based on the slope/depth, meaning the deeper or higher the slope, the MORE it slows a unit down.

==How slope is determined==
Spring doesn't represent terrain slopes in degrees, internally it uses
<code>(1.0 - the terrain normal's y-component)</code> so the slope of vertical faces is <code>1</code> and that of horizontal ones <code>0</code>. A unit's <code>maxSlope</code> value (which is in
degrees in its movedef) is converted so that the "can we go here?" (ie
"<code>maxSlope > terrainSlope</code>?") comparisons are meaningful, the formula
is <code>1.0 - cos(DEG2RAD(maxSlope * 1.5))</code>. If you want to know the terrain angle in degrees, compute <code>RAD2DEG(arccos(1.0 - terrainSlope))</code>. For a bot with a <code>maxSlope</code> of 36 degrees (~0.41221 in "Spring format"), the maximum tolerable terrain angle is approximately

<code>RAD2DEG(arccos(1.0 - 0.41221))</code>

or 54 degrees. If <code>maxSlope</code> was <code>30</code>, the MTTA would be 45, and if it was <code>60</code> (the highest sensible value due to that 1.5 scalar and the absence of overhanging cliffs) the bot could mount any terrain. In other words you do not need the long mathematical derivation, just remember that
<code>maxTerrainAngle = maxSlope * 1.5</code>

--kloot, Thu Jul 31, 2008

==Example==
===External Examples===
[http://imolarpg.dyndns.org/trac/balatest/browser/trunk/gamedata/movedefs.lua 'Balanced Annihilation' movedefs.lua]

[http://trac.caspring.org/browser/trunk/mods/ca/gamedata/movedefs.lua 'Complete Annihilation' movedefs.lua]

[http://spring1944.svn.sourceforge.net/viewvc/spring1944/trunk/S44Main.sdd/gamedata/movedefs.lua?&view=markup 'Spring: 1944' movedefs.lua]

[http://code.google.com/p/springtutorialgame/source/browse/trunk/SpringTutorialGame.sdd/Gamedata/movedefs.lua 'Spring Tutorial Game' movedefs.lua]

[http://code.google.com/p/zero-k/source/browse/trunk/mods/zk/gamedata/movedefs.lua 'ZeroK' movedefs.lua]
[[Category: Unit_development]]
[[Category:Gamedata]]

Game and Unit development

2012-02-12T04:54:50Z

Smoth: /* Lua Animations */

[[Engine_Development|Development]] < {{FULLPAGENAME}}

=Game development=
This information is meant to help newcomers learn how to develop their own games for the Spring Engine.

==General==
* [[Map,_Mod,_And_Unit_Development_Programs|Development Tools]]
*[[Game structure]] 
*[[Game specification|Game specification]] 
*[http://answers.springlobby.info/ Q&A Site for the Spring Engine]
*[http://springrts.com/phpbb/viewtopic.php?f=14&t=26409| Porting TA content to Spring]

==Resources==
*[[General_Resources|Free Assets]]
*[[SpringTutorialGame|Spring Tutorial Game]] - (attempt to create) a "template game" for new projects.
*[[LUPS]]
*[[Chili]]
*[[IceUI]]
*[[RedUI]]
*[[LOLUI]]
*[[FeaturePlacer]]

==Reference==
*UnitDefs (.fbi, .lua)
**[[Units-UnitDefs|UnitDefs]] - define the attributes of units
**[[Unit_Categories]] - define which weapon type aim at which targets
**[[Unit_collision_volumes | Unit Collision Volumes]] - collision detection
*WeaponDefs (.tdf, .lua)
**[[Weapon Variables]] : This is the most up to date
**[[Units:WeaponMainDir]]
**[[Weapons:Antinukes]]: All about antinukes.
*MoveDefs*
**[[Units:MoveTypes]]
*FeatureDefs (objects on the map, wrecks of destroyed units)
**[[Units-FeatureDefs]]
*Global game variables (modrules.lua)
**[[Modrules.lua]]
*[[CEG]] Explosions (.tdf, .lua)*
**[[CEG-Calls]]
**[[CEG-Format]]
**[[CEG-Classes]]
**[[CEG-Operators]]
**[[CEG-Miscellaneous]]
**[[CEG-OldInfo]]
*Misc
**[[VirtualFileSystem]]
**[[MouseCursors]]
**[[Units:Textures]]
**[[Units:Buildpics]]
**[[Sidedata.lua]]
**[[Units:FlankingBonus]]
**[[Mod Development:Armor|Game Development:Armor]]
**[[Mod Development:Archives|Game Development:Archives]]
**[[Mod Development:Sidepics|Game Development:Sidepics]]
**[[CustomUnitIcons|Game Development:Custom unit icons]]

=Unit Scripting/Animations (.cob, .bos, .lua)=
* [[Animation-CobLuaDifferences | Differences of .lua and .cob unit scripts]]

==Lua Animations==
While called Lua animations, that is a misnomer, these are not just animation, these are high level behavior scripts which control not only animation but firing of weapons and various other unit functions.
*[[Animation-LuaScripting]]
**[[Animation-LuaCallins]]
**[[Animation-LuaCallouts]]
**[[Animation-CobLuaDifferences]]

==COB Animations==
The binary '.cob' file format is a compiled '.bos' script. To convert a '.bos' script file to '.cob' file you will need [[Scriptor]]

*[[Animation-CobOverview]]
**[[Animation-CobExamples]]
**[[Animation-CobAnimation]]
**[[Animation-CobCallins]]
**[[Animation-CobConstants]]
**[[Animation-CobThreads]]
**[[Animation-CobHitByWeaponID]]
*[[Units:LuaCOB]] - how to interface COB with LUA
*[[CEG_For_Units|Game Development:Calling basic CEGs from COB]]
* [http://springrts.com/phpbb/viewtopic.php?p=132943#132943 GPL-compliant sourcecode, scripting code examples, and other things.]

=Modeling =
Spring supports different 3d representations: '[[About_s3o|.s3o]]' and '[[About_3do|.3do]]'. The biggest difference between both formats is the workflow to create a new unit. There are exporter plugins for 'blender' and '3ds-max' so that texturing and modeling can be done using these.
In contrast: when you model an '.3do' you have to use [[upspring]] currently.

The animation with can either be done using 'lua' or 'COB/BOS' is does not depend on either, see rigging/animation. For new units use 'lua' scripting.

=Engine Related=
* [[Download_Testing]] - Test the compatibility of your game on upcoming versions of the Spring engine.

=Tutorials=
===Game Development Tutorials===
*[[Simple Mod Tutorial|Simple Game Tutorial]]
*[[The Complete Guide To Making A Spring Game]] - A fairly comprehensive getting started tutorial.
*[http://springrts.com/phpbb/viewtopic.php?f=14&t=26409| Porting TA content to Spring]
===Modeling Tutorials===
* [http://springrts.com/phpbb/viewtopic.php?t=10612 Wings UV Mapping Tutorial]
* [http://springrts.com/phpbb/viewtopic.php?f=9&t=12354 Saving polygons in Wings3d Tutorial]
* [http://springrts.com/phpbb/viewtopic.php?t=10503 Runecrafter's 3DS Max UV Mapping Tutorial]

===Texture Tutorials===
* [http://springrts.com/phpbb/viewtopic.php?f=57&t=22392 DDS Textures: How To]
* [http://springrts.com/phpbb/viewtopic.php?t=10947 Greeble Tutorial 1]
* [http://springrts.com/phpbb/viewtopic.php?f=9&t=12356 Greeble Tutorial 2]

[[Category: Unit_development]]
[[Category:Game development]]