Spring - User contributions [en]

Authors

2019-10-26T20:03:28Z

Hokomoko: /* Special Thanks */

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

=Authors=

Spring (formerly TASpring) was originally written by the Swedish clan SY,
and later extended by a bunch of other people, some of whom are listed
here (in alphabetical order):

==Active==

* '''[[User:abma|abma]]''' ''Python AI Interface, installer, infrastructure, tester''
* '''[[User:hokomoko|hokomoko]]''' ''Serialisation, simulation, optimisations, bug-fixes''
* '''jK''' ''GFX, simulation, Lua, sound, OpenMP, OS related''
* '''Kloot''' ''GFX, simulation, Lua, bug-fixes''

==Retired==
* Auswaschbar (Karl-Robert Ernst)
* fnordia
* '''[[User:hoijui|hoijui]]''' ''AI, build-system, installer, headless, sound''
* imbaczek (Marek Baczynski)
* jcnossen
* SJ
* Tobi (Tobi Vollebregt) ''releases, buildbot, simulation, Lua''
* [[User:Tim_Blokdijk|tim blokdijk]]
* trepan
* victor
* xiphux
* zerver ''GFX, simulation, Lua, multithreaded''
* cleanrock ''GFX, bug-fixes''

==Special Thanks==
Additionally for significant contributions to the spring engine or the community, special gratitude goes to (in alphabetical order):

* Beherith
* betalord
* bibim (Yann Riou)
* BrainDamage
* colorblind (Teake Nutma)
* dansan (for hosting replays.springrts.com)
* det
* eriatarka
* FLOZi (Craig Lawrence)
* [https://github.com/gajop gajop (Gajo Petrovic)]
* hughperkins (Hugh Perkins)
* ILMTitan
* initram
* KDR_11k
* koshi
* Krogothe
* M2
* MadrMan
* Nathaniel Smith
* Nicolas Brodu
* rattle
* satirik
* semi
* smoth
* SpliFF
* tizbac (Tiziano Bacocco)
* quantum
* zenzike (Nicolas Wu)
* zizu
* zydox (for sharing A LOT of CPU power for running the validation test / buildslave)

=Notes=

NEVER send bug reports, help- and feature-requests directly to the
persons in this list, use the [http://springrts.com/mantis/ bugtracker] or the [http://springrts.com/phpbb/ forum] instead.
Of course you are free to write mails about donating.

For additions/corrections to the list, please post in the community forum.

[[Category:Engine Dev]]

Donations

2019-06-26T22:16:09Z

Hokomoko: /* Server costs */

Donations are handled by [[Authors#Active|Kloot]]

== Bitcoin ==
[[Image:Bitcoin_logo.png|50px|link=bitcoin:12WLzbiRjT52satsr8hT2WyYQpP9sWxSQB]]
[bitcoin:12WLzbiRjT52satsr8hT2WyYQpP9sWxSQB bitcoin:12WLzbiRjT52satsr8hT2WyYQpP9sWxSQB]
([https://springrts.com/phpbb/viewtopic.php?f=86&t=32878&p=564309#p564309 Source])

(sorry, no other options possible atm)

The Donation(s) try to cover the costs of our [https://springrts.com/wiki/Spring:Organization Organization] which indirectly help [[Authors|us]] develop the spring engine!

== Server costs==

currently [https://springrts.com/phpbb/viewtopic.php?f=1&t=32932&p=564906 60€ / year] [https://springrts.com/phpbb/viewtopic.php?f=38&t=32711 since 2014.11.05].

{| class="wikitable sortable"
|-
! Year !! Expense (EUR) !! Date !! Income (EUR)

|-
| 2014 || 10 || ||
|-
| 2015 || 60 || ||
|-
| 2016 || 60 || ||
|-
| 2017 || 60 || ||
|-
| 2018 || 60 || 2018.03.13 || [https://springrts.com/phpbb/viewtopic.php?p=585298#p585298 161]
|-
| 2019 || 60 || 2019.03.24 || [https://springrts.com/phpbb/viewtopic.php?f=64&t=39261 15]
|-
| || || 2019.04.01 || [https://springrts.com/phpbb/viewtopic.php?f=64&p=590470#p590469 200]
|-
| || || 2019.06.26 || [https://springrts.com/phpbb/viewtopic.php?p=591596#p591596 15]
|-
| '''Sum''' || '''310''' || '''Sum''' || '''391'''
|-
|}

[[Category:Spring]]

Donations

2019-03-24T21:30:05Z

Hokomoko: /* Server costs */

Donations are handled by [[Authors#Active|Kloot]]

== Bitcoin ==
[[Image:Bitcoin_logo.png|50px|link=bitcoin:12WLzbiRjT52satsr8hT2WyYQpP9sWxSQB]]
[bitcoin:12WLzbiRjT52satsr8hT2WyYQpP9sWxSQB bitcoin:12WLzbiRjT52satsr8hT2WyYQpP9sWxSQB]
([https://springrts.com/phpbb/viewtopic.php?f=86&t=32878&p=564309#p564309 Source])

(sorry, no other options possible atm)

The Donation(s) try to cover the costs of our [https://springrts.com/wiki/Spring:Organization Organization] which indirectly help [[Authors|us]] develop the spring engine!

== Server costs==

currently [https://springrts.com/phpbb/viewtopic.php?f=1&t=32932&p=564906 60€ / year] [https://springrts.com/phpbb/viewtopic.php?f=38&t=32711 since 2014.11.05].

{| class="wikitable sortable"
|-
! Year !! Expense (EUR) !! Date !! Income (EUR)

|-
| 2014 || 10 || ||
|-
| 2015 || 60 || ||
|-
| 2016 || 60 || ||
|-
| 2017 || 60 || ||
|-
| 2018 || 60 || 2018.03.13 || [https://springrts.com/phpbb/viewtopic.php?p=585298#p585298 161]
|-
| 2019 || 60 || 2019.03.24 || [https://springrts.com/phpbb/viewtopic.php?f=64&t=39261 15]
|-
| '''Sum''' || '''310''' || '''Sum''' || '''176'''
|-
|}

[[Category:Spring]]

Donations

2019-03-24T21:24:42Z

Hokomoko: /* Server costs */

Donations are handled by [[Authors#Active|Kloot]]

== Bitcoin ==
[[Image:Bitcoin_logo.png|50px|link=bitcoin:12WLzbiRjT52satsr8hT2WyYQpP9sWxSQB]]
[bitcoin:12WLzbiRjT52satsr8hT2WyYQpP9sWxSQB bitcoin:12WLzbiRjT52satsr8hT2WyYQpP9sWxSQB]
([https://springrts.com/phpbb/viewtopic.php?f=86&t=32878&p=564309#p564309 Source])

(sorry, no other options possible atm)

The Donation(s) try to cover the costs of our [https://springrts.com/wiki/Spring:Organization Organization] which indirectly help [[Authors|us]] develop the spring engine!

== Server costs==

currently [https://springrts.com/phpbb/viewtopic.php?f=1&t=32932&p=564906 60€ / year] [https://springrts.com/phpbb/viewtopic.php?f=38&t=32711 since 2014.11.05].

{| class="wikitable sortable"
|-
! Year !! Expense (EUR) !! Date !! Income (EUR)

|-
| 2014 || 10 || ||
|-
| 2015 || 60 || ||
|-
| 2016 || 60 || ||
|-
| 2017 || 60 || ||
|-
| 2018 || 60 || 2018.03.13 || [https://springrts.com/phpbb/viewtopic.php?p=585298#p585298 161]
|-
| 2019 || 60 || 2018.03.24 || [https://springrts.com/phpbb/viewtopic.php?f=64&t=39261 15]
|-
| '''Sum''' || '''310''' || '''Sum''' || '''176'''
|-
|}

[[Category:Spring]]

Authors

2019-03-19T18:53:02Z

Hokomoko:

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

=Authors=

Spring (formerly TASpring) was originally written by the Swedish clan SY,
and later extended by a bunch of other people, some of whom are listed
here (in alphabetical order):

==Active==

* '''[[User:abma|abma]]''' ''Python AI Interface, installer, infrastructure, tester''
* '''[[User:hokomoko|hokomoko]]''' ''Serialisation, simulation, optimisations, bug-fixes''
* '''jK''' ''GFX, simulation, Lua, sound, OpenMP, OS related''
* '''Kloot''' ''GFX, simulation, Lua, bug-fixes''

==Retired==
* Auswaschbar (Karl-Robert Ernst)
* fnordia
* '''[[User:hoijui|hoijui]]''' ''AI, build-system, installer, headless, sound''
* imbaczek (Marek Baczynski)
* jcnossen
* SJ
* Tobi (Tobi Vollebregt) ''releases, buildbot, simulation, Lua''
* [[User:Tim_Blokdijk|tim blokdijk]]
* trepan
* victor
* xiphux
* zerver ''GFX, simulation, Lua, multithreaded''
* cleanrock ''GFX, bug-fixes''

==Special Thanks==
Additionally for significant contributions to the spring engine or the community, special gratitude goes to (in alphabetical order):

* Beherith
* betalord
* bibim (Yann Riou)
* BrainDamage
* colorblind (Teake Nutma)
* dansan (for hosting replays.springrts.com)
* det
* eriatarka
* FLOZi (Craig Lawrence)
* [https://github.com/gajop gajop (Gajo Petrovic)]
* hughperkins (Hugh Perkins)
* ILMTitan
* initram
* KDR_11k
* koshi
* Krogothe
* M2
* MadrMan
* Nathaniel Smith
* Nicolas Brodu
* rattle
* satirik
* semi
* smoth
* SpliFF
* quantum
* zenzike (Nicolas Wu)
* zizu
* zydox (for sharing A LOT of CPU power for running the validation test / buildslave)

=Notes=

NEVER send bug reports, help- and feature-requests directly to the
persons in this list, use the [http://springrts.com/mantis/ bugtracker] or the [http://springrts.com/phpbb/ forum] instead.
Of course you are free to write mails about donating.

For additions/corrections to the list, please post in the community forum.

[[Category:Engine Dev]]

Donations

2019-01-03T12:32:23Z

Hokomoko:

Donations are handled by [[Authors#Active|Kloot]]

== Bitcoin ==
[[Image:Bitcoin_logo.png|50px|link=bitcoin:12WLzbiRjT52satsr8hT2WyYQpP9sWxSQB]]
[bitcoin:12WLzbiRjT52satsr8hT2WyYQpP9sWxSQB bitcoin:12WLzbiRjT52satsr8hT2WyYQpP9sWxSQB]
([https://springrts.com/phpbb/viewtopic.php?f=86&t=32878&p=564309#p564309 Source])

(sorry, no other options possible atm)

The Donation(s) try to cover the costs of our [https://springrts.com/wiki/Spring:Organization Organization] which indirectly help [[Authors|us]] develop the spring engine!

== Server costs==

currently [https://springrts.com/phpbb/viewtopic.php?f=1&t=32932&p=564906 60€ / year] [https://springrts.com/phpbb/viewtopic.php?f=38&t=32711 since 2014.11.05].

{| class="wikitable sortable"
|-
! Year !! Expense (EUR) !! Date !! Income (EUR)

|-
| 2014 || 10 || 2018.03.13 || [https://springrts.com/phpbb/viewtopic.php?p=585298#p585298 161]
|-
| 2015 || 60 || ||
|-
| 2016 || 60 || ||
|-
| 2017 || 60 || ||
|-
| 2018 || 60 || ||
|-
| 2019 || 60 || ||
|-
| '''Sum''' || '''310''' || '''Sum''' || '''161'''
|-
|}

[[Category:Spring]]

Games

2018-04-27T08:46:56Z

Hokomoko: equalise formatting

__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. 

You can download games automatically, using your lobby (see [[Read_Me_First|Read Me First]]). Some games also offer a stand-alone installer.

=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.''
{|
|-
| <h2>[https://zero-k.info/ Zero-K]</h2>
([https://github.com/ZeroK-RTS/Zero-K/blob/master/legal.txt GPL, PD])
|-
| [[Image:Zero-k_image.jpg|300px|link=https://zero-k.info/]]
| 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. [https://zero-k.info Download link]
|-
| <h2>[http://spring1944.net/ Spring: 1944]</h2>([https://github.com/spring1944/spring1944/blob/master/docs/License.txt CC-BY-NC])
|-
| [[Image:S44_tigers.jpg|300px|link=http://spring1944.net/]]
| valign="top" | Spring:1944 is a WWII themed game with eight fully functional armies (US, Germany, USSR, Britain, Japan, Italy, Hungary, Sweden), period-accurate units and strengths. Realism comes second only to creating a game that is fun and accessible to play.
|-
| | <h2>[https://www.evolutionrts.info Evolution RTS]</h2>([https://creativecommons.org/licenses/by-nc-nd/3.0/us/ CC-BY-SA])
|-
| [[Image:Evoimg.jpg|300px|link=https://www.evolutionrts.info]]
| 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.
|-
| <h2>[[Kernel Panic]]</h2>([[Kernel_Panic#License:|FOSS, with only 2 FOSS maps]])
|-
| [[Image:Kernel_Panic_3.4.jpg|300px|link=Kernel Panic]]
| 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.
|-
| <h2>[http://www.moddb.com/games/conflict-terra Conflict Terra]</h2>([http://code.google.com/p/conflictterra/source/browse/games/CT/License.txt FOSS])
|-
| [[Image:CT_Hojos.png|300px|link=http://www.moddb.com/games/conflict-terra]]
| 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.
|-
| <h2>[https://springfiles.com/spring/games/edge-1 On The Edge]</h2> (GPL, [https://creativecommons.org/licenses/by-nc-sa/3.0/us/ CC-BY-NC-SA])
|-
| [[Image:start3.jpg|300px|link=https://springfiles.com/spring/games/edge-1]]
| valign="top" | First Spring MOBA with unique pre-game hero setup. Under heavy development. How to setup working the game read on [http://springrts.com/phpbb/viewtopic.php?f=55&t=31476 On The Edge forum thread]
|-
| <h2>[http://www.metalfactions.pt Metal Factions]</h2>
([http://www.metalfactions.pt/about.html#license CC-BY-ND, with GPL/PD code])
|-
| [[Image:Mf_spring_wiki.jpg|300px|link=http://www.metalfactions.pt]]
| valign="top" | An evolving game that started as a TA mod and currently features four factions: AVEN, GEAR, CLAW and SPHERE. Commanders can morph to fit into different play styles and be easily revived. Economy scaling is more strictly tied to map control.
|-
| <h2>[http://www.indiedb.com/games/the-cursed The Cursed]</h2>
([https://creativecommons.org/licenses/by-nc-sa/4.0 CC-BY-NC-SA])
|-
| [[Image:cursed_logo.jpg|300px|link=http://www.indiedb.com/games/the-cursed]]
| 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.
|}

=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 include large GPL-friendly content collections.''

{|
|-
| <h2> [https://springrts.com/phpbb/viewforum.php?f=46 Star Wars: Imperial Winter] </h2>
|-
| [[Image:Imperial Winter assault.jpg|300px|link=https://springrts.com/phpbb/viewforum.php?f=46]]
| valign="top" | A Star Wars themed game set in the troubled post-Return of the Jedi era.
|-
| <h2> [https://springrts.com/phpbb/viewforum.php?f=69 Journeywar] </h2>
|-
| [[Image:JwLogo.jpg|300px|link=https://springrts.com/phpbb/viewtopic.php?f=69&t=23275&start=1180]]
| valign="top" | Journeywar is the final battle between Combine and Exobiotics. Join the fight and rediscover the HL- Universe from a new, strategic perspective. Download in Springlogbby as jw:test archive.
|}

=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.''

{|
|-
|<h2> [https://balancedannihilation.com Balanced Annihilation] </h2>
|-
| [[Image:BAScreenShot.jpg|300px|link=https://balancedannihilation.com]]
| 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.
Go to [https://balancedannihilation.com BA Oficial Website] for more info!
|-
| <h2> [https://springfiles.com/spring/games/tech-annihilation-8 Tech Annihilation] </h2>
|-
| [[Image:Tech_Annihilation.png|300px|link=https://springfiles.com/spring/games/tech-annihilation-8]]
| 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)
|-
|<h2>[http://nota.machys.net/downloads NOTA]</h2>
|-
| [[Image:notAgame02.jpg|300px|link=http://nota.machys.net/downloads]]
| 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.
|-
| <h2> [[XTA]] </h2>
|-
| [[Image:Screen508_s.jpg|300px|link=XTA]]
| 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! Otherwise a lobby such as [[SpringLobby]] will download everything for you when you join a game room.

Games can also be downloaded manually as .sdz/.sd7 files, for example ''BA750'''''.sd7''' or ''XTA'''''.sdz''', and placed into ''...\My Documents\My Games\Spring\Games\'' or ''...\Spring\games\'' folder (''~/.spring/games/'' on Linux/Unix/Mac). Read the advice on [[Read_Me_First|this page]] if your lobby does not find your games.
You may install multiple games in the same engine installation. The same goes for [[Maps]]. Place them into a folder called maps in the same folder where the games folder is.

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]]

Lua:Environments

2017-12-22T16:46:25Z

Hokomoko: /* Interfaces */

== Environments ==
Here is an exhaustive list of the different lua environments within Spring, roughly in execution order as a game is loaded.
=== LuaMenu ===
Introduced in 104.0, a stripped down environment that starts before the game is loaded and persists through reload.
=== LuaParser ===
Minimal environment used to parse and load definition files.
=== LuaIntro ===
Introduced in 95.0, to allow visual customisation of the loading process.
=== LuaRules (synced) ===
The main environment for synced game-controlling mechanics ("gadgets").
=== LuaRules (unsynced) ===
The main environment for unsynced game effects, rendering, UI etc. ("gadgets")
=== LuaGaia (synced) ===
As LuaRules (synced) but for maps.
=== LuaGaia (unsynced) ===
As LuaRules (unsynced) but for maps.
=== LuaUI ===
The main environment for toggleable UI elements and controls ("widgets").

== Interfaces ==
The following table demonstrates which interfaces are available to each environment.
{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em; border: 1px #aaa solid; border-collapse: collapse;"
|
! align="center" | LuaMenu
! align="center" | LuaIntro
! align="center" | LuaParser
! align="center" | LuaRules/Gaia (synced)
! align="center" | LuaRules/Gaia (unsynced)
! align="center" | LuaUI
|-
| align="left" | [[Lua_ConstGame]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_ConstEngine]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_ConstPlatform]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_UnitDefs]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_WeaponDefs]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_FeatureDefs]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +

|-
| align="left" | [[Lua_ConstCOB]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -

|-
| align="left" | [[Lua_CMDs]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +

|-
| align="left" | [[Lua_UnsyncedRead]]
| align="center" bgcolor="#888800" | +***
| align="center" bgcolor="#888800" | +***
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +

|-
| align="left" | [[Lua_UnsyncedCtrl]]
| align="center" bgcolor="#888800" | +***
| align="center" bgcolor="#888800" | +***
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_SyncedRead]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#888800" | +***
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#888800" | +**

|-
| align="left" | [[Lua_SyncedCtrl]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
|-
| align="left" | [[Lua_MoveCtrl]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
|-
| align="left" | [[Lua_PathFinder]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_OpenGL_Api]]
| align="center" bgcolor="#888800" | +***
| align="center" bgcolor="#888800" | +***
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_GLSL_Api]]
| align="center" bgcolor="#888800" | +***
| align="center" bgcolor="#888800" | +***
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_FBO_and_RBO]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_UnitRendering ]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
|-
| align="left" | [[Lua_Fonts]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_ConstGL]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_VFS]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#888800" | +*
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_Scream]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_BitOps]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_MathExtra]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_Socket]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
|}

{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em; border: 1px #aaa solid; border-collapse: collapse;"
|-
| align="center" | *
| align="left"| only VFS.ZIP_ONLY
|-
| align="center" | **
| align="left"| with special LOS handling and decoy unit handling
|-
| align="center" | ***
| align="left"| stripped down environment with certain functions removed
|}

[[Category:Lua]]

Category:Lua

2017-12-22T14:53:38Z

Hokomoko:

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < Lua Category

<center>'''Lua Interfaces'''</center>
<center>
{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em; border: 1px #aaa solid; border-collapse: collapse;"
|
! align="center" | LuaUI
! align="center" | LuaRules (unsynced)
! align="center" | LuaRules (synced)
! align="center" | LuaMenu
|-
| align="left" | [[Lua_ConstGame]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
|-
| align="left" | [[Lua_ConstEngine]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_ConstPlatform]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_UnitDefs]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
|-
| align="left" | [[Lua_WeaponDefs]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
|-
| align="left" | [[Lua_FeatureDefs]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -

|-
| align="left" | [[Lua_ConstCOB]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -

|-
| align="left" | [[Lua_CMDs]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -

|-
| align="left" | [[Lua_UnsyncedRead]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#888800" | +***
|-
| align="left" | [[Lua_UnsyncedCtrl]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#888800" | +***
|-
| align="left" | [[Lua_SyncedRead]]
| align="center" bgcolor="#888800" | +**
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
|-
| align="left" | [[Lua_SyncedCtrl]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
|-
| align="left" | [[Lua_MoveCtrl]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
|-
| align="left" | [[Lua_PathFinder]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
|-
| align="left" | [[Lua_OpenGL_Api]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#888800" | +***
|-
| align="left" | [[Lua_GLSL_Api]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#888800" | +***
|-
| align="left" | [[Lua_FBO_and_RBO]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#888800" | +***
|-
| align="left" | [[Lua_UnitRendering ]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
|-
| align="left" | [[Lua_Fonts]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_ConstGL]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_VFS]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#888800" | +*
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_Scream]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_BitOps]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
|-
| align="left" | [[Lua_MathExtra]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
|-
| align="left" | [[Lua_Socket]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | +
| align="center" bgcolor="#772222" | +
| align="center" bgcolor="#227722" | +
|}
</center>

<center>
{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em; border: 1px #aaa solid; border-collapse: collapse;"
|-
| align="center" | *
| align="left"| only VFS.ZIP_ONLY
|-
| align="center" | **
| align="left"| with special LOS handling and decoy unit handling
|-
| align="center" | ***
| align="left"| stripped down environment with certain functions removed
|}
</center>

[[Category:Development]]

Building Spring on Linux

2017-11-08T07:59:08Z

Hokomoko: /* Full list */

[[Engine_Development|Development]] < [[Building_spring|Building Spring]] < {{FULLPAGENAME}}

= Build From Source on Linux =
If you prefer to use your distributions package system (release versions only), refer to the Linux [[SetupGuide]].

If there is no package tailored for your distribution, you have to install from sources manually. Doing this for distributions where packages are available is not recommended.

'''Warning:''' 
'''Be careful when building from source.''' 
You might encounter sync errors in online play if:
* you are using an untested compiler (''gcc'' from the >=4.6 series should be safe)
* you use non-standard compiler settings (be careful about ''-march'')!


== Obtaining the Source ==
{{Obtaining_The_Source_Code}}

= Get Dependencies =

To compile, you will have to install some development packages Spring depends on. These vary from distro to distro and may also depend on your specific configuration.

If your distributions is not listed below, you should be able to figure out the correct package names from this.

== Full list ==
* Programs necessary to build
** ''cmake''
** ''7zip'' (aka ''p7zip'' or ''7z'')
** The usual build toolchain
*** ''gcc''
*** ''make''
* Libraries
** SDL2
** ''libdeviL'' (IL)
** OpenAL (openal-soft, older openal-0.0.8 does not work)
** OpenGL headers (mesa, GLEW, etc.)
** ''zlib''
** ''freetype'' (2)
** ''ogg'', ''vorbis'' and ''vorbisfile''
** ''curl''
* Optional (for AI Interfaces, Skirmish AIs and unit tests)
** ''python'' (2.5+)
** ''jdk'' (1.5+)
** ''boost'' (version 1.47 or later)
*** ''chrono''
*** ''filesystem''
*** ''threads''
*** ''system''
*** ''chrono''

== Debian ==

For Jessie (debian 8.0 stable) this should work:

<code><pre>
sudo apt-get install build-essential zlib1g-dev libfreetype6-dev cmake \
libsdl2-dev libopenal-dev libglew-dev zip libvorbis-dev libxcursor-dev \
libdevil-dev libboost-system1.55-dev libboost-thread1.55-dev \
libboost-regex1.55-dev libboost-serialization1.55-dev \
libboost-program-options1.55-dev libboost-chrono1.55-dev \
libunwind-dev libboost-filesystem1.55-dev \
libboost-signals1.55-dev libboost-test1.55-dev \
xsltproc libfontconfig1-dev libcurl4-openssl-dev
</pre></code>

=== Ubuntu ===
<code><pre>
# compiler and build tools
sudo apt-get install build-essential cmake cmake-gui git

# spring dependencies
sudo apt-get install libglew-dev libsdl2-dev libdevil-dev libopenal-dev \
libogg-dev libvorbis-dev libfreetype6-dev p7zip-full libxcursor-dev \
libboost-thread-dev libboost-regex-dev libboost-system-dev \
libboost-program-options-dev libboost-signals-dev \
libboost-chrono-dev libboost-filesystem-dev libunwind8-dev \
default-jdk libcurl4-gnutls-dev
</pre></code>

to speed up compiling/linking, you can install gold, an alternative linker and when you plan to develop / recompile often ccache :

<code><pre>sudo apt-get install binutils-gold ccache</pre></code>

to make ccache useful, the cache size needs to be increased by:

<code><pre>ccache -M 5G</pre></code>

to set it to 5GB.

== Gentoo ==
This has been tested to work with a clean install of gentoo 2008.0:

<code><pre>
emerge cmake \>=media-libs/freetype-2.0.0 \>=media-libs/libsdl-2
emerge media-libs/openal media-libs/glew dev-libs/boost
emerge app-arch/zip media-libs/libogg
USE="png jpg tiff opengl" emerge media-libs/devil
</pre></code>

Or better you install Spring via [http://springrts.com/wiki/Gentoo_install layman], it will install all dependencies.

== Fedora ==

On Fedora 12-21:

<code><pre>
sudo yum install gcc-c++ cmake boost-devel DevIL-devel freetype-devel libunwind-devel \
glew-devel libvorbis-devel libXcursor-devel openal-devel SDL2-devel p7zip
</pre></code>

On Fedora 8:

<code><pre>
yum install cmake boost-devel openal-devel SDL2-devel \
DevIL-devel glew-devel libvorbis-devel
</pre></code>

== Slackware ==

On Slackware 13, cmake, ogg & vorbis, boost, glew and SDL2 already come with the full regular install, both libs and headers. You can find helper scripts to easily compile and package DevIL, OpenAL and spring itself [http://slackbuilds.org/ here].

Try to use [http://idlemoor.github.io/slackrepo/ slackrepo], will search, update and install spring and dependences.

= Build And Install =

== Using CMake (2.6 or newer) ==
Configure and build:

<code><pre>
cmake .
make spring
</pre></code>

Install:

<code><pre>
make install-spring
</pre></code>

Default install paths are:

<code>/usr/local/bin/spring</code> Spring executable

<code>/usr/local/share/games/spring</code> read-only data

If you want <code>~/spring</code> prefix instead of <code>/usr/local</code>, configure like this:

<code><pre>
cmake -DCMAKE_INSTALL_PREFIX=~/spring .
</pre></code>
For further ways of customizing your build, have a look at the variables shown with:
<code><pre>
cmake -LH .
</pre></code>

For other targets see the output of <code>make help</code>.

= See Also: =
* [[Finalizing_linux_install]]
* [[Troubleshooting_linux]]

[[Category:Compiling]]
[[Category:Linux]]

Download Testing

2017-09-06T09:33:36Z

Hokomoko: /* Linux */

= Spring Engine Testing Release =

Current test version: {{EngineVersion:Testing}} ({{EngineVersion:Testing:ReleaseDate}})

== Get It ==

=== [[SpringLobby]] ===

Go to Tools->Download Archives, then enter

<code>
engine:spring {{EngineVersion:Testing}} {{EngineBranch:Testing}}
</code>

Click ok.

=== [[pr-downloader]] ===
easiest way is by using pr-downloader (which is included into spring)

<code>
pr-downloader --download-engine "{{EngineVersion:Testing}} {{EngineBranch:Testing}}"
</code>

=== Windows ===

{|
| style="padding-right:10px"| [[Image:Distributions-windows.png]]
|
<ul>
<li> [https://springrts.com/dl/buildbot/default/{{EngineBranch:Testing}}/{{EngineVersion:Testing}}/win32/spring_{{{EngineBranch:Testing}}}{{EngineVersion:Testing}}_win32.exe installer]
<li> [https://springrts.com/dl/buildbot/default/{{EngineBranch:Testing}}/{{EngineVersion:Testing}}/win32/spring_{{{EngineBranch:Testing}}}{{EngineVersion:Testing}}_win32-minimal-portable.7z portable] (Lobby not included)
<li> [https://springrts.com/dl/buildbot/default/{{EngineBranch:Testing}}/{{EngineVersion:Testing}}/win32/ whole build]
</ul>
|}

=== Linux ===

{|
| style="padding-right:10px"| [[Image:Tux-G2.png]]
|
<ol>
<li> '''get the source'''
<ol>
<li> creating the repo (first time only): 
<code>git clone git://github.com/spring/spring.git spring_src</code>
<li> update to latest sources: 
<code>cd spring_src && git fetch && git checkout {{EngineVersion:Testing}}</code>
</ol>
<li> '''build''' by following the [[Building_Spring_on_Linux|build from source]] guide, or in short: 
<code>cmake -G "Unix Makefiles" . && make spring && sudo make install-spring</code>
</ol>
|}

===static builds===
as alternative you can try the one of the linux static builds:

* [https://springrts.com/dl/buildbot/default/{{EngineBranch:Testing}}/{{EngineVersion:Testing}}/linux32/spring_%7b{{EngineBranch:Testing}}%7d{{EngineVersion:Testing}}_minimal-portable-linux32-static.7z static linux build (32 bit)]

* [https://springrts.com/dl/buildbot/default/{{EngineBranch:Testing}}/{{EngineVersion:Testing}}/linux64/spring_%7b{{EngineBranch:Testing}}%7d{{EngineVersion:Testing}}_minimal-portable-linux64-static.7z static linux build (64 bit)]

=== Mac OS X ===

{|
| style="padding-right:10px"| [[Image:Distributions-mac-2.png]]
|
[https://springrts.com/dl/buildbot/default/{{EngineBranch:Testing}}/{{EngineVersion:Testing}}/osx64/spring_%7b{{EngineBranch:Testing}}%7d{{EngineVersion:Testing}}_MacOSX-10.6-SnowLeopard.zip '''App Bundle'''] (tested on 10.6 Snow-Leopard only)

In case the above fails, check out [[Spring_on_MacOSX|alternative ways]].
|}

== Lobby ==

Make sure your lobby client is configured to use the correct spring binary & unitsync!
On Linux, this will usually be ''/usr/local/bin/spring'' & ''/usr/local/lib/libunitsync.so''.

Use one of the test lobby servers (recommended):
* ''lobby1.springlobby.info:8200''
* ''lobby2.springlobby.info:8200''

Or alternatively, configure your lobby so it does not insist using the release version of the engine:
* SpringLobby: set <code>DisableVersionCheck=1</code> in ''springlobby.conf''
* TASClient: press CTRL+SHIFT+F6 and enable "Ignore server version incompatibility"

== Bugs and issues ==

Report on [https://springrts.com/mantis/ Mantis].
Remember to upload [[infolog.txt]] if you crash!

== Changelog ==

For changes please look into the [https://github.com/spring/spring/blob/{{EngineVersion:Testing}}/doc/changelog.txt Change Log] or the [https://github.com/spring/spring/compare/{{EngineVersion:Stable}}...{{EngineVersion:Testing}} diff log] for details.

See the topmost for changes to the upcoming version.

[[Category: Development]]

Download Testing

2017-09-06T09:33:15Z

Hokomoko: /* Windows */

= Spring Engine Testing Release =

Current test version: {{EngineVersion:Testing}} ({{EngineVersion:Testing:ReleaseDate}})

== Get It ==

=== [[SpringLobby]] ===

Go to Tools->Download Archives, then enter

<code>
engine:spring {{EngineVersion:Testing}} {{EngineBranch:Testing}}
</code>

Click ok.

=== [[pr-downloader]] ===
easiest way is by using pr-downloader (which is included into spring)

<code>
pr-downloader --download-engine "{{EngineVersion:Testing}} {{EngineBranch:Testing}}"
</code>

=== Windows ===

{|
| style="padding-right:10px"| [[Image:Distributions-windows.png]]
|
<ul>
<li> [https://springrts.com/dl/buildbot/default/{{EngineBranch:Testing}}/{{EngineVersion:Testing}}/win32/spring_{{{EngineBranch:Testing}}}{{EngineVersion:Testing}}_win32.exe installer]
<li> [https://springrts.com/dl/buildbot/default/{{EngineBranch:Testing}}/{{EngineVersion:Testing}}/win32/spring_{{{EngineBranch:Testing}}}{{EngineVersion:Testing}}_win32-minimal-portable.7z portable] (Lobby not included)
<li> [https://springrts.com/dl/buildbot/default/{{EngineBranch:Testing}}/{{EngineVersion:Testing}}/win32/ whole build]
</ul>
|}

=== Linux ===

{|
| style="padding-right:10px"| [[Image:Tux-G2.pngâ€Ž]]
|
<ol>
<li> '''get the source'''
<ol>
<li> creating the repo (first time only): 
<code>git clone git://github.com/spring/spring.git spring_src</code>
<li> update to latest sources: 
<code>cd spring_src && git fetch && git checkout {{EngineVersion:Testing}}</code>
</ol>
<li> '''build''' by following the [[Building_Spring_on_Linux|build from source]] guide, or in short: 
<code>cmake -G "Unix Makefiles" . && make spring && sudo make install-spring</code>
</ol>
|}

===static builds===
as alternative you can try the one of the linux static builds:

* [https://springrts.com/dl/buildbot/default/{{EngineBranch:Testing}}/{{EngineVersion:Testing}}/linux32/spring_%7b{{EngineBranch:Testing}}%7d{{EngineVersion:Testing}}_minimal-portable-linux32-static.7z static linux build (32 bit)]

* [https://springrts.com/dl/buildbot/default/{{EngineBranch:Testing}}/{{EngineVersion:Testing}}/linux64/spring_%7b{{EngineBranch:Testing}}%7d{{EngineVersion:Testing}}_minimal-portable-linux64-static.7z static linux build (64 bit)]

=== Mac OS X ===

{|
| style="padding-right:10px"| [[Image:Distributions-mac-2.png]]
|
[https://springrts.com/dl/buildbot/default/{{EngineBranch:Testing}}/{{EngineVersion:Testing}}/osx64/spring_%7b{{EngineBranch:Testing}}%7d{{EngineVersion:Testing}}_MacOSX-10.6-SnowLeopard.zip '''App Bundle'''] (tested on 10.6 Snow-Leopard only)

In case the above fails, check out [[Spring_on_MacOSX|alternative ways]].
|}

== Lobby ==

Make sure your lobby client is configured to use the correct spring binary & unitsync!
On Linux, this will usually be ''/usr/local/bin/spring'' & ''/usr/local/lib/libunitsync.so''.

Use one of the test lobby servers (recommended):
* ''lobby1.springlobby.info:8200''
* ''lobby2.springlobby.info:8200''

Or alternatively, configure your lobby so it does not insist using the release version of the engine:
* SpringLobby: set <code>DisableVersionCheck=1</code> in ''springlobby.conf''
* TASClient: press CTRL+SHIFT+F6 and enable "Ignore server version incompatibility"

== Bugs and issues ==

Report on [https://springrts.com/mantis/ Mantis].
Remember to upload [[infolog.txt]] if you crash!

== Changelog ==

For changes please look into the [https://github.com/spring/spring/blob/{{EngineVersion:Testing}}/doc/changelog.txt Change Log] or the [https://github.com/spring/spring/compare/{{EngineVersion:Stable}}...{{EngineVersion:Testing}} diff log] for details.

See the topmost for changes to the upcoming version.

[[Category: Development]]

Template:EngineVersion:Testing:ReleaseDate

2017-09-02T13:35:24Z

Hokomoko:

02. September 2017

Template:EngineVersion:Testing

2017-09-02T13:33:29Z

Hokomoko:

103.0.1-1328-g882485f

Template:EngineVersion:Testing:ReleaseDate

2017-09-02T13:32:26Z

Hokomoko:

01. September 2017

Template:EngineVersion:Testing:ReleaseDate

2017-08-01T14:39:16Z

Hokomoko:

01. August 2017

Template:EngineVersion:Testing

2017-08-01T14:39:05Z

Hokomoko:

103.0.1-1244-g70d14a0

Template:EngineVersion:Testing

2017-07-17T20:01:51Z

Hokomoko:

103.0.1-1222-g37dc534

Template:EngineVersion:Testing:ReleaseDate

2017-07-17T20:01:33Z

Hokomoko:

17. July 2017

Licenses Forking Mutators

2016-12-07T00:44:05Z

Hokomoko: /* FAQ: */

<big> --- DRAFT --- </big>

=Guidelines on licensing, forks and mutators within the Spring community=

==Licensing for content devs, in brief:==

We think a package of content for Spring (e.g. sdz, sd7) is not a "single work" derived of the engine in the terms of the GPL. A package of content may consist of multiple independent works, each of which may be covered by a different license.

We generally view '''code''' that is necessarily read/executed by the Spring engine, as linking to the engine. As a result, since the engine is licensed under GPL, we think that such code requires a GPL compatible license. This typically applies to widgets, gadgets, scripts, shaders, CEGs, unit defs, etc.

All other content that you create, such as '''artwork''', can be licensed however you wish. That said, we encourage you to use open source copyleft licenses, and make your content free for anyone to use and modify.

Details can be found in https://springrts.com/phpbb/viewtopic.php?f=1&t=17847. Please remember that on our forums we require that discussion of specific projects licensing is "in very good faith and a highly positive and productive manner" ;)

==Forks and mutators:==

As a general rule, Spring encourages content sharing whilst also discouraging unwanted imitation of existing content.

A '''mutator''' (of map or mod type) built on game X should make it explicitly clear in its name that it will modify/augment content from X.

A '''fork''' of game X should have a clearly distinct name and versioning scheme, and a clearly visible difference to the content of the most recent release of X.

In both cases:
* The license(s) of game X should be respected;
* Names, version numbers and other branding should not attempt to imitate the original game X;
* Promotion (including promotion by players) should not take place within the infrastructure of game X;
* A non-technical description of the changes/mutations made from (a named version of) game X should be made publicly available on Springs forums - in a release post, change-log, or similar;

Exceptions to these conditions may occur only if the developers of game X have given permission for them.

When these conditions are satisfied, mutators and forks of existing games may be used on Springs server. Where possible, the mutator/fork can initialize data (ingame times, TrueSkill scores, etc) within Springs infrastructure from a copy of similar data that Spring already holds related to game X.

In practice, within Spring:
* If you develop a game and feel that a mutator/fork of your project is not following these guidelines, contact Springs moderators.
* If you want to fork/mutate a game, we encourage you to contact its developers first.

=FAQ:=

(Q) "What about '''procedurally generated art''', or artwork such as a story-line that happens to be stored within a lua file?" 
(A) This is a grey area, and in some cases there may not be a clear answer. A lua gadget that generates art is code and should be GPL compatible, but a file containing a lua table with one sentence of a story on each line could reasonably be viewed as artwork.

(Q) "I want to make a '''commercial game'''. How can I protect my rights to license it?" 
(A) You may use a restrictive license for your artwork, although we'd prefer that you didn't! At the very least, if you stop making/selling your game we hope that you would re-license all your content freely.

(Q) "I want to develop/distribute a '''game agnostic utility or library''', with game X included as an example, but I need to make modifications to X for this. Can I?" 
(A) Yes. As long as you respect the license of X and stick to modifying the technical stuff needed for your own work, we won't consider it to be affected by these guidelines.

(Q) "I store some '''data related to game X''' on my own servers, do I have to share this data to a fork of game X?" 
(A) No, it's your data. But if you'd like your data/project to be viewed as "within Spring's infrastructure" for the purposes of these guidelines, then let us know.

(Q) "I want to make a fork or mutator of X but the maintainers of X refuse to endorse it. Can I still do it?" 
(A) Yes, as long as the guidelines above are followed by both yourself and your players.

(Q) "Should I make '''a fork or a mutator'''?" 
(A) In general, mutators should be used by projects that, as part of their own development, usually incorporate changes found in new releases of their parent game - such as an added-on "King of the Hill" or "Tower Defence" mode. Forks should be used by projects that tend not to incorporate innovations found in new releases of their parent game.

(Q) What is a "clearly visible difference to the content of the most recent release of X"? 
(A) A difference that, if it was present in a typical game of the most recent release of X, would be noticed and reacted to by most (and ideally, all) of the players.

(Q) "I want my game to share infrastructure from another game (hosts, content distribution, forum, etc). Can it?" 
(A) Not unless the developers of the other game want it to.

(Q) "I am a developer, can I impose additional conditions on how people use my content within Spring?" 
(A) Yes, as long as they don't conflict with the guidelines above. We would prefer you to do it via your license.

(Q) "What will happen if I, or other users of my content, break these guidelines?" 
(A) Typically, we may withhold use of Spring's infrastructure (such as the forum, lobby server, rapid, SpringFiles, botflags, etc) and may remove offending content. In serious cases we may issue warnings and bans.

(Q) "What about games containing OTA content? What about different points of view of GPL, packages and linking?" 
(A) See https://springrts.com/phpbb/viewtopic.php?f=1&t=17847 and https://springrts.com/wiki/Felony#11.

(Q) "Who takes decisions to cover '''grey areas and disputes'''? Who updates/modifies these guidelines?" 
(A) Spring's moderators and administrators. Note that these are our community guidelines; this is NOT a legal document.

Licenses Forking Mutators

2016-12-07T00:40:49Z

Hokomoko: /* FAQ: */

<big> --- DRAFT --- </big>

=Guidelines on licensing, forks and mutators within the Spring community=

==Licensing for content devs, in brief:==

We think a package of content for Spring (e.g. sdz, sd7) is not a "single work" derived of the engine in the terms of the GPL. A package of content may consist of multiple independent works, each of which may be covered by a different license.

We generally view '''code''' that is necessarily read/executed by the Spring engine, as linking to the engine. As a result, since the engine is licensed under GPL, we think that such code requires a GPL compatible license. This typically applies to widgets, gadgets, scripts, shaders, CEGs, unit defs, etc.

All other content that you create, such as '''artwork''', can be licensed however you wish. That said, we encourage you to use open source copyleft licenses, and make your content free for anyone to use and modify.

Details can be found in https://springrts.com/phpbb/viewtopic.php?f=1&t=17847. Please remember that on our forums we require that discussion of specific projects licensing is "in very good faith and a highly positive and productive manner" ;)

==Forks and mutators:==

As a general rule, Spring encourages content sharing whilst also discouraging unwanted imitation of existing content.

A '''mutator''' (of map or mod type) built on game X should make it explicitly clear in its name that it will modify/augment content from X.

A '''fork''' of game X should have a clearly distinct name and versioning scheme, and a clearly visible difference to the content of the most recent release of X.

In both cases:
* The license(s) of game X should be respected;
* Names, version numbers and other branding should not attempt to imitate the original game X;
* Promotion (including promotion by players) should not take place within the infrastructure of game X;
* A non-technical description of the changes/mutations made from (a named version of) game X should be made publicly available on Springs forums - in a release post, change-log, or similar;

Exceptions to these conditions may occur only if the developers of game X have given permission for them.

When these conditions are satisfied, mutators and forks of existing games may be used on Springs server. Where possible, the mutator/fork can initialize data (ingame times, TrueSkill scores, etc) within Springs infrastructure from a copy of similar data that Spring already holds related to game X.

In practice, within Spring:
* If you develop a game and feel that a mutator/fork of your project is not following these guidelines, contact Springs moderators.
* If you want to fork/mutate a game, we encourage you to contact its developers first.

=FAQ:=

(Q) "What about '''procedurally generated art''', or artwork such as a story-line that happens to be stored within a lua file?" 
(A) This is a grey area, and in some cases there may not be a clear answer. A lua gadget that generates art is code and should be GPL compatible, but a file containing a lua table with one sentence of a story on each line could reasonably be viewed as artwork.

(Q) "I want to make a '''commercial game'''. How can I protect my rights to license it?" 
(A) You may use a restrictive license for your artwork, although we'd prefer that you didn't! At the very least, if you stop making/selling your game we hope that you would re-license all your content freely.

(Q) "I want to develop/distribute a '''game agnostic utility or library''', with game X included as an example, but I need to make modifications to X for this. Can I?" 
(A) Yes. As long as you respect the license of X and stick to modifying the technical stuff needed for your own work, we won't consider it to be affected by these guidelines.

(Q) "I store some '''data related to game X''' on my own servers, do I have to share this data to a fork of game X?" 
(A) No, it's your data. But if you'd like your data/project to be viewed as "within Spring's infrastructure" for the purposes of these guidelines, then let us know.

(Q) "I want to make a fork or mutator of X but the maintainers of X refuse to endorse it. Can I still do it?" 
(A) Yes, as long as the guidelines above are followed by both yourself and your players.

(Q) "Should I make '''a fork or a mutator'''?" 
(A) In general, mutators should be used by projects that, as part of their own development, usually incorporate changes found in new releases of their parent game - such as an added-on "King of the Hill" or "Tower Defence" mode. Forks should be used by projects that tend not to incorporate innovations found in new releases of their parent game.

(Q) What is a "clearly visible difference to the content of the most recent release of X"? 
(A) A difference that, if it was present in a typical game of the most recent release of X, would be noticed and reacted to by most (and ideally, all) of the players.

(Q) "I want my game to share infrastructure from another game (hosts, content distribution, forum, etc). Can it?" 
(A) Not unless the developers of the other game want it to.

(Q) "I am a developer, can I impose additional conditions on how people use my content within Spring?" 
(A) Yes, as long as they don't conflict with the guidelines above. We would prefer you to do it via your license.

(Q) "What will happen if I, or other users of my content, break these guidelines?" 
(A) Typically, we may withhold use of Spring's infrastructure (such as the forum, lobby server, rapid, SpringFiles, botflags, etc) and may remove offending content. In serious cases we may issue warnings and bans.

(Q) "What about games containing OTA content? What about different points of view of GPL, packages and linking?" 
(A) See https://springrts.com/phpbb/viewtopic.php?f=1&t=17847 and https://springrts.com/wiki/Felony#11.

(Q) "Who takes decisions to cover '''grey areas and disputes'''? Who updates/modifies these guidelines?" 
(A) Springs moderators and administrators. Note that these are our community guidelines; this is NOT a legal document.

Licenses Forking Mutators

2016-12-07T00:40:15Z

Hokomoko: /* FAQ: */

<big> --- DRAFT --- </big>

=Guidelines on licensing, forks and mutators within the Spring community=

==Licensing for content devs, in brief:==

We think a package of content for Spring (e.g. sdz, sd7) is not a "single work" derived of the engine in the terms of the GPL. A package of content may consist of multiple independent works, each of which may be covered by a different license.

We generally view '''code''' that is necessarily read/executed by the Spring engine, as linking to the engine. As a result, since the engine is licensed under GPL, we think that such code requires a GPL compatible license. This typically applies to widgets, gadgets, scripts, shaders, CEGs, unit defs, etc.

All other content that you create, such as '''artwork''', can be licensed however you wish. That said, we encourage you to use open source copyleft licenses, and make your content free for anyone to use and modify.

Details can be found in https://springrts.com/phpbb/viewtopic.php?f=1&t=17847. Please remember that on our forums we require that discussion of specific projects licensing is "in very good faith and a highly positive and productive manner" ;)

==Forks and mutators:==

As a general rule, Spring encourages content sharing whilst also discouraging unwanted imitation of existing content.

A '''mutator''' (of map or mod type) built on game X should make it explicitly clear in its name that it will modify/augment content from X.

A '''fork''' of game X should have a clearly distinct name and versioning scheme, and a clearly visible difference to the content of the most recent release of X.

In both cases:
* The license(s) of game X should be respected;
* Names, version numbers and other branding should not attempt to imitate the original game X;
* Promotion (including promotion by players) should not take place within the infrastructure of game X;
* A non-technical description of the changes/mutations made from (a named version of) game X should be made publicly available on Springs forums - in a release post, change-log, or similar;

Exceptions to these conditions may occur only if the developers of game X have given permission for them.

When these conditions are satisfied, mutators and forks of existing games may be used on Springs server. Where possible, the mutator/fork can initialize data (ingame times, TrueSkill scores, etc) within Springs infrastructure from a copy of similar data that Spring already holds related to game X.

In practice, within Spring:
* If you develop a game and feel that a mutator/fork of your project is not following these guidelines, contact Springs moderators.
* If you want to fork/mutate a game, we encourage you to contact its developers first.

=FAQ:=

(Q) "What about '''procedurally generated art''', or artwork such as a story-line that happens to be stored within a lua file?" 
(A) This is a grey area, and in some cases there may not be a clear answer. A lua gadget that generates art is code and should be GPL compatible, but a file containing a lua table with one sentence of a story on each line could reasonably be viewed as artwork.

(Q) "I want to make a '''commercial game'''. How can I protect my rights to license it?" 
(A) You may use a restrictive license for your artwork, although we'd prefer that you didn't! At the very least, if you stop making/selling your game we hope that you would re-license all your content freely.

(Q) "I want to develop/distribute a '''game agnostic utility or library''', with game X included as an example, but I need to make modifications to X for this. Can I?" 
(A) Yes. As long as you respect the license of X and stick to modifying the technical stuff needed for your own work, we won't consider it to be affected by these guidelines.

(Q) "I store some '''data related to game X''' on my own servers, do I have to share this data to a fork of game X?" 
(A) No, it's your data. But if you'd like your data/project to be viewed as "within Springs infrastructure", for the purposes of these guidelines, then let us know.

(Q) "I want to make a fork or mutator of X but the maintainers of X refuse to endorse it. Can I still do it?" 
(A) Yes, as long as the guidelines above are followed by both yourself and your players.

(Q) "Should I make '''a fork or a mutator'''?" 
(A) In general, mutators should be used by projects that, as part of their own development, usually incorporate changes found in new releases of their parent game - such as an added-on "King of the Hill" or "Tower Defence" mode. Forks should be used by projects that tend not to incorporate innovations found in new releases of their parent game.

(Q) What is a "clearly visible difference to the content of the most recent release of X"? 
(A) A difference that, if it was present in a typical game of the most recent release of X, would be noticed and reacted to by most (and ideally, all) of the players.

(Q) "I want my game to share infrastructure from another game (hosts, content distribution, forum, etc). Can it?" 
(A) Not unless the developers of the other game want it to.

(Q) "I am a developer, can I impose additional conditions on how people use my content within Spring?" 
(A) Yes, as long as they don't conflict with the guidelines above. We would prefer you to do it via your license.

(Q) "What will happen if I, or other users of my content, break these guidelines?" 
(A) Typically, we may withhold use of Spring's infrastructure (such as the forum, lobby server, rapid, SpringFiles, botflags, etc) and may remove offending content. In serious cases we may issue warnings and bans.

(Q) "What about games containing OTA content? What about different points of view of GPL, packages and linking?" 
(A) See https://springrts.com/phpbb/viewtopic.php?f=1&t=17847 and https://springrts.com/wiki/Felony#11.

(Q) "Who takes decisions to cover '''grey areas and disputes'''? Who updates/modifies these guidelines?" 
(A) Springs moderators and administrators. Note that these are our community guidelines; this is NOT a legal document.

Lobby Comparison

2016-07-10T08:29:33Z

Hokomoko: Undo revision 30137 by Hokomoko (talk)

WARNING: this is WIP and not correct for now!

(features which every lobby has aren't listed)

{| class="wikitable"
| unique Features
| [[SpringLobby]]
| [[Lobby_Development#Zero-K_Lobby|Zero-K Lobby]]
| [[Lobby_Development#Weblobby|Weblobby]]
|-
| [[Uberserver|official spring lobby server]]
| âœ”
|
| âœ”
|-
| Zero-K lobby server
|
| âœ”
| âœ”
|-
| relayhost
| âœ”
|
|
|-
| singleplayer (vs ai, offline)
| âœ”
|
|
|-
| offline watch replays
| âœ”
|
|
|-
| missions (online)
|
| âœ”
| âœ”
|-
| host game
| âœ”
|
|
|-
|}

Features which all lobbies have:

* automatic download of map/game/engine
* online multiplayer
* online singleplayer

[[Category:Lobby]]

Lobby Comparison

2016-07-10T07:51:00Z

Hokomoko:

WARNING: this is WIP and not correct for now!

(features which every lobby has aren't listed)

{| class="wikitable"
| unique Features
| [[SpringLobby]]
| [[Lobby_Development#Zero-K_Lobby|Zero-K Lobby]]
| [[Lobby_Development#Weblobby|Weblobby]]
|-
| [[Uberserver|official spring lobby server]]
| âœ”
|
| âœ”
|-
| Zero-K lobby server
|
| âœ”
| âœ”
|-
| relayhost
| âœ”
|
|
|-
| singleplayer (vs ai, offline)
| âœ”
|
|
|-
| offline watch replays
| âœ”
|
|
|-
| missions (online)
|
| âœ”
| âœ”
|-
| host game
| âœ”
| âœ”
| âœ”
|-
|}

Features which all lobbies have:

* automatic download of map/game/engine
* online multiplayer
* online singleplayer

[[Category:Lobby]]

Animation-CobConstants

2016-05-31T11:40:23Z

Hokomoko: /* Custom Variables */

==Source==

This has a list of all COB SET/GET constants: {{sourcelink|file=rts/Sim/Units/Scripts/CobDefines.h}}

You'll want to include a file with these constants in your script.

==SET/GET==

===Use===
Use GET [tag] to get a value. Some GETs refer to functions; in this case, use GET [tag](arg1, arg2, arg3, arg4).
Use SET [tag] to [value] to change a value.

===Tags===
There's a lot of GET/SET tags; I'll cover some of the more useful but less intuitive ones.

*ACTIVATION: Whether the unit is on (true) or off (false).
*ARMORED: When true, any damage dealt to the unit will be multiplied by its damageModifier.
*PRINT: You can use GET PRINT to send up to 4 arguments to chat. Useful for debugging. Example: '''get PRINT(1, 5,9,10);''' statement will print the following into infolog: '''Value 1: 1, 2: 5, 3: 9, 4: 10'''
*VETERAN_LEVEL: The unit's experience times 100. Note that you can SET this via script, although the unit won't gain any extra health from doing so.

=== Custom Variables ===
{{removed|101.0}}

Higher GET/SET numbers are reserved for custom variables. These are very useful for Lua integration. Setting these variables is much (perhaps 100x) faster than calling functions across Lua and COB; the disadvantages are the limited number of variables and the fact that the other side is not immediately notified of a change in the variable.

*Unit variables: The 8 numbers starting at 1024 correspond to per-unit variables. To get at these from Lua, use Spring.[Get|Set]COBUnitVar.
*Team variables: The 64 numbers starting at 2048 correspond to per-team variables. To get at these from Lua, use Spring.[Get|Set]COBTeamVar.
*Ally variables: The 64 numbers starting at 3072 correspond to per-team variables. To get at these from Lua, use Spring.[Get|Set]COBAllyTeamVar.
*Global variables: The 4096 numbers starting at 4096 correspond to global variables. To get at these from Lua, use Spring.[Get|Set]COBGlobalVar.

==emit-sfx==

emit-sfx [sfxtype] from [piece];

The least significant byte of sfxtype is treated as an unsigned integer; the remaining bits are a bitmask. The bitmask indicates what ''type'' of sfx to emit, while the number indicates ''which'' sfx of that type to emit. The bits are as follows:

*256: Point-based fx. Used for white smoke (1), black smoke (2), and bubbles (3).
*1024: Unit sfx. Use with the unit's sfxtypes.explosionGenerators. The first one is 0, the second one is 1, etc.
*2048: Fire weapon. Fires a weapon from the piece (no aiming involved). Again, the first weapon is 0, the second weapon is 1, etc.
*4096: Explode weapon. Detonates a weapon at the piece. Again, the first weapon is 0, the second weapon is 1, etc.

If the piece has no geometry, then the sfx is emitted in the +z direction from the origin of the piece.

If the piece has 1 vertex, the emit dir is the vector from the origin to the the position of the first vertex the emit position is the origin of the piece.

If there is more than one vertex in the piece, then the emit vector is the vector pointing from v[0] to v[1], and the emit position is v[0].

==explode==

Causes the piece to explode and possibly go flying. This actually gives the appearance of making a copy of the piece (henceforth referred to as "debris") so if you're using it outside of Killed() you may want to hide the piece in question.

explode [piece] type [exptype];

exptype is a bitmask. The bits are as follows:

*SHATTER: Explodes the debris into tiny triangles. Looks like confetti.
*EXPLODE_ON_HIT: Debris will explode on impact, causing about 40 damage.
*FALL: Debris is affected by gravity.
*SMOKE
*FIRE
*BITMAPONLY: No debris, just an explosion graphic.
*NOCEGTRAIL
*NOHEATCLOUD: No explosion before the piece flies off.
*BITMAP[1...5]: Not used in Spring, may overlap with Spring specific bits.

[[Category:Animation]]

Animation-CobConstants

2016-05-31T11:40:15Z

Hokomoko: /* Custom Variables */

==Source==

This has a list of all COB SET/GET constants: {{sourcelink|file=rts/Sim/Units/Scripts/CobDefines.h}}

You'll want to include a file with these constants in your script.

==SET/GET==

===Use===
Use GET [tag] to get a value. Some GETs refer to functions; in this case, use GET [tag](arg1, arg2, arg3, arg4).
Use SET [tag] to [value] to change a value.

===Tags===
There's a lot of GET/SET tags; I'll cover some of the more useful but less intuitive ones.

*ACTIVATION: Whether the unit is on (true) or off (false).
*ARMORED: When true, any damage dealt to the unit will be multiplied by its damageModifier.
*PRINT: You can use GET PRINT to send up to 4 arguments to chat. Useful for debugging. Example: '''get PRINT(1, 5,9,10);''' statement will print the following into infolog: '''Value 1: 1, 2: 5, 3: 9, 4: 10'''
*VETERAN_LEVEL: The unit's experience times 100. Note that you can SET this via script, although the unit won't gain any extra health from doing so.

=== Custom Variables ===
{{removed|101.0}}
Higher GET/SET numbers are reserved for custom variables. These are very useful for Lua integration. Setting these variables is much (perhaps 100x) faster than calling functions across Lua and COB; the disadvantages are the limited number of variables and the fact that the other side is not immediately notified of a change in the variable.

*Unit variables: The 8 numbers starting at 1024 correspond to per-unit variables. To get at these from Lua, use Spring.[Get|Set]COBUnitVar.
*Team variables: The 64 numbers starting at 2048 correspond to per-team variables. To get at these from Lua, use Spring.[Get|Set]COBTeamVar.
*Ally variables: The 64 numbers starting at 3072 correspond to per-team variables. To get at these from Lua, use Spring.[Get|Set]COBAllyTeamVar.
*Global variables: The 4096 numbers starting at 4096 correspond to global variables. To get at these from Lua, use Spring.[Get|Set]COBGlobalVar.

==emit-sfx==

emit-sfx [sfxtype] from [piece];

The least significant byte of sfxtype is treated as an unsigned integer; the remaining bits are a bitmask. The bitmask indicates what ''type'' of sfx to emit, while the number indicates ''which'' sfx of that type to emit. The bits are as follows:

*256: Point-based fx. Used for white smoke (1), black smoke (2), and bubbles (3).
*1024: Unit sfx. Use with the unit's sfxtypes.explosionGenerators. The first one is 0, the second one is 1, etc.
*2048: Fire weapon. Fires a weapon from the piece (no aiming involved). Again, the first weapon is 0, the second weapon is 1, etc.
*4096: Explode weapon. Detonates a weapon at the piece. Again, the first weapon is 0, the second weapon is 1, etc.

If the piece has no geometry, then the sfx is emitted in the +z direction from the origin of the piece.

If the piece has 1 vertex, the emit dir is the vector from the origin to the the position of the first vertex the emit position is the origin of the piece.

If there is more than one vertex in the piece, then the emit vector is the vector pointing from v[0] to v[1], and the emit position is v[0].

==explode==

Causes the piece to explode and possibly go flying. This actually gives the appearance of making a copy of the piece (henceforth referred to as "debris") so if you're using it outside of Killed() you may want to hide the piece in question.

explode [piece] type [exptype];

exptype is a bitmask. The bits are as follows:

*SHATTER: Explodes the debris into tiny triangles. Looks like confetti.
*EXPLODE_ON_HIT: Debris will explode on impact, causing about 40 damage.
*FALL: Debris is affected by gravity.
*SMOKE
*FIRE
*BITMAPONLY: No debris, just an explosion graphic.
*NOCEGTRAIL
*NOHEATCLOUD: No explosion before the piece flies off.
*BITMAP[1...5]: Not used in Spring, may overlap with Spring specific bits.

[[Category:Animation]]

Template:EngineVersion:Testing

2016-05-16T09:16:26Z

Hokomoko:

101.0.1-367-g9ba9e97

Template:EngineVersion:Testing:ReleaseDate

2016-05-16T09:16:18Z

Hokomoko:

16. May 2016

Template:EngineVersion:Testing:ReleaseDate

2016-05-14T12:33:54Z

Hokomoko:

14. May 2016

Template:EngineVersion:Testing

2016-05-14T12:33:53Z

Hokomoko:

101.0.1-353-gb82bb12

Template:EngineVersion:Testing:ReleaseDate

2016-05-03T20:50:17Z

Hokomoko:

03. May 2016

Template:EngineVersion:Testing

2016-05-03T20:50:12Z

Hokomoko:

101.0.1-323-gdc57279

User:Hokomoko

2016-04-14T19:57:13Z

Hokomoko:

I make spring go faster, fix bugs, inadvertently cause new bugs and then hunt those down and fix them as well.

[https://springrts.com/phpbb/viewtopic.php?f=22&t=33702 This thread describes what I'm doing with the engine]

[https://github.com/spring1944/spring1944 Check out Spring:1944!]

Also check these two widgets:
# [https://gist.github.com/ashdnazg/3d4de5bae33e4f54cd40 Chili interface for drawing/sending tactical arrows on the map using markers. Contains Bezier curve handling code.]
# [https://gist.github.com/ashdnazg/3d4de5bae33e4f54cd40 Chili interface for taking control of an ally's units (assuming they have the widget as well).]

Building Spring on Windows

2016-03-24T08:49:28Z

Hokomoko: These vars aren't needed,

[[Engine_Development|Development]] < [[Building_spring|Building Spring]] < {{FULLPAGENAME}}
{{#css:
code * {margin:inherit;}
}}

If you only want to produce your own Spring game and not contribute to the core engine, compilation is not necessary. Check out [[Gamedev:Main]].

Warning: Compiling Spring on Windows often causes problems, it is heavily recommended to use [[Building_Spring_on_Linux|Linux]] for developing the Spring RTS Engine if possible.

Some reasons for this:
* Of the active developers nobody uses windows for developing. So they might not be able to help as effectively as on Linux.
* Setting up a build environment takes a lot more time on windows
* Compiling is often slower on windows
* Compiling on windows is poorly tested (which possibly leads to some random / unknown / weird errors)

That said, if you do wish to use Windows, the best place to get real-time help is the #sy lobby channel, or #sy on [[IRC]].

=Compiling with MinGW=

== Requirements ==
Install [http://www.cmake.org/ CMake] and [http://msysgit.github.io/ msysGit] and MinGW-w64:

When installing msysGit you should select the option to "Run Git from the Windows Command Prompt":

[[File:Msysgit6.png|400px]]

This is in order to automatically add Git to PATH making it easy for CMake to find.

== Installing MinGW-w64 ==

Download and run the "Mingw-builds project - native toolchains using trunk" installer from [http://mingw-w64.sourceforge.net/download.php MinGW-w64].

Select the following options:

[[File:InstallingMinGW-w64.png|400px]]

* '''Version:''' Any version above 4.8.x should work, 4.9.x+ may not have been tested as thoroughly.
* '''Architecture:''' i686
* '''Threads:''' posix
* '''Exception:''' sjlj This is the only setting which needs to be changed from the default
* '''Build Revision:''' The latest one

== Adding to PATH ==

Once installed, you should add the MinGW directory to your PATH variable so that Cmake can find the relevant binaries.

* Go to System properties (either via Control Panel\System and Security\System or by right clicking 'Computer' on the desktop), then click 'Advanced System Settings'.
* Click the 'Environment Variables' button at the bottom.
* Find Path in the 'System Variables' scrollbox, add an extra <code>;</code> to the end and then copy-paste in the MinGW directory (e.g. default is <code>C:\Program Files (x86)\mingw-w64\i686-4.9.1-posix-sjlj-rt_v3-rev0\mingw32\bin</code>).
* Alternative instructions with images are easy to find online, for example [http://geekswithblogs.net/renso/archive/2009/10/21/how-to-set-the-windows-path-in-windows-7.aspx here].

= Get the Source Code =

* use git's bash (you find it in the right click context menu when clicking the folder), <code>cd</code> into your spring source dir

<code><pre>
git clone --recursive git://github.com/spring/spring.git -b develop
cd spring
git clone https://github.com/spring/mingwlibs
</pre></code>

* update it from time to time with: <code>git pull --rebase</code>

* Make sure you install the package in the checkout directory, so the path is: /spring/mingwlibs. If done right, it will look like:
** */spring/
** */spring/...
** */spring/mingwlibs
** */spring/rts

* Note: if you install the package somewhere else (preferably outside of the source tree), and pass its location with the ''MINGDIR'' option to CMake in the configure step (see further down, in the quick instructions).

== configure using CMake ==

* run the ''cmake-gui'' and select a source and a build directory
* press '''Configure''' and follow the instructions
* press '''Generate'''
* open a console (''cmd.exe''), ''cd'' into your '''build''' directory
* ''optional:'' for multi-threaded compilation, the ''mingw32-make'' part may differ on your system: <code>''<pre>set MAKE_COMMAND=mingw32-make -j2</pre>''</code> (use -j4 for 4 threads)
* compile with: <code>''<pre>mingw32-make install-spring</pre>''</code>
* compile just the engine (spring.exe) with: <code>''<pre>mingw32-make engine-legacy</pre>''</code>

===Generating the AI Sources/Wrappers===

you can either build the wrapper:

<code>make Cpp-AIWrapper</code>

or generate all sources, in case you don't need the binary:

<code>make generateSources</code>

===Possible Problems===
* If you get undefined reference to `_Unwind_Resume' linking errors, deinstall ''whole'' MinGW and reinstall it with ''sjlj''.

* When you installed an old version of MinGW/TDM and forgot to deinstall it correctly, <code>gcc.exe</code> & <code>g++.exe</code> will be named <code>gcc-dw2.exe</code>/<code>g++-dw2.exe</code>. CMake will then fail to find the correct one, first try to deinstall anything mingw related and reinstall everything. If that didn't helped just rename the files. If even that doesn't help open cmake-gui and click the advanced button and set the paths to the correct files yourself (<code>CMAKE_C_COMPILER</code> & <code>CMAKE_CXX_COMPILER</code>).

=== Notes ===

You can still use Visual Studio 2012 as described below to edit the code. This is very useful because it allows excellent code navigation, and it highlights syntax errors and trivial mistakes before compiling.

For debugging mingw builds, you can aquire a windows build of gdb from http://www.equation.com/servlet/equation.cmd?fa=gdb

To start debugging, copy ''gdb.exe'' to your build output directory, and launch it with ''gdb spring.exe''. You can supply command line arguments to ''spring.exe'' with ''gdb --args spring.exe myreplayfile.sdf''

=Compiling with Visual Studio (not officially supported!)=
Currently Visual Studio lacks some c++ features it doesn't compile spring!

==General Visual Studio Notes==
When developing using Visual Studio keep in mind:
*It's experimental and not proved to compile or run!
*Your VS build won't sync with GCC builds in multiplayer mode
*AIs built with Visual Studio will work with the mingw32 release builds thanks to the C AI Interface, however this interface may change when newer releases are made
*Running any non-LUA AI on VS built Spring will crash it

===2012 (v11)===

Install [http://www.microsoft.com/visualstudio/eng/downloads#d-express-windows-desktop Visual Studio 2012 Express for Windows Desktop], [http://www.microsoft.com/en-us/download/confirmation.aspx?id=35515 Visual C++ Compiler November 2012 CTP], [http://www.cmake.org/ cmake], [http://www.7-zip.org 7-zip] and [http://msysgit.github.io/ msysgit].

From the Startmenu run "VS2012 x86 Native Tools Command Prompt" and type:

<code><pre>
set PATH=%PATH%;%PROGRAMFILES%\git\bin;%PROGRAMFILES%\cmake 2.8\bin\
git clone --recursive git://github.com/spring/spring.git -b develop
cd spring
git clone git://github.com/spring/vclibs11.git vclibs
cmake -G "Visual Studio 11" .
</pre></code>

Now start visual studio & open Spring.sln. Select "engine-legacy" as default project, as AIs and ofter stuff are known to fail to compile on visual studio.

In the Project Properties, make sure to [http://stackoverflow.com/questions/13238408/variadic-template-in-vs-2012-visual-c-november-2012-ctp select the Microsoft Visual C++ Compiler Nov 2012 CTP].

Note: Visual Studio 2012 Express for Windows Desktop is for free, but requires a registration after 30 days (to get a free license).

[[Category:Compiling]]

Template:EngineVersion:Testing:ReleaseDate

2016-03-12T21:33:25Z

Hokomoko:

12. March 2016

Template:EngineVersion:Testing

2016-03-12T21:33:15Z

Hokomoko:

101.0.1-136-g54d97ff

Lua:Callins

2016-02-26T02:03:14Z

Hokomoko: /* Lua Callins */

= Lua Callins =
This page is future looking to unified widget/gadget (aka "addon") handler, which may yet be some way off, c.f. the [https://github.com/spring/spring/blob/ebb704e008f6ea645947d07be1cfcc272af0428f/doc/changelog.txt#L71 changelog].

For now, to use these addons in a widget, replace addon with widget and, for a gadget, replace addon with gadget. For example,
<code><pre>
function widget:UnitCreated(unitID, unitDefID, unitTeam, builderID)
...
end
</pre></code>

Some functions may differ between (synced) gadget and widgets; those are in the [[#Synced_-_Unsynced_Shared]] section. Essentially the reason is that all information should be available to synced (game logic controlling) gadgets, but restricted to unsynced gadget/widget (e.g. information about an enemy unit only detected via radar and not yet in LOS). In such cases the full (synced) param list is documented.

== Common ==
{{LuaCallin
|name = Initialize
|params =
|return = none
|description = Called when the addon is (re)loaded.
}}

{{LuaCallin
|name = Shutdown
|params =
|return = none
|description = Called when the addon or the game is shutdown.
}}

== Unsynced Only ==

{{LuaCallin
|name = DefaultCommand
|params = type, id
|return = number cmdID
|description = Used to set the default command when a unit is selected. First parameter is the type of the object pointed at (either "unit or "feature") and the second is its unitID or featureID respectively.
}}

{{LuaCallin
|name = CommandNotify
|params = cmdID, cmdParams, cmdOptions
|return = bool removeCmd
|description = Called when a command is issued. Returning <code>true</code> deletes the command and does not send it through the network.
}}

{{LuaCallin
|name = CommandsChanged
|params = None
|return = ?
|description = Called when the command descriptions changed, e.g. when selecting or deselecting a unit.
}}

{{LuaCallin
|name = WorldTooltip
|params = ttType, data1, data2, data3
|return = string newTooltip
|description = The parameters can be <code>"unit"</code>, <code>unitID</code>; <code>"feature"</code>, <code>featureID</code>; <code>"ground"</code>, <code>posX</code>, <code>posY</code>, <code>posZ</code> or <code>"selection"</code>.
}}

{{LuaCallin
|name = UnsyncedHeightMapUpdate
|params = ???
|return = none
|description = Called when the unsynced copy of the height-map is altered.
}}

{{LuaCallin
|name = GameProgress
|params = serverFrameNum
|return = none
|description = Called every 60 frames, calculating delta between GameFrame and GameProgress. Can give an ETA about catching up with simulation for mid-game join players.
}}

{{LuaCallin
|name = GameSetup
|params = state, ready, playerStates
|return = bool success, bool newReady
|description = ???
}}

{{LuaCallin
|name = SunChanged
|params = ???
|return = none
|description = ???
}}

{{LuaCallin
|name = AddConsoleLine
|params = msg, priority
|return = none
|description = Called when text is entered into the console (e.g. Spring.Echo).
}}

{{LuaCallin
|name = RecvSkirmishAIMessage
|params = aiTeam, dataStr
|return = ???
|description = ???
}}

{{LuaCallin
|name = RecvFromSynced
|params = ...
|return = none
|description = Receives data sent via [[Lua_System#Synced|SendToUnsynced]] callout.
}}

{{LuaCallin
|name = Save
|params = zip
|return = none
|description = Called when a chat command '/save' or '/savegame' is received. The single argument is a userdatum representing the savegame zip file. See [[Lua_SaveLoad#Save_.28_zip_.29_-.3E_nil|Lua_SaveLoad]].
}}

{{LuaCallin
|name = LoadProgress
|params = message, replaceLastLine
|return = none
|description = Only available to LuaIntro.
}}

{{LuaCallin
|name = GroupChanged
|params = groupID
|return = none
|description = Called when a unit is added to or removed from a control group. Currently implemented for widgets only.
}}

{{LuaCallin
|name = ConfigureLayout
|params = ???
|return = ???
|description = ???
}}

=== Input ===
{{LuaCallin
|name = IsAbove
|params = x, y
|return = bool isAbove
|description = Called every Update. Must return <code>true</code> for <code>Mouse*</code> events and <code>GetToolTip</code> to be called.
}}

{{LuaCallin
|name = GetTooltip
|params = x, y
|return = string tooltip
|description = Called when <code>IsAbove</code> returns true.
}}

{{LuaCallin
|name = KeyPress
|params = key, mods, isRepeat
|return = bool becomeOwner
|description = Called repeatedly when a key is pressed down. If you want an action to occur only once check for <code>isRepeat == false</code>. The <code>mods</code> parameter is a table, with keys <code>alt</code>, <code>ctrl</code>, <code>meta</code> and <code>shift</code> each having a boolean value. Return <code>true</code> if you don't want other callins or the engine to also receive this keypress.
}}

{{LuaCallin
|name = KeyRelease
|params = key
|return = bool
|description = Called when the key is released.
}}

{{LuaCallin
|name = TextInput
|params = utf8char
|return = none
|description = Called whenever a key press results in text input. Introduced in 97.0.
}}

{{LuaCallin
|name = JoystickEvent
|params = ???
|return = none
|description = ???
}}

{{LuaCallin
|name = MousePress
|params = x, y, button
|return = bool becomeMouseOwner
|description = Called when a mouse button is pressed. The <code>button</code> parameter supports up to 7 buttons. Must return <code>true</code> for <code>MouseRelease</code> and other functions to be called.
}}

{{LuaCallin
|name = MouseRelease
|params = x, y, button
|return = bool becomeMouseOwner
|description = Called when a mouse button is released. Please note that in order to have Spring call <code>MouseRelease</code>, you need to have a <code>MousePress</code> call-in in the same addon that returns <code>true</code>.
}}

{{LuaCallin
|name = MouseWheel
|params = up, value
|return = none
|description = Called when the mouse wheel is moved. The parameters indicate the direction and amount of travel.
}}

{{LuaCallin
|name = MouseMove
|params = x, y, dx, dy, button
|return = none
|description = Called when the mouse is moved. The <code>dx</code> and <code>dy</code> parameters indicate the distance travelled, whereas the first two indicate the final position.
}}

=== Players ===
{{LuaCallin
|name = PlayerChanged
|params = playerID
|return = none
|description = Called whenever a player's status changes e.g. becoming a spectator.
}}

{{LuaCallin
|name = PlayerAdded
|params = playerID
|return = none
|description = Called whenever a new player joins the game.
}}

{{LuaCallin
|name = PlayerRemoved
|params = playerID, reason
|return = none
|description = Called whenever a player is removed from the game.
}}

=== Drawing ===

{{LuaCallin
|name = ViewResize
|params = viewSizeX, viewSizeY
|return = none
|description = Called whenever the window is resized.
}}

{{LuaCallin
|name = Update
|params = dt
|return = none
|description = Called for every draw frame. The parameter is the time since the last update. Perform calculations in here and only drawing in Draw* callins.}}

Inside the Draw* functions, you can use the [[Lua_OpenGL_Api | Lua OpenGL Api]] to draw graphics.

{{LuaCallin
|name = DrawGenesis
|params =
|return = none
|description = Doesn't render to screen! Use this callin to update textures, shaders, etc.
}}

{{LuaCallin
|name = DrawWorldPreUnit
|params =
|return = none
|description = Spring draws units, features, some water types, cloaked units, and the sun.
}}

{{LuaCallin
|name = DrawWorld
|params =
|return = none
|description = Spring draws command queues, 'map stuff', and map marks.
}}

{{LuaCallin
|name = DrawWorldShadow
|params =
|return = none
|description = ???
}}

{{LuaCallin
|name = DrawWorldReflection
|params =
|return = none
|description = ???
}}

{{LuaCallin
|name = DrawWorldRefraction
|params =
|return = none
|description = ???
}}

{{LuaCallin
|name = DrawScreen
|params =
|return = none
|description = ???
}}

{{LuaCallin
|name = DrawScreenEffects
|params = vsx, vsy
|return = none
|description = Where <code>vsx</code>, <code>vsy</code> are screen coordinates.
}}

{{LuaCallin
|name = DrawLoadScreen
|params =
|return = none
|description = {{new|95.0}} Only available to LuaIntro, draws custom load screens.
}}

{{LuaCallin
|name = DrawInMinimap
|params = sx, sy
|return = none
|description = Where <code>sx</code>, <code>sy</code> are values relative to the minimap's position and scale.
}}

{{LuaCallin
|name = DrawInMinimapBackground
|params = sx, sy
|return = none
|description = Where <code>sx</code>, <code>sy</code> are values relative to the minimap's position and scale.
}}

=== Custom Object Rendering ===
For the following calls <code>drawMode</code> can be one of the following, <code>notDrawing = 0</code>, <code>normalDraw = 1</code>, <code>shadowDraw = 2</code>, <code>reflectionDraw = 3</code>, <code>refractionDraw = 4</code>.

{{LuaCallin
|name = DrawUnit
|params = unitID, drawMode
|return = bool suppressEngineDraw
|description = For custom rendering of units, [[Lua_UnitRendering#Lua.27s_DrawXYZ-Callin|enabled here]].
}}

{{LuaCallin
|name = DrawFeature
|params = unitID, drawMode
|return = bool suppressEngineDraw
|description = For custom rendering of features, [[Lua_UnitRendering#Lua.27s_DrawXYZ-Callin|enabled here]].
}}

{{LuaCallin
|name = DrawShield
|params = unitID, weaponID, drawMode
|return = bool suppressEngineDraw
|description = For custom rendering of [[Gamedev:WeaponDefs#Shield_(WeaponType)|shields]].
}}

{{LuaCallin
|name = DrawProjectile
|params = projectileID, drawMode
|return = bool suppressEngineDraw
|description = For custom rendering of weapon (& other) projectiles.
}}

== Synced - Unsynced Shared ==

{{LuaCallin
|name = GotChatMsg
|params = msg, player
|return = none
|description = Called when a player issues a UI command e.g. types <code>/foo</code> or <code>/luarules foo</code>.
}}

=== Game ===

{{LuaCallin
|name = GameID
|params = gameID
|return = none
|description = Called once to deliver the gameID.
}}

{{LuaCallin
|name = GamePaused
|params =
|return = none
|description = Called when the game is paused.
}}

{{LuaCallin
|name = GameOver
|params = winningAllyTeams
|return = none
|description = The parameter is a list of winning allyTeams, if empty the game result was undecided (like when dropping from an host).
}}

{{LuaCallin
|name = GameFrame
|params = frame
|return = none
|description = Called for every game simulation frame (30 per second).
}}

{{LuaCallin
|name = GamePreload
|params =
|return = none
|description = Called before the 0 gameframe.
}}

{{LuaCallin
|name = GameStart
|params =
|return = none
|description = Called upon the start of the game.
}}

=== Teams ===
{{LuaCallin
|name = TeamChanged
|params = teamID
|return = none
|description = ???
}}

{{LuaCallin
|name = TeamDied
|params = teamID
|return = none
|description = Called when a team dies (see [[Lua_SyncedCtrl#Game_End|Spring.KillTeam]]).
}}

=== Units ===
{{LuaCallin
|name = UnitCreated
|params = unitID, unitDefID, unitTeam, builderID
|return = none
|description = Called at the moment the unit is created.
}}

{{LuaCallin
|name = UnitFinished
|params = unitID, unitDefID, unitTeam
|return = none
|description = Called at the moment the unit is completed.
}}

{{LuaCallin
|name = UnitFromFactory
|params = unitID, unitDefID, unitTeam, factID, factDefID, userOrders
|return = none
|description = Called when a factory finishes construction of a unit.
}}

{{LuaCallin
|name = UnitGiven
|params = unitID, unitDefID, newTeam, oldTeam
|return = none
|description = Called when a unit is transferred between teams.
}}

{{LuaCallin
|name = UnitTaken
|params = unitID, unitDefID, oldTeam, newTeam
|return = none
|description = Called when a unit is transferred between teams.
}}

{{LuaCallin
|name = UnitDamaged
|params = unitID, unitDefID, unitTeam, damage, paralyzer, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam
|return = none
|description = Called when a unit is damaged (after <code>UnitPreDamaged</code>).
}}

{{LuaCallin
|name = UnitDestroyed
|params = unitID, unitDefID, unitTeam, attackerID, attackerDefID, attackerTeam
|return = none
|description = Called when a unit is destroyed.
}}

{{LuaCallin
|name = UnitStunned
|params = unitID, unitDefID, unitTeam, stunned
|return = none
|description = Called when a unit changes its stun status. {{new|99.0}}
}}

{{LuaCallin
|name = UnitUnitCollision
|params = colliderID, collideeID
|return = none
|description = Called when two units collide. Both units must be registered with [[Lua_System#Synced|Script.SetWatchUnit]].
}}

{{LuaCallin
|name = UnitFeatureCollision
|params = colliderID, collideeID
|return = none
|description = Called when a unit collides with a feature. The unit must be registered with [[Lua_System#Synced|Script.SetWatchUnit]] and the feature registered with [[Lua_System#Synced|Script.SetWatchFeature]].
}}

{{LuaCallin
|name = UnitCommand
|params = unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOpts, cmdTag
|return = none
|description = Called after when a unit accepts a command, after <code>AllowCommand</code> returns <code>true</code>.
}}

{{LuaCallin
|name = UnitCmdDone
|params = unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOpts, cmdTag
|return = none
|description = Called when a unit completes a command.
}}

{{LuaCallin
|name = UnitLoaded
|params = unitID, unitDefID, unitTeam, transportID, transportTeam
|return = none
|description = Called when a unit is loaded by a transport.
}}

{{LuaCallin
|name = UnitUnloaded
|params = unitID, unitDefID, unitTeam, transportID, transportTeam
|return = none
|description = Called when a unit is unloaded by a transport.
}}

{{LuaCallin
|name = UnitExperience
|params = unitID, unitDefID, unitTeam, experience, oldExperience
|return = none
|description = Called when a unit gains experience greater or equal to the minimum limit set by calling [[Lua_SyncedCtrl#Other|Spring.SetExperienceGrade]].
}}

{{LuaCallin
|name = UnitIdle
|params = unitID, unitDefID, unitTeam
|return = none
|description = Called when a unit is idle (empty command queue).
}}

{{LuaCallin
|name = UnitCloaked
|params = unitID, unitDefID, unitTeam
|return = none
|description = Called when a unit cloaks.
}}

{{LuaCallin
|name = UnitDecloaked
|params = unitID, unitDefID, unitTeam
|return = none
|description = Called when a unit decloaks.
}}

{{LuaCallin
|name = UnitMoved
|params = ???
|return = none
|description = ??? Not implemented in base handler
}}

{{LuaCallin
|name = UnitMoveFailed
|params = ???
|return = none
|description = ??? Not implemented in base handler
}}

{{LuaCallin
|name = StockpileChanged
|params = unitID, unitDefID, unitTeam, weaponNum, oldCount, newCount
|return = none
|description = Called when a units stockpile of weapons increases or decreases. See {{xtaglink|Gamedev:WeaponDefs|stockpile}}.
}}

{{LuaCallin
|name = UnitEnteredLos
|params = unitID, unitTeam, allyTeam, unitDefID
|return = none
|description = Called when a unit enters LOS of an allyteam.
}}

{{LuaCallin
|name = UnitLeftLos
|params = unitID, unitTeam, allyTeam, unitDefID
|return = none
|description = Called when a unit leaves LOS of an allyteam.
}}

{{LuaCallin
|name = UnitEnteredRadar
|params = unitID, unitTeam, allyTeam, unitDefID
|return = none
|description = Called when a unit enters radar of an allyteam.
}}

{{LuaCallin
|name = UnitLeftRadar
|params = unitID, unitTeam, allyTeam, unitDefID
|return = none
|description = Called when a unit leaves radar of an allyteam.
}}

{{LuaCallin
|name = UnitEnteredAir
|params = ???
|return = none
|description = ??? Not implemented by base handler
}}

{{LuaCallin
|name = UnitLeftAir
|params = ???
|return = none
|description = ??? Not implemented by base handler
}}

{{LuaCallin
|name = UnitEnteredWater
|params = ???
|return = none
|description = ??? Not implemented by base handler
}}

{{LuaCallin
|name = UnitLeftWater
|params = ???
|return = none
|description = ??? Not implemented by base handler
}}

{{LuaCallin
|name = UnitSeismicPing
|params = x, y, z, strength, allyTeam, unitID, unitDefID
|return = none
|description = Called when a unit emits a seismic ping. See {{xtaglink|Gamedev:UnitDefs|seismicSignature}}.
}}

=== Features ===
{{LuaCallin
|name = FeatureCreated
|params = featureID, allyTeamID
|return = none
|description = Called when a feature is created.
}}

{{LuaCallin
|name = FeatureDamaged
|params = featureID, featureDefID, featureTeam, damage, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam
|return = none
|description = Called when a feature is damaged.
}}

{{LuaCallin
|name = FeatureDestroyed
|params = featureID, allyTeamID
|return = none
|description = Called when a feature is destroyed.
}}

{{LuaCallin
|name = FeatureMoved
|params = ???
|return = none
|description = ???
}}

=== Projectiles ===
The following Callins are only called for weaponDefIDs registered via [[Lua_System#Synced|Script.SetWatchWeapon]].

{{LuaCallin
|name = ProjectileCreated
|params = proID, proOwnerID, weaponDefID
|return = none
|description = Called when the projectile is created.
}}

{{LuaCallin
|name = ProjectileDestroyed
|params = proID
|return = none
|description = Called when the projectile is destroyed.
}}

== Synced Only ==
{{LuaCallin
|name = CommandFallback
|params = unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag
|return = bool used, bool finished
|description = Called when the unit reaches an unknown command in its queue (i.e. one not handled by the engine). If no addon returns <code>used</code> as <code>true</code> the command is dropped, if an addon returns <code>true, true</code> the command is removed because it's done, with <code>true, false</code> it's kept in the queue and <code>CommandFallback</code> gets called again on the next slowupdate.
}}

{{LuaCallin
|name = AllowCommand
|params = unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag, synced
|return = bool allow
|description = Called when the command is given, before the unit's queue is altered. The return value is whether it should be let into the queue. The queue remains untouched when a command is blocked, whether it would be queued or replace the queue.
}}

{{LuaCallin
|name = AllowUnitCreation
|params = unitDefID, builderID, builderTeam, x, y, z, facing
|return = bool allow
|description = Called just before unit is created, the boolean return value determines whether or not the creation is permitted.
}}

{{LuaCallin
|name = AllowUnitTransfer
|params = unitID, unitDefID, oldTeam, newTeam, capture
|return = bool allow
|description = Called just before a unit is transferred to a different team, the boolean return value determines whether or not the transfer is permitted.
}}

{{LuaCallin
|name = AllowUnitBuildStep
|params = builderID, builderTeam, unitID, unitDefID, part
|return = bool allow
|description = Called just before a unit progresses its build percentage, the boolean return value determines whether or not the build makes progress.
}}

{{LuaCallin
|name = AllowFeatureCreation
|params = featureDefID, teamID, x, y, z
|return = bool allow
|description = Called just before feature is created, the boolean return value determines whether or not the creation is permitted.
}}

{{LuaCallin
|name = AllowFeatureBuildStep
|params = builderID, builderTeam, featureID, featureDefID, part
|return = bool allow
|description = Called just before a feature progresses its build percentage, the boolean return value determines whether or not the progress change is permitted.
}}

{{LuaCallin
|name = AllowResourceLevel
|params = teamID, res, level
|return = bool allow
|description = Called when a team sets the sharing level of a resource, the boolean return value determines whether or not the sharing level is permitted.
}}

{{LuaCallin
|name = AllowResourceTransfer
|params = oldTeamID, newTeamID, res, amount
|return = bool allow
|description = Called just before resources are transferred between players, the boolean return value determines whether or not the transfer is permitted.
}}

{{LuaCallin
|name = AllowStartPosition
|params = clampedX, clampedY, clampedZ, playerID, readyState, rawX, rawY, rawZ
|return = bool allow
|description = <code>clamped</code> are the coordinates clamped into start-boxes, <code>raw</code> is where player tried to place their marker. The <code>readyState</code> can be any one of
* <code>0</code> - player picked a position,
* <code>1</code> - player clicked ready,
* <code>2</code> - player pressed ready OR the game was force-started (player did not click ready, but is now forcibly readied) or
* <code>3</code> - the player failed to load.
* {{new|95.0}} the default 'failed to choose' start-position is the north-west point of their startbox, or <code>(0,0,0)</code> if they do not have a startbox.
}}

{{LuaCallin
|name = AllowDirectUnitControl
|params = unitID, unitDefID, unitTeam, playerID
|return = bool allow
|description = Determines if this unit can be controlled directly in FPS view.
}}

{{LuaCallin
|name = AllowWeaponTargetCheck
|params = attackerID, attackerWeaponNum, attackerWeaponDefID
|return = bool allowCheck, bool ignoreCheck
|description = Determines if this weapon can automatically generate targets itself. See also {{xtaglink|Gamedev:WeaponDefs|commandFire}} weaponDef tag. The <code>ignoreCheck</code> return value was added in 99.0 to allow ignoring the callin i.e. running normal engine check for this weapon.
}}

{{LuaCallin
|name = AllowWeaponTarget
|params = attackerID, targetID, attackerWeaponNum, attackerWeaponDefID, defPriority
|return = bool allowed, number newPriority
|description = Controls blocking of a specific target from being considered during a weapon's periodic auto-targeting sweep. The second return value is the new priority for this target (if you don't want to change it, return defPriority). Lower priority targets are targeted first.
}}

{{LuaCallin
|name = AllowWeaponInterceptTarget
|params = interceptorUnitID, interceptorWeaponID, targetProjectileID
|return = bool allowed
|description = Controls blocking of a specific intercept target from being considered during an {{xtaglink|Gamedev:WeaponDefs|interceptor}} weapon's periodic auto-targeting sweep. Only called for weaponDefIDs registered via [[Lua_System#Synced|Script.SetWatchWeapon]].
}}

{{LuaCallin
|name = AllowBuilderHoldFire
|params = unitID, unitDefID, action
|return = bool actionAllowed
|description = {{new|98.0}} {{Sourcelinkhash|5a82d750b89e72024bb0bb62cf05ea257737e0ac}} Called when a construction unit wants to "use his nano beams". <code>action</code> is one of following:
* <code>-1</code> Build
* <code>CMD.REPAIR</code> Repair
* <code>CMD.RECLAIM</code> Reclaim
* <code>CMD.RESTORE</code> Restore
* <code>CMD.RESURRECT</code> Resurrect
* <code>CMD.CAPTURE</code> Capture
}}

{{LuaCallin
|name = Explosion
|params = weaponDefID, px, py, pz, AttackerID
|return = bool noGfx
|description = Called when an explosion occurs. If it returns <code>true</code> then no graphical effects are drawn by the engine for this explosion.
}}

{{LuaCallin
|name = TerraformComplete
|params = unitID, unitDefID, unitTeam, buildUnitID, buildUnitDefID, buildUnitTeam
|return = bool stop
|description = Called when pre-building terrain levelling terraforms are completed (c.f. {{xtaglink|Gamedev:UnitDefs|levelGround}}). If the return value is <code>true</code> the current build order is terminated.
}}

{{LuaCallin
|name = MoveCtrlNotify
|params = unitID, unitDefID, unitTeam, data
|return = bool moveCtrlComplete
|description = Enable both [[Lua_MoveCtrl#Options|Spring.MoveCtrl.SetCollideStop]] and [[Lua_MoveCtrl#Options|Spring.MoveCtrl.SetTrackGround]] to enable this call-in, data was supposed to indicate the type of notification but currently never has a value other than <code>1</code> ("unit hit the ground"). The return value determines whether or not the unit should remain script-controlled (<code>false</code>) or return to engine controlled movement (<code>true</code>).
}}

{{LuaCallin
|name = RecvLuaMsg
|params = msg, playerID
|return = none
|description = Receives messages from unsynced sent via [[Lua_UnsyncedCtrl#SendLuaMessage|Spring.SendLuaRulesMsg]].
}}

{{LuaCallin
|name = Load
|params = zip
|return = none
|description = Called after <code>GamePreload</code> and before <code>GameStart</code>. See [[Lua_SaveLoad#Load_.28_zip_.29_-.3E_nil|Lua_SaveLoad]].
}}

=== Damage Controllers ===
For the following callins, in addition to being a regular weapon, <code>weaponDefID</code> may be one of the following:
* <code>-1</code> - debris collision, also default of [[Lua_SyncedCtrl#Unit_Control|Spring.AddUnitDamage]]
* <code>-2</code> - ground collision
* <code>-3</code> - object collision
* <code>-4</code> - fire damage
* <code>-5</code> - water damage
* <code>-6</code> - kill damage
* <code>-7</code> - crush damage

{{LuaCallin
|name = UnitPreDamaged
|params = unitID, unitDefID, unitTeam, damage, paralyzer, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam
|return = number newDamage, number impulseMult
|description = Called before damage is applied to the unit, allows fine control over how much damage and [http://en.wikipedia.org/wiki/Impulse_(physics) impulse] is applied.
}}

{{LuaCallin
|name = ShieldPreDamaged
|params = proID, proOwnerID, shieldEmitterWeaponNum, shieldCarrierUnitID, bounceProjectile
|return = bool handleCollision
|description = Called before any engine shield-vs-projectile logic executes. If the return value is <code>true</code> the gadget handles the collision event and the engine does not remove the projectile.
}}

{{LuaCallin
|name = FeaturePreDamaged
|params = featureID, featureDefID, featureTeam, damage, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam
|return = number newDamage, number impulseMult
|description = Called before damage is applied to the feature, allows fine control over how much damage and [http://en.wikipedia.org/wiki/Impulse_(physics) impulse] is applied.
}}

[[Category: Lua]]

Template:EngineVersion:Testing:ReleaseDate

2016-02-15T18:51:31Z

Hokomoko:

15. February 2016

Template:EngineVersion:Testing

2016-02-15T18:51:28Z

Hokomoko:

100.0.1-1162-gefb8d7e

Template:EngineVersion:Testing:ReleaseDate

2016-02-11T20:01:10Z

Hokomoko:

11. February 2016

Template:EngineVersion:Testing

2016-02-11T20:00:59Z

Hokomoko:

100.0.1-1148-ge827fef

Template:EngineVersion:Testing:ReleaseDate

2016-02-08T12:59:24Z

Hokomoko:

08. February 2016

Template:EngineVersion:Testing

2016-02-08T12:58:20Z

Hokomoko:

100.0.1-1115-g0de46cd

Authors

2016-02-07T23:34:35Z

Hokomoko: /* Active */

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

=Authors=

Spring (formerly TASpring) was originally written by the Swedish clan SY,
and later extended by a bunch of other people, some of whom are listed
here (in alphabetical order):

==Active==

* '''[[User:abma|abma]]''' ''Python AI Interface, installer, infrastructure, tester''
* '''cleanrock''' GFX, bug-fixes
* '''[[User:hokomoko|hokomoko]]''' Misc, optimisations, bug-fixes
* '''jK''' ''GFX, simulation, Lua, sound, OpenMP, OS related''
* '''Kloot''' ''GFX, simulation, Lua, bug-fixes''

==Retired==
* Auswaschbar (Karl-Robert Ernst)
* fnordia
* '''[[User:hoijui|hoijui]]''' ''AI, build-system, installer, headless, sound''
* imbaczek (Marek Baczynski)
* jcnossen
* SJ
* Tobi (Tobi Vollebregt) ''releases, buildbot, simulation, Lua''
* [[User:Tim_Blokdijk|tim blokdijk]]
* trepan
* victor
* xiphux
* zerver ''GFX, simulation, Lua, multithreaded''

==Special Thanks==
Additionally for significant contributions to the spring engine or the community, special gratitude goes to (in alphabetical order):

* Beherith
* betalord
* bibim (Yann Riou)
* BrainDamage
* colorblind (Teake Nutma)
* dansan (for hosting replays.springrts.com)
* det
* eriatarka
* FLOZi (Craig Lawrence)
* [https://github.com/gajop gajop (Gajo Petrovic)]
* hughperkins (Hugh Perkins)
* ILMTitan
* initram
* KDR_11k
* koshi
* Krogothe
* M2
* MadrMan
* Nathaniel Smith
* Nicolas Brodu
* rattle
* satirik
* semi
* smoth
* SpliFF
* quantum
* zenzike (Nicolas Wu)
* zizu
* zydox (for sharing A LOT of CPU power for running the validation test / buildslave)

=Notes=

NEVER send bug reports, help- and feature-requests directly to the
persons in this list, use the [http://springrts.com/mantis/ bugtracker] or the [http://springrts.com/phpbb/ forum] instead.
Of course you are free to write mails about donating.

For additions/corrections to the list, please post in the community forum.

[[Category:Engine Dev]]

Authors

2016-02-07T23:33:45Z

Hokomoko: 8 months bitches

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

=Authors=

Spring (formerly TASpring) was originally written by the Swedish clan SY,
and later extended by a bunch of other people, some of whom are listed
here (in alphabetical order):

==Active==

* '''[[User:abma|abma]]''' ''Python AI Interface, installer, infrastructure, tester''
* '''cleanrock''' GFX, bug-fixes
* '''[[User:hokomoko|hokomoko]]'''
* '''jK''' ''GFX, simulation, Lua, sound, OpenMP, OS related''
* '''Kloot''' ''GFX, simulation, Lua, bug-fixes''

==Retired==
* Auswaschbar (Karl-Robert Ernst)
* fnordia
* '''[[User:hoijui|hoijui]]''' ''AI, build-system, installer, headless, sound''
* imbaczek (Marek Baczynski)
* jcnossen
* SJ
* Tobi (Tobi Vollebregt) ''releases, buildbot, simulation, Lua''
* [[User:Tim_Blokdijk|tim blokdijk]]
* trepan
* victor
* xiphux
* zerver ''GFX, simulation, Lua, multithreaded''

==Special Thanks==
Additionally for significant contributions to the spring engine or the community, special gratitude goes to (in alphabetical order):

* Beherith
* betalord
* bibim (Yann Riou)
* BrainDamage
* colorblind (Teake Nutma)
* dansan (for hosting replays.springrts.com)
* det
* eriatarka
* FLOZi (Craig Lawrence)
* [https://github.com/gajop gajop (Gajo Petrovic)]
* hughperkins (Hugh Perkins)
* ILMTitan
* initram
* KDR_11k
* koshi
* Krogothe
* M2
* MadrMan
* Nathaniel Smith
* Nicolas Brodu
* rattle
* satirik
* semi
* smoth
* SpliFF
* quantum
* zenzike (Nicolas Wu)
* zizu
* zydox (for sharing A LOT of CPU power for running the validation test / buildslave)

=Notes=

NEVER send bug reports, help- and feature-requests directly to the
persons in this list, use the [http://springrts.com/mantis/ bugtracker] or the [http://springrts.com/phpbb/ forum] instead.
Of course you are free to write mails about donating.

For additions/corrections to the list, please post in the community forum.

[[Category:Engine Dev]]

Games

2016-01-19T00:02:54Z

Hokomoko: /* Open Source */

__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. 

You can download games automatically, using your lobby (see [[Read_Me_First|Read Me First]]).

Game can also be [[Getting_Spring_Content_and_Links|downloaded manually]], as sdz files, and placed into ../Spring/Games. Read the advice on [[Read_Me_First|this page]] if your lobby does not find your games. Some games also offer a stand-alone installer.

=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.''
{|
|-
| width="300px" | <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 |
| | <h2>'''[http://spring1944.org/ Spring: 1944]'''</h2>([https://github.com/spring1944/spring1944/blob/master/docs/License.txt CC-BY-NC])
|-
| | {{navimgx|xsize=300|ysize=225|image=Zero-k_image.jpg|link=http://zero-k.info/}}
|
| |{{navimgx|xsize=300|ysize=225|image=S44_tigers.jpg|link=http://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.
|-
| | <h2>[http://www.evolutionrts.info Evolution RTS]</h2>([http://creativecommons.org/licenses/by-nc-nd/3.0/us/ CC-BY-NC-ND])
| width=40 |
| | <h2>[[Kernel Panic]]</h2>([[Kernel_Panic#License:|FOSS, with only 2 FOSS maps]])
|-
| valign="top"| {{navimgx|xsize=300|ysize=188|image=Evoimg.jpg|link=http://www.evolutionrts.info}}
|
| | {{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.
|-
| | <h2>'''[http://springfiles.com/spring/games/edge-1 On The Edge]'''</h2> (GPL, [http://creativecommons.org/licenses/by-nc-sa/3.0/us/ CC-BY-NC-SA])
|
| | <h2>'''[http://www.moddb.com/games/conflict-terra Conflict Terra]'''</h2>([http://code.google.com/p/conflictterra/source/browse/games/CT/License.txt FOSS])
|-
| |{{navimgx|xsize=300|ysize=225|image=start3.jpg||link=http://springfiles.com/spring/games/edge-1}}
|
| align="center" |{{navimgx|xsize=300|ysize=225|image=CT_Hojos.png|link=http://www.moddb.com/games/conflict-terra}}
|-
| align="justify" valign="top" | First Spring MOBA with unique pre-game hero setup. Under heavy development. How to setup working the game read on [http://springrts.com/phpbb/viewtopic.php?f=55&t=31476 On The Edge forum thread]
|
| 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="center" width="300px" | <h2>[http://www.indiedb.com/games/the-cursed The Cursed]</h2>
([http://creativecommons.org/licenses/by-nc-sa/4.0 CC-BY-NC-SA])
| width=40 |
| align="center" width="300px" | <h2>[http://www.metalfactions.pt Metal Factions]</h2>
([http://www.metalfactions.pt/about.html#license CC-BY-ND, with GPL/PD code])
|-
| align="center" | {{navimgx|xsize=300|ysize=225|image=cursed_logo.jpg|link=http://www.indiedb.com/games/the-cursed}}
|
| align="center" | {{navimgx|xsize=300|ysize=225|image=Mf_spring_wiki.jpg|link=http://www.metalfactions.pt}}
|-
| 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.
|
| align="justify" valign="top" | An evolving game that started as a TA mod and currently features four factions: AVEN, GEAR, CLAW and SPHERE. Commanders can morph to fit into different play styles and be easily revived. Economy scaling is more strictly tied to map control.
|}

=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 include large GPL-friendly content collections.''

{|
|-
| width="300px" | <h2> [https://springrts.com/phpbb/viewforum.php?f=46 Star Wars: Imperial Winter] </h2>
| width=40 |
| align="center" |
|-
| align="center" | {{navimgx|xsize=300|ysize=225|image=Imperial Winter assault.jpg|link=https://springrts.com/phpbb/viewforum.php?f=46}}
|
| align="center" |
|-
| align="justify" valign="top" | A Star Wars themed game set in the troubled post-Return of the Jedi era.
|
| align="justify" valign="top" |
|}

=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.''

{|
|-
| | <h2> [http://springrts.com/wiki/Balanced_Annihilation Balanced Annihilation] </h2>
| width=40 |
| | <h2> [http://springfiles.com/spring/games/tech-annihilation-8 Tech Annihilation] </h2>
|-
| | {{navimgx|xsize=300|ysize=225|image=BAScreenShot.jpg|link=http://springrts.com/phpbb/viewforum.php?f=44}}
|
| | {{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)

|-
| | <h2>[http://nota.machys.net/downloads NOTA]</h2>
| width=40 |
| | <h2> [[XTA]] </h2>
|-
| | {{navimgx|xsize=300|ysize=225|image=notAgame02.jpg|link=http://nota.machys.net/downloads}}
| width=40 |
| | {{navimg|xsize=300|ysize=225|image=Screen508_s.jpg|link=XTA}}
|-
| 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.
| width=40 |
| 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]]

Lua SyncedCtrl

2016-01-15T21:39:16Z

Hokomoko: /* Unit Control */

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

= Game End =
'''Spring.KillTeam''' {{new|83.0}}
( number teamID ) -> nil
Will declare a team to be dead ( no further orders can be assigned to such teams's units ), Gaia team cannot be killed.

'''Spring.GameOver''' {{new|83.0}}
( {number allyTeamID1, number allyTeamID2, ...} ) -> nil
Will declare game over, a list of winning allyteams can be passed, if undecided ( like when dropped from the host ) it should be empty ( no winner ), in the case of a draw with multiple winners, all should be listed

= RulesParams =
string values are new since 95.0

'''Spring.SetUnitRulesParam'''
( number unitID, string paramName, number|string paramValue [, table losAccess] ) -> nil
possible keys for the losAccess table are:
`private` : only readable by the ally (default)
`allied` : readable by ally + ingame allied
`inlos` : readable if the unit is in LOS
`inradar` : readable if the unit is in AirLOS
`public` : readable by all
note: if one condition is fulfilled all beneath it are too (e.g. if an unit is in LOS it can read params with `inradar=true` even if the param has `inlos=false`)
note2: all GameRulesParam are public, TeamRulesParams can just be `private`,`allied` and/or `public`
note3: You can read RulesParams from '''any''' Lua enviroments! With those losAccess policies you can limit their access.

'''Spring.SetTeamRulesParam'''
( number teamID, string paramName, number|string paramValue [, table losAccess] ) -> nil
see above for further documentation of losAccess

'''Spring.SetGameRulesParam'''
( string paramName, number|string paramValue [, table losAccess] ) -> nil
see above for further documentation of losAccess

= Resources =
'''Spring.AddTeamResource'''
( number teamID, string "metal" | "energy", number amount ) -> nil
'''Spring.UseTeamResource'''
( number teamID,
string "metal" | "energy",number amount |
{ metal = number amount, energy = number amount}
) -> nil | boolean hadEnough

'''Spring.SetTeamResource'''
( number teamID, string res, number amount ) -> nil

possible values for res are:
"m" = metal
"e" = energy
"ms" = metal storage
"es" = energy storage


'''Spring.SetTeamShareLevel'''
( number teamID, string "metal" | "energy", number amount ) -> nil

'''Spring.ShareTeamResource''' 0.82 and later
( number teamID_src, number teamID_recv, string "metal" | "energy", number amount ) -> nil

= Teams =
'''Spring.SetAlly''' {{new|98.0}}
( number firstAllyTeamID, number secondAllyTeamID, boolean ally ) -> nil

Changes the value of the (one-sided) alliance between: firstAllyTeamID -> secondAllyTeamID


'''Spring.AssignPlayerToTeam''' {{new|98.0}} {{Sourcelinkhash|7ed9a7e34814c60e5ae16281520cccc4daf3c367}}
( number playerID, number teamID)

= Unit Handling =
'''Spring.CreateUnit''' note: offmap positions are clamped! (you still can use MoveCtrl todo so)
( string "defName" | number unitDefID,
number x, number y, number z,
(number facing | string "facing"),
number teamID
[, boolean build = false]
[, boolean flattenGround = true]
[, number unitID]
[, number builderID]) -> number unitID | nil (meaning unit was not created)

possible values for facing are:
"south" | "s" | 0
"east" | "e" | 1
"north" | "n" | 2
"west" | "w" | 3
if build is true the unit is created in "being built" state, with buildProgress = 0
unitID and builderID are {{new|92.0}}, the former allowing to spawn a unit with
a specific ID.


'''Spring.DestroyUnit'''
( number unitID
[, boolean selfd = false]
[, boolean reclaimed = false]
[, number attackerID ] ) -> nil

selfd := makes the unit act like it self-destructed
reclaimed := don't show any DeathSequences, don't leave a wreckage.
NOTE this does _not_ give back the resources to the team!


'''Spring.TransferUnit'''
( number unitID,
numer newTeamID
[, boolean given = true ] ) -> nil
if given=false, the unit is captured

== Unit Control ==
'''Spring.SetUnitCosts'''
( number unitID, {
[ buildTime = number amount ],
[ metalCost = number amount ],
[ energyCost = number amount ]
} ) -> nil

'''Spring.SetUnitTooltip'''
( number unitID, string "tooltip" ) -> nil

'''Spring.SetUnitHealth'''
( number unitID,
number health |
{ [ health = number health ],
[ capture = number capture ],
[ paralyze = number paralyze ],
[ build = number build ] }
) -> nil

'''Spring.SetUnitMaxHealth'''
( number unitID, number maxHealth ) -> nil

'''Spring.AddUnitDamage'''
( number unitID, number damage
[, number paralyze = 0 [, number attackerID = -1 [, number weaponID = -1
[, number impulse_x [, number impulse_y [, number impulse_z ]]] ]]] ) -> nil

'''Spring.SetUnitStockpile'''
( number unitID [, number stockpile [, number buildPercent ]]) -> nil

'''Spring.SetUnitExperience'''
( number unitID, number experience ) -> nil

'''Spring.SetUnitFuel'''
( number unitID, number fuel ) -> nil

'''Spring.SetUnitCrashing''' {{new|83.0}}
( number unitID, boolean crashing ) -> boolean success

'''Spring.SetUnitLineage''' Removed from version 83.0 
( number unitID, number teamID [, boolean isRoot] ) -> nil

'''Spring.SetUnitNeutral'''
( number unitID, boolean neutral ) -> nil

'''Spring.SetUnitTarget''' userTarget & success new in version 95.0, setting nil target new in 99.0
( number unitID,
number enemyUnitID | number x, number y, number z, | nil,
[ boolean dgun = false ], [ boolean userTarget = false ] ) -> success

'''Spring.SetUnitMaxRange'''
( number unitID, number maxRange ) -> nil

'''Spring.SetUnitBlocking''' crushable new in version 85.0
( number unitID, boolean blocking [, boolean collide [, boolean crushable]] ) -> nil

'''Spring.SetUnitBlocking''' {{new|95.0}} changed parameters:
number unitID,
boolean isBlocking,
boolean isSolidObjectCollidable,
boolean isProjectileCollidable,
boolean isRaySegmentCollidable,
boolean crushable,
boolean blockEnemyPushing,
boolean blockHeightChanges

'''Spring.SetUnitMetalExtraction'''
( number unitID, number depth [,number range] ) -> nil

'''Spring.SetUnitBuildSpeed'''
( number builderID,
number buildSpeed, [ number repairSpeed [, number reclaimSpeed
[,number resurrectSpeed [, number captureSpeed [, number terraformSpeed ]] ]]] ) -> nil

'''Spring.SetUnitNanoPieces''' {{new|92.0}}
( number builderID, table pieces ) -> nil
This saves a lot of engine calls, by replacing:
function script.QueryNanoPiece() return currentpiece end
Use it!

'''Spring.SetUnitPieceParent''' {{new|101.0}}
( number unitID, number AlteredPiece, number ParentPiece ) -> nil
Changes the pieces hierarchy of a unit, by attaching a piece to a new parent.

'''Spring.SetUnitArmored''' armorMultiple new in version 0.83.x
( number unitID, boolean armored [, number armorMultiple] ) -> nil

'''Spring.SetUnitShieldState'''
( number unitID [, number weaponID = -1] [, boolean enabled] [, number power] ) -> nil

'''Spring.SetUnitFlanking'''
( number unitID, string "mode", number mode ) -> nil
( number unitID, string "moveFactor", number factor) -> nil
( number unitID, string "minDamage", number minDamage ) -> nil
( number unitID, string "mazDamage", number maxDamage ) -> nil
( number unitID, string "dir", number x, number y, number z) -> nil

'''Spring.SetUnitWeaponState'''
( number unitID, number weaponNum, table states ) -> nil
( number unitID, number weaponNum, string key, number value ) -> nil
format of the states table:
{
["reloadState" = number value,]
["reloadFrame" = number value,] (synonym for reloadState!)
["reloadTime" = number value,]
["accuracy" = number value,]
["sprayAngle" = number value,]
["range" = number value,] (*)
["projectileSpeed" = number value,]
["burst" = number value,]
["burstRate" = number value,]
["projectiles" = number value,]
["aimReady" = number value,] (<>0.0f := true)
}
(*) if you change the range of a weapon with dynamic damage
make sure you use SetUnitWeaponDamages to change dynDamageRange as well.


'''Spring.SetUnitWeaponDamages''' {{new|101.0}}
( number unitID, number weaponNum | "selfDestruct" | "explode", table damages ) -> nil
( number unitID, number weaponNum | "selfDestruct" | "explode", string key, number value ) -> nil
format of the damages table:
{
["paralyzeDamageTime" = number value,]
["impulseFactor" = number value,]
["impulseBoost" = number value,]
["craterMult" = number value,]
["craterBoost" = number value,]
["dynDamageExp" = number value,]
["dynDamageMin" = number value,]
["dynDamageRange" = number value,]
["dynDamageInverted" = number value,] (<>0.0f := true)
["craterAreaOfEffect" = number value,]
["damageAreaOfEffect" = number value,]
["edgeEffectiveness" = number value,]
["explosionSpeed" = number value,]
[number armorType = number value,] (changes the damage against this armor type)
}


'''Spring.SetUnitCollisionVolumeData'''
( number unitID, number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetX,
number vType, number tType, number Axis
) -> nil
enum COLVOL_TYPES {
COLVOL_TYPE_DISABLED = -1,
COLVOL_TYPE_ELLIPSOID = 0,
COLVOL_TYPE_CYLINDER,
COLVOL_TYPE_BOX,
COLVOL_TYPE_SPHERE,
COLVOL_NUM_TYPES // number of non-disabled collision volume types
};
enum COLVOL_TESTS {
COLVOL_TEST_DISC = 0,
COLVOL_TEST_CONT = 1,
COLVOL_NUM_TESTS = 2 // number of tests
};
enum COLVOL_AXES {
COLVOL_AXIS_X = 0,
COLVOL_AXIS_Y = 1,
COLVOL_AXIS_Z = 2,
COLVOL_NUM_AXES = 3 // number of collision volume axes
};


'''Spring.SetUnitPieceCollisionVolumeData'''
( number unitID, number pieceIndex, boolean enable,
number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetZ
[, number volumeType [, number primaryAxis]]
) -> nil

'''Spring.SetUnitTravel'''
( number unitID, number travel [, number travelPeriod] ) -> nil

'''Spring.SetUnitMoveGoal''' used by default commands to get in build-,attackrange etc.
(number unitID, number goalx, number goaly, number goalz
[, number goalRadius [, number moveSpeed [, bool moveRaw ]]] )
{{new|98.0}} moveRaw: [http://springrts.com/mantis/view.php?id=4412 allow unit to dumbly move to a coordinate without calculating path.]

'''Spring.SetUnitPhysics''' drag new in version 95.0
( number unitID,
number posx, number posy, number posz,
number velx, number vely, number velz,
number rotx, number roty, number rotz,
number dragx, number dragy, number dragz,
) -> nil

'''Spring.SetUnitPosition'''
( number unitID, number x, number z [, boolean alwaysAboveSea] ) -> nil

'''Spring.SetUnitDirection''' {{new|90.0}}
( number unitID, number x, number y, number z ) -> nil

'''Spring.SetUnitVelocity'''
( number unitID, number velx, number vely, number velz ) -> nil

'''Spring.SetUnitRotation'''
( number unitID, number rotx, number roty, number rotz ) -> nil

'''Spring.AddUnitImpulse'''
( number unitID, number x, number y, number z [, decayRate ] ) -> nil

'''Spring.AddUnitSeismicPing'''
( number unitID, number pingSize ) -> nil

'''Spring.RemoveBuildingDecal'''
( number unitID ) -> nil

'''Spring.SetUnitMidAndAimPos''' {{new|89.0}}
( number unitID,
number mpx, number mpy, number mpz,
number apx, number apy, number apz,
[, boolean relative] ) -> boolean success


mpx, mpy, mpz: new middle position of unit

apx, apy, apz: new position that enemies aim at on this unit

relative: are the new coordinates relative to world or unit coordinates?


'''Spring.SetUnitRadiusAndHeight''' {{new|89.0}}
( number unitID, number radius, number height ) -> boolean success

'''Spring.UnitWeaponFire'''
( number unitID, number weaponID ) -> nil
'''Spring.UnitWeaponHoldFire'''
( number unitID, number weaponID ) -> nil

== Unit LOS ==
'''Spring.SetUnitCloak'''
( number unitID,
boolean cloaked | number scriptCloak,
[ number decloakDistance | boolean decloakAbs ] ) -> nil


If the 2nd argument is a number, the value works like this:
1:=normal cloak
2:=for free cloak (cost no E)
3:=for free + no decloaking (except the unit is stunned)
4>=ultimative cloak (no ecost, no decloaking, no stunned decloak)

The decloak distance is only changed if the 3th argument is a number or a boolean.
If the boolean is false it takes the default decloak distance for that unitdef,
if the boolean is true it takes the absolute value of it.

'''Spring.SetUnitSonarStealth'''
( number unitID, boolean sonarStealth ) -> nil

'''Spring.SetUnitStealth'''
( number unitID, boolean stealth ) -> nil

'''Spring.SetUnitAlwaysVisible'''
( number unitID, boolean alwaysVisible ) -> nil

'''Spring.SetUnitLosMask'''
( number unitID, number allyTeam, number los | table losTypes ) -> nil
the 3th argument is either the bit-and combination of the following numbers:
LOS_INLOS = 1
LOS_INRADAR = 2
LOS_PREVLOS = 4
LOS_CONTRADAR = 8
or a table of the following form:
losTypes = {
[los = boolean,]
[radar = boolean,]
[prevLos = boolean,]
[contRadar = boolean,]
}

'''Spring.SetUnitLosState'''
( number unitID, number allyTeam, number los | table losTypes ) -> nil
see above for more info on the arguments

'''Spring.SetUnitSensorRadius'''
( number unitID, string type, number radius ) -> nil | number newRadius
type can be:
"los","airLos","radar","sonar","seismic","radarJammer","sonarJammer"

'''Spring.SetRadarErrorParams''' {{new|95.0}}
(number allyTeamID, number allyteamErrorSize
[, number baseErrorSize [, number baseErrorMult ]]) -> nil

'''Spring.SetUnitPosErrorParams''' {{new|95.0}}
(number unitID, number posErrorVector.x, number posErrorVector.y, number posErrorVector.z,
number posErrorDelta.x, number posErrorDelta.y, number posErrorDelta.z
[ , number nextPosErrorUpdate]) --> nil

== Unit Resourcing ==
'''Spring.SetUnitResourcing'''
( number unitID,
string res, number amount |
{ res = number amount, ... }
) -> nil

possible values for res are: "[u|c][u|m][m|e]"
unconditional | conditional
use | make
metal | energy


'''Spring.AddUnitResource'''
( number unitID, string "m" | "e", number amount ) -> nil

'''Spring.UseUnitResource'''
( number unitID, string "m" | "e", number amount ) -> nil | boolean okay
( number unitID, { ["m" | "metal" | "e" | "energy"] = amount, ... } ) -> nil | boolean okay

'''Spring.SetUnitHarvestStorage''' {{new|97.0}}
( number unitid, number metal )

See also {{xtaglink|Gamedev:UnitDefs|harvestStorage}} UnitDef tag.

= Feature Handling =
'''Spring.CreateFeature'''
( string "defName" | number featureDefID,
number x, number y, number z
[, number heading
[, number AllyTeamID
[, number featureID ]]] ) -> number featureID

'''Spring.DestroyFeature'''
( number featureID ) -> nil

'''Spring.TransferFeature'''
( number featureID, number teamID ) -> nil

== Feature Control ==
'''Spring.SetFeatureHealth'''
( number featureID, number health) -> nil

'''Spring.SetFeatureReclaim'''
( number featureID, number reclaimLeft) -> nil

'''Spring.SetFeatureResurrect'''
( number featureID, string "UnitDefName?" [, number facing | string "facing" ] ) -> nil

possible values for facing are:
"south" | "s" | 0
"east" | "e" | 1
"north" | "n" | 2
"west" | "w" | 3


'''Spring.SetFeaturePosition'''
( number featureID, number x, number y, number z [, boolean snapToGround]) -> nil

'''Spring.SetFeatureDirection'''
( number featureID, number x, number y, number z ) -> nil

'''Spring.SetFeatureVelocity''' {{New|95.0}}

'''Spring.SetFeaturePhysics''' {{New|95.0}}

(like their feature counterparts at [[Lua_SyncedCtrl#Unit_Control]])

'''Spring.SetFeatureNoSelect'''
( number featureID, boolean noSelect ) -> nil

'''Spring.SetFeatureAlwaysVisible'''
( number featureID, boolean enable ) -> nil

'''Spring.SetFeatureCollisionVolumeData'''
( number featureID, number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetX,
number vType, number tType, number Axis
) -> nil
check Spring.SetUnitCollisionVolumeData for further explanation of the arguments

'''Spring.SetFeatureMidAndAimPos''' {{new|89.0}}
( number unitID,
number mpx, number mpy, number mpz,
number apx, number apy, number apz,
[, boolean relative] ) -> boolean success

check Spring.SetUnitMidAndAimPos for further explanation of the arguments

'''Spring.SetFeatureRadiusAndHeight''' {{new|89.0}}
( number unitID, number radius, number height ) -> boolean success

'''Spring.SetFeatureBlocking'''
(number featureID, boolean blocking, boolean collidable) --> boolean

'''Spring.SetFeatureBlocking''' {{new|95.0}} changed parameters:
number featureID,
boolean isBlocking,
boolean isSolidObjectCollidable,
boolean isProjectileCollidable,
boolean isRaySegmentCollidable,
boolean crushable,
boolean blockEnemyPushing,
boolean blockHeightChanges

= Lua to COB =
'''Spring.CallCOBScript'''
( number unitID, number funcID | string funcName, number retArgs, COBArg1, COBArg2, ... )
-> nil | number returnValue, number retArg1, number retArg2, ...

'''Spring.CallCOBScriptCB''' 
broken in 0.78.2.1; will be removed with the introduction of Lua as COB replacement
( number unitID, number funcID | string funcName, number retArgs, COBArg1, COBArg2, ... )
-> nil | number returnValue, number CallbackData, number retArg1, number retArg2, ...

'''Spring.GetCOBScriptID'''
( number unitID, string funcName ) -> nil | number funcID

Note: Don't use Spring.[Get|Set]UnitCOBValue in LUS just because you are familar with it since bos/cob, use the mighty LuaSpringAPI instead!

'''Spring.GetUnitCOBValue'''
( number unitID [, boolean splitData=false], number COBValue
[, number param1 [,number param2 [, number param3 [, number param4 ] ] ] ] )
-> number result | number result1, number result2
you find the possible values for `COBValue` in [[Lua_ConstCOB#Get.2FSet|Lua_ConstCOB]]
 also see [[Animation-CobConstants#Custom_Variables|Custom_Variables]]

'''Spring.SetUnitCOBValue'''
( number unitID, number COBValue, number param1 [,number param2] ) -> nil
you find the possible values for `COBValue` in [[Lua_ConstCOB#Get.2FSet|Lua_ConstCOB]]
 also see [[Animation-CobConstants#Custom_Variables|Custom_Variables]]

= Give Order =
options can also be a bitmask; e.g. 0 instead of an empty table (can avoid performance hit on table creation) 
see [[Lua CMDs]] for relevant constants


'''Spring.GiveOrderToUnit'''
( number unitID,
number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"} ) -> nil

'''Spring.GiveOrderToUnitMap'''
( unitMap = { [unitID] = dontCare, etc... },
number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"} ) -> nil

'''Spring.GiveOrderToUnitArray'''
( unitArray = { [1] = unitID, etc... },
number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"} ) -> nil

'''Spring.GiveOrderArrayToUnitMap'''
( unitMap = { [number unitID] = dontCare, etc... },
orderArray = {
{ number cmdID,
{number, etc...}, params
{"alt", "ctrl", "shift", "right"} options
}, ..
}
) -> nil

'''Spring.GiveOrderArrayToUnitArray'''
( unitArray = { [1] = number unitID, etc... },
orderArray = {
{ number cmdID,
{number, etc...}, params
{"alt", "ctrl", "shift", "right"} options
}, ..
}
) -> nil

=Ground=
== Grass ==
'''Spring.AddGrass'''
( number x, number z ) -> nil

'''Spring.RemoveGrass'''
( number x, number z ) -> nil

== Heightmap ==
Note that x & z coords are in worldspace (Game.mapSizeX/Z), still the heightmap resolution is Game.squareSize.

'''Spring.LevelHeightMap'''
( number x1, number z1 [, number x2, number z2], number height ) -> nil

'''Spring.AdjustHeightMap''' (heightmap[x][z] += height;)
( number x1, number z1 [, number x2, number z2], number height ) -> nil

'''Spring.RevertHeightMap'''
( number x1, number z1 [, number x2, number z2], number origFactor ) -> nil

'''Spring.SetHeightMapFunc'''
( lua_function [, arg1 ,[ arg2 [, ... ] ] ) -> nil | number absTotalHeightMapAmountChanged
Example code:<code><pre>
Spring.SetHeightMapFunc(function()
for z=0,Game.mapSizeZ, Game.squareSize do
for x=0,Game.mapSizeX, Game.squareSize do
Spring.SetHeightMap( x, z, 200 + 20 * math.cos((x + z) / 90) )
end
end
end)
</pre></code>
'''Spring.AddHeightMap''' can only be called in SetHeightMapFunc()
( number x, number z, number height ) -> nil | number newHeight
'''Spring.SetHeightMap''' can only be called in SetHeightMapFunc()
( number x, number z, number height [,number terraform = 1] ) -> nil | number absHeightDiff
the terraform argument is a scaling factor:
so if 0 nothing will be changed (the terraform starts) and if it is 1 the terraform will be finished.

'''Spring.LevelSmoothMesh'''
( number x1, number z1 [, number x2, number z2], number height ) -> nil
'''Spring.AdjustSmoothMesh'''
( number x1, number z1 [, number x2, number z2], number height ) -> nil
'''Spring.RevertSmoothMesh'''
( number x1, number z1 [, number x2, number z2], number origFactor ) -> nil

'''Spring.SetSmoothMeshFunc'''
( lua_function [, arg1 ,[ arg2 [, ... ] ] ) -> nil | number absTotalHeightMapAmountChanged
'''Spring.AddSmoothMesh''' can only be called in SetSmoothMeshFunc()
( number x, number z, number height ) -> nil | number newHeight
'''Spring.SetSmoothMesh''' can only be called in SetSmoothMeshFunc()
( number x, number z, number height [,number terraform = 1] ) -> nil | number absHeightDiff

== TerrainTypes ==
'''Spring.SetMapSquareTerrainType'''
( number x, number z, int newType ) -> nil | int oldType
'''Spring.SetTerrainTypeData'''
( int typeIndex
[, number speedTanks = nil ]
[, number speedKBOTs = nil ]
[, number speedHovers = nil ]
[, number speedShips = nil ] ) -> nil | boolean true

== MetalAmount ==
'''Spring.SetMetalAmount''' {{new|83.0}}
( number x, number z, number metalAmount)
x & z coords are in worldspace/16 metalAmount must be between 0 and 255*maxMetal (with maxMetal from the .smd or mapinfo.lua)

= Command Descriptions =
Doesn't work in unsynced code! 

'''Spring.EditUnitCmdDesc'''
( number unitID, number cmdDescID, table cmdArray ) -> nil

structure of cmdArray:
{
[ id = int ],
[ type = int ],
[ name = string ],
[ action = string ],
[ tooltip = string ],
[ texture = string ],
[ cursor = string ],
[ hidden = boolean ],
[ disabled = boolean ],
[ showUnique = boolean ],
[ onlyTexture = boolean ],
[ params = { string = string, ... } ]
}


'''Spring.InsertUnitCmdDesc'''
( number unitID [, number cmdDescID ] , table cmdArray ) -> nil

'''Spring.RemoveUnitCmdDesc'''
( number unitID [, number cmdDescID ] ) -> nil

= Other =
'''Spring.SetNoPause'''
( boolean noPause ) -> nil

'''Spring.SetUnitToFeature'''
( boolean tofeature ) -> nil

an ugly global switch that can be used to block units turning into features when they finish being built (like *A DT's do, which have the isFeature tag)
[http://springrts.com/phpbb/viewtopic.php?f=14&p=481521 thread]


'''Spring.SetExperienceGrade'''
( number expGrade
[, number ExpPowerScale [, number ExpHealthScale [, number ExpReloadScale ]]] ) -> nil

expGrade defines how often UnitExperience() will be called,
it is based on the following equation:
(int) [exp/(exp+1)] / expGrade
If this integer differs from the one before the experience change
it will call UnitExperience().
Also those 3 last params are only available in .cheat


'''Spring.SpawnCEG'''
( string "cegname" | number cegID,
number posX = 0, number posY = 0, number posZ = 0,
number dirX = 0, number dirY = 0, number dirZ = 0,
number radius = 0, number damage = 0
) -> nil | boolean success, cegID
cegID new in 95.0

= Projectiles =
'''Spring.SpawnProjectile'''
( number weaponDefID, table projectileParams ) -> nil | number projectileID
possible keys of projectileParams are:
pos = {number x, number y, number z},
end = {number x, number y, number z},
speed = {number x, number y, number z},
spread = {number x, number y, number z},
error = {number x, number y, number z},
owner = number,
team = number,
ttl = number,
gravity = number,
tracking = number,
maxRange = number,
startAlpha = number,
endAlpha = number,
model = string,
cegTag = string,


'''Spring.SetProjectileTarget'''

Pre 95.0: ( number projectileID,
[ number targetID, string targetTypeStr ] | [ number posX, number posY, number posZ ] )
-> nil | boolean validTarget

Post 95.0: ( number projectileID,
[ number targetID [, number targetType]] | [number posX, number posY, number posZ])
--> nil | boolean validTarget
targetTypeStr can be one of:
'u' - unit
'f' - feature
'p' - projectile
while targetTypeInt is one of:
string.byte('g') := GROUND
string.byte('u') := UNIT
string.byte('f') := FEATURE
string.byte('p') := PROJECTILE

'''Spring.SetProjectileIsIntercepted''' {{new|99.0}}
( number projID ) -> nil

'''Spring.SetProjectileMoveControl''' (disables engine movecontrol, so lua can fully control the physics)
( number projID, boolean enable ) -> nil
'''Spring.SetProjectilePosition'''
( number projID [, number x = 0 [, number y = 0 [, number z = 0 ]]] ) -> nil
'''Spring.SetProjectileVelocity'''
( number projID [, number x = 0 [, number y = 0 [, number z = 0 ]]] ) -> nil
'''Spring.SetProjectileCollision'''
( number projID ) -> nil
'''Spring.SetProjectileGravity'''
( number projID [, number grav = 0] ) -> nil
'''Spring.SetProjectileSpinAngle''' {{new|95.0}} Deprecated
( number projID [, number spinAngle = 0] ) -> nil
'''Spring.SetProjectileSpinSpeed''' {{new|95.0}} Deprecated
( number projID [, number speed = 0] ) -> nil
'''Spring.SetProjectileSpinVec''' {{new|95.0}} Deprecated
( number projID [, number x = 0 [, number y = 0 [, number z = 0]]] ) -> nil
'''Spring.SetProjectileCEG'''
( number projID, string ceg_name ) -> nil

'''Spring.SetPieceProjectileParams''' {{new|95.0}}
(number projectileID,
[ number explosionFlags, [ number spinAngle, [ number spinSpeed,
[ number spinVector.x, [ number spinVector.y, [ number spinVector.z ]]]]]]) --> nil

'''Spring.SetProjectileAlwaysVisible''' {{new|95.0}}
(number projectileID, boolean alwaysVisible) --> nil

'''Spring.SetProjectileDamages''' {{new|101.0}}
( number unitID, number weaponNum, table damages ) -> nil
( number unitID, number weaponNum, string key, number value ) -> nil
format of the damages table:
{
["paralyzeDamageTime" = number value,]
["impulseFactor" = number value,]
["impulseBoost" = number value,]
["craterMult" = number value,]
["craterBoost" = number value,]
["dynDamageExp" = number value,]
["dynDamageMin" = number value,]
["dynDamageRange" = number value,]
["dynDamageInverted" = number value,] (<>0.0f := true)
["craterAreaOfEffect" = number value,]
["damageAreaOfEffect" = number value,]
["edgeEffectiveness" = number value,]
["explosionSpeed" = number value,]
[number armorType = number value,] (changes the damage against this armor type)
}


[[category: Lua]]

Lua SyncedRead

2016-01-15T21:36:10Z

Hokomoko: /* Unit Weapon Informations */

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

== Game ==

=== Special TeamID Variables ===
(those special TeamIDs are not supported by all functions) 
'''Spring.ALL_UNITS''' 
'''Spring.MY_UNITS''' 
'''Spring.ALLY_UNITS''' 
'''Spring.ENEMY_UNITS'''

'''Spring.GetGaiaTeamID'''
( ) -> number teamID

=== GameStates ===
'''Spring.IsGodModeEnabled'''
( ) -> boolean
'''Spring.IsCheatingEnabled'''
( ) -> boolean
'''Spring.IsDevLuaEnabled'''
( ) -> boolean
'''Spring.IsEditDefsEnabled'''
( ) -> boolean
'''Spring.AreHelperAIsEnabled'''
( ) -> boolean
'''Spring.FixedAllies'''
( ) -> nil | boolean

'''Spring.IsGameOver'''
( ) -> boolean

=== RulesParams ===
Those functions allow to save data per Game,Team and Unit. The advantage of it is that it can be read from anywhere (even from LuaUI and AIs!) 
string values are new since 95.0

'''Spring.GetRulesInfoMap''' REMOVED in 0.82!
( ) -> { [key1] = string value1, [key2] = string value2, ... }
( string "key" ) -> string

'''Spring.GetGameRulesParam'''
( number ruleIndex | string ruleName ) -> nil | number value | string value
'''Spring.GetGameRulesParams'''
( ) -> nil | { [ruleIndex1] = {[ruleName1] = number | string value1}, ... }

'''Spring.GetTeamRulesParam'''
( number teamID, number index | string ruleName ) -> nil | number value | string value
'''Spring.GetTeamRulesParams'''
( number teamID ) -> nil | { [ruleIndex1] = {[ruleName1] = number | string value1}, ... }

'''Spring.GetUnitRulesParam'''
( number unitID, number index | string ruleName ) -> nil | number value | string value
'''Spring.GetUnitRulesParams'''
( number unitID ) -> nil | { [ruleIndex1] = {[ruleName1] = number | string value1}, ... }

=== Mod-/Map-Options ===
'''Spring.GetModOptions'''
( ) -> {} | { "keyName1" = string "value", "keyName2" = string "value", ... }
'''Spring.GetMapOptions'''
( ) -> {} | { "keyName1" = string "value", "keyName2" = string "value", ... }

! bool values are not transfered from C to Lua correctly, so in IF theres needed to use this condition: 
"if (tonumber(Spring.GetModOptions.exampleOption) == 1) then...end" 
not only: 
"if (Spring.GetModOptions.exampleOption) then...end"

=== Speed/Time ===
'''Spring.GetGameSpeed''' As of 98.0 moved to [[Lua_UnsyncedRead]] due to desyncs in replays/demos
( ) -> number userSpeedFactor, number speedFactor, boolean paused
'''Spring.GetGameFrame'''
( ) -> number frameNum%dayFrames, number frameNum/dayFrames
'''Spring.GetGameSeconds'''
( ) -> number seconds

=== Vectors ===
'''Spring.GetWind'''
( ) -> number dirX, number dirY, number dirZ,
number strength, number normDirX, number normDirY, number normDirZ

'''Spring.GetHeadingFromVector'''
( number x, number z ) -> number heading
'''Spring.GetVectorFromHeading'''
( number heading ) -> number x, number z

== Sides/Factions ==
'''Spring.GetSideData'''
( string sideName ) -> nil | string startUnit, string caseSensitiveSideName
( number sideID ) -> nil | string sideName, string startUnit, string caseSensitiveSideName
( ) -> { [1] = { sideName=string,caseName=string,startUnit=string}, [2] = .., .. }

== Teams ==
=== StartBoxes/StartPositions ===
'''Spring.GetAllyTeamStartBox'''
( number allyID ) -> nil | number xmin, number zmin, number xmax, number zmax
'''Spring.GetTeamStartPosition'''
( number teamID ) -> nil | number x, number y, number z

=== Player,Team,Ally Lists/Info ===
'''Spring.GetPlayerList'''
( [number teamID = -1 | boolean onlyActive = false] [, number teamID | boolean onlyActive])
-> nil | { [1] = number playerID, etc... }
'''Spring.GetTeamList'''
( [number allyTeamID = -1] ) -> nil | { [1] = number teamID, etc... }
'''Spring.GetAllyTeamList'''
( ) -> { [1] = number allyTeamID, etc... }

'''Spring.GetPlayerInfo'''
( number playerID ) ->
nil | string "name", (PRE-83.0: in synced code this is "SYNCED_NONAME"!)
boolean active,
boolean spectator,
number teamID,
number allyTeamID,
number pingTime,
number cpuUsage,
string country,
number rank
table customPlayerKeys
'''Spring.GetPlayerControlledUnit'''
( number playerID ) -> nil | number unitID

'''Spring.GetAIInfo'''
( number teamID ) ->
number skirmishAIID,
string name,
number hostingPlayerID,
string shortName, (synced => "SYNCED_NOSHORTNAME"; non-local => "UNKNOWN")
string version, (synced => "SYNCED_NOVERSION"; non-local => "UNKNOWN")
table options (synced & non-local => empty-table)
Note: Before 0.82, the first argument was teamID, and then every other argument with a shifted position.

'''Spring.GetAllyTeamInfo'''
( number allyteamID ) -> nil | table customTeamKeys

'''Spring.GetTeamInfo'''
( number teamID ) ->
nil | number teamID,
number leader, (:= a player id)
boolean isDead,
boolean isAiTeam,
string "side",
number allyTeam,
table customTeamKeys,
number incomeMultiplier
'''Spring.GetTeamResources'''
( number teamID, string "metal" | "energy" ) ->
nil | number currentLevel,
number storage,
number pull,
number income,
number expense,
number share,
number sent,
number received
'''Spring.GetTeamUnitStats'''
( number teamID ) ->
nil | number killed,
number died,
number capturedBy,
number capturedFrom,
number received,
number sent
'''Spring.GetTeamResourceStats''' 0.82 and later
( number teamID, string "metal" | "energy" ) ->
nil | number used,
number produced,
number excessed,
number received,
number sent
'''Spring.GetTeamStatsHistory'''
( number teamID [, number startIndex [, number endIndex = startIndex ]]) ->
nil |
number cur_max_index |
{
[1] = {
"time" = number,
"frame" = number,
"metalUsed" = number,
"metalProduced" = number,
"metalExcess" = number,
"metalReceived" = number,
"metalSent" = number,
"energyUsed" = number,
"energyProduced" = number,
"energyExcess" = number,
"energyReceived" = number,
"energySent" = number,
"damageDealt" = number,
"damageReceived" = number,
"unitsProduced" = number,
"unitsDied" = number,
"unitsReceived" = number,
"unitsSent" = number,
"unitsCaptured" = number,
"unitsOutCaptured" = number,
"unitsKilled" = number
}, ...
}
if called with just teamID as argument it returns the current possible range for startIndex/endIndex :={1..cur_max_index}

'''Spring.GetTeamLuaAI'''
( number teamID ) -> string "luaAI"

Returns string containing name of AI defined in file LuaAI.lua as name="<AI name>". Maybe it returns whole table with all values there, so maybe depends, but in my LuaAI.lua name is on first position...

=== Teams/PlayersAllied ===
'''Spring.AreTeamsAllied'''
( number teamID1, number teamID2 ) -> nil | boolean
'''Spring.ArePlayersAllied'''
( number playerID1, number playerID2 ) -> nil | boolean

== Units ==
=== GetUnits ===
'''Spring.GetAllUnits'''
( ) -> nil | unitTable = { [1] = number unitID, ... }
'''Spring.GetTeamUnits'''
( number teamID ) -> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetTeamUnitsSorted'''
( number teamID ) -> nil |
unitDefTable = {
[number unitDefID] = { [1] = [number unitID], etc... },
etc...
}
'''Spring.GetTeamUnitsCounts'''
( number teamID ) -> nil | countTable = { [number unitDefID] = count, etc... }
'''Spring.GetTeamUnitsByDefs'''
( number teamID, number unitDefID | { number unitDefID1, ... } )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetTeamUnitDefCount'''
( number teamID, number unitDefID ) -> nil | number count
'''Spring.GetTeamUnitCount'''
( number teamID ) -> nil | number count

'''Spring.GetUnitsInRectangle'''
( number xmin, number zmin, number xmax, number zmax [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInBox'''
( number xmin, number ymin, number zmin,
number xmax, number ymax, number zmax [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInSphere'''
( number x, number y, number z, number radius [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInCylinder'''
( number x, number z, number radius [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInPlanes'''
( planes = { [1] = { number nx, number ny, number nz, number d }, etc... } )
-> nil | unitTable = { [1] = number unitID, etc... }

plane normals point towards accepted space,
so the acceptance criteria for each plane is:
radius = unit radius
px, py, pz = unit position
[(nx * px) + (ny * py) + (nz * pz) + (d - radius)] <= 0


'''Spring.GetUnitNearestAlly'''
( number unitID [, number range ] ) -> nil | number unitID
'''Spring.GetUnitNearestEnemy'''
( number unitID [, number range [, bool useLOS]] ) -> nil | number unitID

Post 95.0 this no longer returns neutral units

=== Unit Informations ===
'''Spring.ValidUnitID'''
( number unitID ) -> boolean
'''Spring.GetUnitIsDead'''
( number unitID ) -> nil | boolean
Returns false if unit exists and is alive, true for a brief period of time after unit dies, nil otherwise 
keep this in mind when using (not Spring.GetUnitIsDead())

'''Spring.GetUnitTooltip'''
( number unitID ) -> nil | string tooltip
'''Spring.GetUnitDefID'''
( number unitID ) -> nil | number unitDefID
'''Spring.GetUnitTeam'''
( number unitID ) -> nil | number teamID
'''Spring.GetUnitAllyTeam'''
( number unitID ) -> nil | number allyID
'''Spring.GetUnitLineage''' Removed from version 0.83.x 
( number unitID ) -> nil | number lineage | number lineage, boolean lineageIsRoot
'''Spring.GetUnitNeutral'''
( number unitID ) -> nil | boolean neutral
'''Spring.GetUnitHealth'''
( number unitID ) -> nil | number health, number maxHealth, number paralyzeDamage,
number captureProgress, number buildProgress
build Progress is returned as floating Point between 0.0 and 1.0

'''Spring.GetUnitArmored''' armorMultiple new in version 0.83.x
( number unitID ) -> nil | boolean armored, number armorMultiple
'''Spring.GetUnitIsStunned'''
( number unitID ) -> nil | boolean stunned_or_inbuild, boolean stunned, boolean inbuild
'''Spring.GetUnitMaxRange'''
( number unitID ) -> nil | number maxEngagementRange
'''Spring.GetUnitResources'''
( number unitID ) -> nil | number metalMake, number metalUse,
number energyMake, number energyUse
'''Spring.GetUnitHarvestStorage'''
( number unitID ) -> nil | number metal
See also {{xtaglink|Gamedev:UnitDefs|harvestStorage}} UnitDef tag.

'''Spring.GetUnitMetalExtraction''' 0.82+ and later
( number unitID ) -> nil | number
'''Spring.GetUnitExperience'''
( number unitID ) -> nil | number experience
'''Spring.GetUnitStates'''
( number unitID ) -> nil | {
"firestate" = number,
"movestate" = number,
"repeat" = boolean,
"cloak" = boolean,
"active" = boolean,
"trajectory" = boolean,
["autoland" = boolean,]
["autorepairlevel" = number,]
["loopbackattack" = boolean]
}
'''Spring.GetUnitIsActive'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitIsCloaked'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitSelfDTime'''
( number unitID ) -> nil | number
'''Spring.GetUnitStockpile'''
( number unitID ) -> nil | number numStockpiled, number numStockpileQued,
number buildPercent
'''Spring.GetUnitHeight'''
( number unitID ) -> nil | number
'''Spring.GetUnitRadius'''
( number unitID ) -> nil | number
'''Spring.GetUnitBlocking''' {{new|85.0}}
( number unitID ) -> nil | boolean blocking, boolean crushable
{{new|95.0}} Now return values are:
boolean isBlocking,
boolean isSolidObjectCollidable,
boolean isProjectileCollidable,
boolean isRaySegmentCollidable,
boolean crushable,
boolean blockEnemyPushing,
boolean blockHeightChanges

'''Spring.GetUnitPosition'''
( number unitID, [, boolean midPos [, boolean aimPos ] ] ) ->
nil |
number bpx, number bpy, number bpz
[, number mpx, number mpy, number mpz ]
[, number apx, number apy, number apz ]
since 89.0, returns the base (default), middle or aim position of the unit.

'''Spring.GetUnitBasePosition''' Deprecated in 89.0, use GetUnitPosition
( number unitID ) -> nil | number x, number y, number z
returns the bottom of the unit.

'''Spring.GetUnitDirection'''
( number unitID ) -> nil | number dx, number dy, number dz
returns the direction vector

'''Spring.GetUnitHeading'''
( number unitID ) -> nil | number heading
returns heading directions used in COB scripts

'''Spring.GetUnitRotation''' {{New|95.0}}
(number unitID) --> nil | number pitch, number yaw, number roll
Marked as (WIP) in changelog

'''Spring.GetUnitVelocity''' velw new in 95.0
( number unitID ) -> nil | number velx, number vely, number velz, number velLength
'''Spring.GetUnitBuildFacing'''
( number unitID ) -> nil | number
'''Spring.GetUnitIsBuilding''' returns what unit a constructor/factory is currently building
( number unitID ) -> nil | number unitID
'''Spring.GetUnitCurrentBuildPower''' {{new|92.0}}
( number unitID ) -> nil | number buildPower
'''Spring.GetUnitNanoPieces'''
( number unitID ) -> nil | { [1] = number piece1, etc ... }
'''Spring.GetUnitTransporter'''
( number unitID ) -> nil | number unitID
'''Spring.GetUnitIsTransporting'''
( number unitID ) -> nil | { [1] = number unitID, etc... }
'''Spring.GetUnitShieldState'''
( number unitID [, number weaponID = -1] ) -> nil | number isEnabled, number curPower
'''Spring.GetUnitTravel'''
( number unitID ) -> nil | number travel, number travelPeriod
'''Spring.GetUnitFuel'''
( number unitID ) -> nil | number
'''Spring.GetUnitFlanking'''
( number unitID, string "dir" ) -> nil | number x, number y, number z
( number unitID, string "mode" | "moveFactor" | "minDamage" | "maxDamage" ) -> nil | number
( number unitID ) -> nil | number mode, number modilityAdd,
number minDamage, number maxDamage, number dirX, number dirY, number dirZ
'''Spring.GetUnitSensorRadius'''
( number unitID, string type ) -> nil | number radius
possible types are: los, airLos, radar, sonar, seismic, radarJammer & sonarJammer

'''Spring.GetUnitLosState''' raw is only available in gadgets
( number unitID [, number allyTeamID [, boolean raw] ] ) -> nil | number raw |
{ ["los" = true] [, "radar" = true] [, "typed" = true] }
'''Spring.GetUnitSeparation''' surfaceDist new in 95.0
( number unitID1, number unitID2 [, boolean 2D] [, boolean surfaceDist] ) -> nil | number distance
returns the distance of 2 units, surfaceDist calculates the distance between the unitsphere surfaces instead of their midpos

'''Spring.GetUnitDefDimensions'''
( number unitDefID ) -> nil |
{
"height" = number,
"radius" = number,
"midx" = number,
"minx" = number,
"maxx" = number,
"midy" = number,
"miny" = number,
"maxy" = number,
"midz" = number,
"minz" = number,
"maxz" = number
}
'''Spring.GetUnitLastAttacker'''
( number unitID ) -> nil | number unitID
'''Spring.GetUnitLastAttackedPiece''''
( number unitID ) -> nil | string pieceName, number gameframe
'''Spring.GetUnitMoveTypeData''' new in version 0.80+
( number unitID ) -> nil | { movetype data }
'''Spring.GetUnitCollisionVolumeData'''
( number unitID )
-> number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetZ,
number volumeType, number testType, number primaryAxis, boolean disabled
'''Spring.GetUnitPieceCollisionVolumeData'''
( number unitID, number pieceID )
-> number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetZ,
number volumeType, number testType, number primaryAxis, boolean disabled

==== Unit Weapon Informations ====
'''Spring.GetUnitWeaponState'''
( number unitID, number weaponNum ) -> nil |
boolean angleGood, boolean loaded, number reloadFrame, number salvoLeft, number numStockpiled
( number unitID, number weaponNum, string tag ) -> nil | number
`tag` can be:
"reloadState" == "reloadFrame"
"reloadTime"
"accuracy"
"sprayAngle"
"range"
"projectileSpeed"
"burst"
"burstRate"
"projectiles"

'''Spring.GetUnitWeaponDamages''' {{new|101.0}}
( number unitID, number weaponNum | "selfDestruct" | "explode", string tag ) -> nil | number
`tag` can be:
"paralyzeDamageTime"
"impulseFactor"
"impulseBoost"
"craterMult"
"craterBoost"
"dynDamageExp"
"dynDamageMin"
"dynDamageRange"
"dynDamageInverted"
"craterAreaOfEffect"
"damageAreaOfEffect"
"edgeEffectiveness"
"explosionSpeed"
- or -
an armor type index to get the damage against it.

'''Spring.GetUnitWeaponVectors'''
( number unitID, number weaponNum ) -> nil | number posX, number posY, number posZ,
number dirX, number dirY, number dirZ

'''Spring.GetUnitWeaponTryTarget''' {{new|94.0}}
( number unitID, number weaponNum,
number targetID | number posX, number posY, number posZ ) -> nil | boolean success

'''Spring.GetUnitWeaponTestTarget''' {{new|94.0}}
( number unitID, number weaponNum,
number targetID | number posX, number posY, number posZ ) -> nil | boolean success

'''Spring.GetUnitWeaponTestRange''' {{new|94.0}}
( number unitID, number weaponNum,
number targetID | number posX, number posY, number posZ ) -> nil | boolean success

'''Spring.GetUnitWeaponHaveFreeLineOfFire''' {{new|94.0}}
( number unitID, number weaponNum,
number targetID | number posX, number posY, number posZ ) -> nil | boolean success

'''Spring.GetUnitWeaponCanFire''' {{new|95.0}}
( number unitID, number weaponNum ) -> nil | boolean canFire

'''Spring.GetUnitWeaponTarget''' {{new|95.0}}
( number unitID, number weaponNum ) -> nil |
number 0 | number 1, bool isUserTarget, number unitID |
number 2, bool isUserTarget, { number posX, number posY, number posZ } |
number 3, bool isUserTarget, number ProjectileID

'''Spring.GetRadarErrorParams''' {{new|95.0}}
(number allyTeamID) --> nil |
number allyteamErrorSize, number baseErrorSize, number baseErrorMult

'''Spring.GetUnitPosErrorParams''' {{new|95.0}}
(number unitID) --> nil |
number posErrorVector.x, number posErrorVector.y, number posErrorVector.z,
number posErrorDelta.x, number posErrorDelta.y, number posErrorDelta.z,
number nextPosErrorUpdate

=== Unit Pieces ===
'''Spring.GetUnitVectors'''
( number unitID ) -> nil | {frontX,frontY,frontZ}, {upX,upY,upZ}, {rightX,rightY,rightZ}
'''Spring.GetUnitPiecePosition'''
( number unitID, number piece ) -> number posx, number posy, number posz
Returns piece position in unit space. Also remember to multiply the x-axis value with -1 if you want move a piece to another piece.

'''Spring.GetUnitPieceDirection'''
( number unitID, number piece ) -> number dirx, number diry, number dirz
Consider this broken. It returns reverse direction in piece space (i.e. vertex(0)-vertex(1)) for pieces with >= 2 vertices and (1,1,1) for pieces with < 2 vertices)

'''Spring.GetUnitPieceMatrix'''
( number unitID, number piece ) -> { [1] = number, ... , [16] = number }
'''Spring.GetUnitPieceList'''
( number unitID ) -> { [1] = string "piecename", ... , [pieceNumN] = string "piecename" }
'''Spring.GetUnitPieceMap'''
( number unitID ) -> { "piecename1" = pieceNum1, ... , "piecenameN" = pieceNumN }
'''Spring.GetUnitPieceInfo'''
( number unitID, number piece ) -> {
"name" = string "piecename",
"isEmpty" = boolean,
"children" = { [1] = string "piecename", ... },
"min" = { [1] = number x, [2] = number y, [3] = number z },
"max" = { [1] = number x, [2] = number y, [3] = number z },
"offset" = { [1] = number x, [2] = number y, [3] = number z },
"parent" = string "parentpiecename",
}
"parent" field {{New|95.0}}

'''Spring.GetUnitScriptPiece'''
( number unitID [, number scriptPiece ] )
-> nil | { scriptPieceNum = number modelPieceNum } | number modelPieceNum

This functions translate the COB ScriptPiece numbers into the ModelPiece numbers (the set of ScriptPieces is a subset of the ModelPieces, means #ScriptPieces <= #ModelPieces), which is used in all other functions (the "number piece" means always the modelpiece). So if you get via Cob2Lua a pieceID you have to translate it with this function. Btw the COB ScriptPiece number is equal with the piece position in the piece definition in your cob/bos.

'''Spring.GetUnitScriptNames'''
( number unitID )
-> { "cobpiecename1" = ScriptPieceNum1, ... , "cobpiecenameN" = ScriptPieceNumN }
'''Spring.GetUnitPiecePosDir'''
( number unitID, number pieceNum ) -> nil | number posX, number posY, number posZ,
number dirX, number dirZ, number dirY
Returns piece position and direction in world space. The direction (dirX, dirY, dirZ) is not necessarily normalized. The position is defined as the position of the first vertex of the piece and it defines direction as the direction in which the line from the first vertex to the second vertex points.

=== CommandQueues ===
'''Spring.GetUnitCommands''' 
'''Spring.GetCommandQueue''' (Alias)
( number unitID, number count = 0 ) -> nil | number commandQueueSize {{new|96}}
( number unitID [, number count = -1] )
-> nil | table commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean,
"meta" = boolean
}
}, ...
}

This function can trigger an error if called too often without passing a second parameter. Refer to [https://github.com/spring/spring/blob/92c54d5b15775c39a8c67b203c28fe9b9db51cea/rts/Lua/LuaSyncedRead.cpp#L3983-L3996 LuaSyncedRead.cpp#L3983-L3996]

'''Spring.GetFullBuildQueue'''
( number unitID ) ->
nil | buildOrders = {
[1] = { [number unitDefID] = number count }, etc...
}
'''Spring.GetRealBuildQueue''' (cleans the buildqueue of things the unit can't build itself)
( number unitID ) ->
nil | buildOrders = {
[1] = { [number unitDefID] = number count }, etc...
}
'''Spring.GetFactoryCommands'''
( number unitID, number count = 0 ) -> nil | number commandQueueSize {{new|96}}
( number unitID [, number count = -1 ] )
-> nil | table commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean,
"meta" = boolean
}
}, ...
}

'''Spring.GetFactoryCounts''' (used to get the buildqueue of a factory, seems screwed o_O)
( number unitID [, number count [, boolean addCMDs ] ] ) -> nil | commandQueueTable = {
[2] = { [number unitDefID | number -cmdID] = number count }, ...
}

=== Command Descriptions/Buttons ===
'''Spring.GetUnitCmdDescs'''
( number unitID [, number startIndex [, number endIndex ] ] ) -> nil | {
[1] = {
"id" = number,
"type" = number,
"name" = string,
"action" = string,
"tooltip" = string,
"texture" = string,
"cursor" = string,
"hidden" = boolean,
"disabled" = boolean,
"showUnique" = boolean,
"onlyTexture" = boolean,

"params" = { [1] = string, ... }
}, ...
}
'''Spring.FindUnitCmdDesc'''
( number unitID, number cmdID ) -> nil | number index

== Features ==
=== GetFeatures ===
'''Spring.GetFeaturesInRectangle'''
( number xmin, number zmin, number xmax, number zmax )
-> featureTable = { [1] = number featureID, etc... }
'''Spring.GetFeaturesInSphere'''
( number x, number y, number z, number radius )
-> featureTable = { [1] = number featureID, etc... }
'''Spring.GetFeaturesInCylinder'''
( number x, number z, number radius )
-> featureTable = { [1] = number featureID, etc... }
'''Spring.GetAllFeatures'''
( ) -> { [1] = number featureID, ... }

=== Feature Informations ===
'''Spring.ValidFeatureID'''
( number featureID ) -> boolean
'''Spring.GetFeatureDefID'''
( number featureID ) -> nil | number featureDefID
'''Spring.GetFeatureTeam'''
( number featureID ) -> nil | number teamID
'''Spring.GetFeatureAllyTeam'''
( number featureID ) -> nil | number allyID
'''Spring.GetFeatureHealth'''
( number featureID ) -> nil | number health, number maxHealth, number resurrectProgress
'''Spring.GetFeatureHeight'''
( number featureID ) -> nil | number
'''Spring.GetFeatureRadius'''
( number featureID ) -> nil | number
'''Spring.GetFeaturePosition'''
( number featureID, [, boolean midPos [, boolean aimPos ] ] ) ->
nil |
number bpx, number bpy, number bpz [,
number mpx, number mpy, number mpz [,
number apx, number apy, number apz ]]
since 89.0, returns the base (default), middle or aim position of the feature.

'''Spring.GetFeatureVelocity''' {{new|95.0}}
( number featureID [, boolean norm] )
-> nil | number velx, number vely, number velz, number velLength

'''Spring.GetFeatureDirection'''
( number featureID ) -> nil | number dirx, number diry, number dirz
'''Spring.GetFeatureHeading'''
( number featureID ) -> nil | number heading
'''Spring.GetFeatureResources'''
( number featureID ) -> nil | number RemainingMetal, number maxMetal,
number RemainingEnergy, number maxEnergy, number reclaimLeft
'''Spring.GetFeatureNoSelect'''
( number featureID ) -> nil | boolean noSelect
'''Spring.GetFeatureResurrect'''
( number featureID ) -> nil | string UnitDefName, number buildFacing
'''Spring.GetFeatureCollisionVolumeData'''
( number featureID )
-> number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetZ,
number volumeType, number testType, number primaryAxis, boolean disabled

'''Spring.GetFeatureBlocking'''
(number featureID) --> boolean collidable, boolean crushable, boolean blocking
{{new|95.0}} Now return values are:
boolean isBlocking,
boolean isSolidObjectCollidable,
boolean isProjectileCollidable,
boolean isRaySegmentCollidable,
boolean crushable,
boolean blockEnemyPushing,
boolean blockHeightChanges

== COB ==
'''Spring.GetCOBUnitVar'''
( number unitID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBTeamVar'''
( number teamID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBAllyTeamVar'''
( number allyID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBGlobalVar'''
( integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY

== Ground ==
=== Ground Informations ===
Elevation is y. Water level is always at y=0. Ground height can be changed during play (terraform or deformation).

'''Spring.GetGroundHeight'''
( number x, number z ) -> number y
'''Spring.GetGroundOrigHeight'''
( number x, number z ) -> number y
'''Spring.GetGroundNormal'''
( number x, number z [, smoothedNormal] ) -> number x, number y, number z, number slope
{{new|100.0}}: smoothedNormal and slope

'''Spring.GetGroundInfo'''
( number x, number z ) -> string "Type", number metal, number hardness,
number tankSpeed, number kbotSpeed, number hoverSpeed,
number shipSpeed, boolean receiveTracks
'''Spring.GetGroundBlocked'''
( number x, number z |
number x1, number z1, number x2, number z2 )
-> nil | string "feature", number featureID | string "unit", number unitID
'''Spring.GetGroundExtremes'''
( ) -> nil | number minHeight, number maxHeight

'''Spring.GetSmoothMeshHeight'''
( number x, number z ) -> number y

'''Spring.GetMetalMapSize'''
( ) -> number sizeX, number sizeY

'''Spring.GetMetalAmount'''
( number x, number z ) -> number metalAmount
where x & z are in metal map coordinates (worldspace/16)

'''Spring.GetMetalExtraction'''
( number x, number z ) -> number extractionAmount
where x & z are in metal map coordinates (worldspace/16)

'''Spring.GetTerrainTypeData''' {{new|92.0}}
( number i )
-> nil | string "name", number hardness,
number tankSpeed, number kbotSpeed, number hoverSpeed, number shipSpeed,
boolean receiveTracks

=== Test Orders ===
'''Spring.TestMoveOrder'''
( number unitDefID, number x, number y, number z) -> boolean validMove
{{New|95.0}} parameters now are:
number unitDefID,
number pos.x, number pos.y, number pos.z
[, number dir.x
[, number dir.y
[, number dir.z
[, boolean testTerrain
[, boolean testObjects
[, boolean centerOnly ]]]]]]
) --> boolean

'''Spring.TestBuildOrder'''
( number unitDefID, number x, number y, number z, number facing)
-> number blocking [,number featureID]

blocking can be:
0 - blocked
1 - mobile unit in the way
2 - free (or if featureID is != nil then with a blocking feature that can be reclaimed)
facing can be:
0, "s", "south"
1, "e", "east"
2, "n", "north"
3, "w", "west"
'''Spring.Pos2BuildPos''' optional param ''facing'' supported in 0.83 and later
( number unitDefID, number x, number y, number z[, number facing] )
-> nil | number x, number y, number z

=== PathFinding ===
'''Spring.GetUnitEstimatedPath'''
( number unitID ) -> nil | {
[1] = { x,y,z }, ...
},{
[1] = startIdxOfDetailedPath,
[2] = startIdxOfDetailedEstimatedPath1,
[3] = startIdxOfDetailedEstimatedPath2,
}
GetUnitEstimatedPath() returns 2 tables:
1 table the waypoints and 1 table with indices (in the waypoint table)
when a new (more lazy) pathfinding algorithm begins.
So the waypoint table contains 3 different levels of details.

=== LOS ===
'''Spring.IsPosInLos'''
( number x, number y, number z, number allyID ) -> boolean
'''Spring.IsPosInRadar'''
( number x, number y, number z, number allyID ) -> boolean
'''Spring.IsPosInAirLos'''
( number x, number y, number z, number allyID ) -> boolean
'''Spring.GetPositionLosState''' jammed new in 95.0
( number x, number y, number z [, number allyID] )
-> boolean LosOrRadar, boolean inLos, boolean inRadar, boolean jammed
jammed indicates if a position is actively being radar- or sonar-jammed by '''any''' allyteam

'''Spring.GetClosestValidPosition''' //NOT FINISHED YET
( number unitDefID, number x, number z, number r ) -> nil

== Projectiles ==

'''Spring.GetProjectilesInRectangle'''

( number xmin, number zmin, number xmax, number zmax
[, boolean excludeWeaponProjectiles
[, boolean excludePieceProjectiles] ] )
-> nil | projectileTable = { [1] = number projectileID, etc... }

'''Spring.GetProjectileOwnerID''' {{new|99.0}}
(number projectileID) -> nil | number unitID

'''Spring.GetProjectileTeamID''' {{new|99.0}}
(number projectileID) -> nil | number teamID

'''Spring.GetProjectileDefID'''
(number projectileID) -> nil | number weaponDefID
using this to get a weaponDefID is HIGHLY preferred to indexing WeaponDefNames via GetProjectileName

'''Spring.GetProjectileName'''
( number projectileID ) -> nil | string name
'''Spring.GetProjectileType'''
( number projectileID ) -> nil | boolean weapon, boolean piece

'''Spring.GetProjectileTarget'''
( number projectileID )
Pre 95.0: -> nil | number targetID, string targetTypeStr
Post 95.0: -> nil | [number targetTypeInt, number targetID | table targetPos = {x, y, z}]

targetTypeStr can be one of:
'u' - unit
'f' - feature
'p' - projectile
while targetTypeInt is one of:
string.byte('g') := GROUND
string.byte('u') := UNIT
string.byte('f') := FEATURE
string.byte('p') := PROJECTILE

'''Spring.GetProjectileIntercepted''' {{new|99.0}}
( number projectileID ) -> nil | boolean isBeingIntercepted

'''Spring.GetProjectilePosition'''
( number projectileID ) -> nil | number px, number py, number pz
'''Spring.GetProjectileVelocity'''
( number projectileID ) -> nil | number vx, number vy, number vz
{{new|95.0}}: returns (targetPos - startPos) for Beamlasers and similar weapons

'''Spring.GetProjectileGravity'''
( number projectileID ) -> nil | number gravity

'''Spring.GetPieceProjectileParams''' {{new|95.0}}
( number projectileID ) -> nil | number explosionFlags, number spinAngle,
number spinSpeed, number spinVector.x, number spinVector.y, number spinVector.z
Where explosionFlags use binary flags with the following integer equivalents:
more info [http://springrts.com/wiki/Animation-CobConstants#explode here]
SHATTER = 1, EXPLODE = 2, EXPLODE_ON_HIT = 2, FALL = 4, SMOKE = 8, FIRE = 16
NONE = 32, NO_CEG_TRAIL = 64, NO_HEATCLOUD = 128 

'''Spring.GetProjectileTimeToLive''' {{new|99.0}}
( number projectileID ) -> nil | number ttl

'''Spring.GetProjectileDirection''' {{new|95.0}}
( number projectileID ) -> nil | number dir.x, number dir.y, number dir.z

'''Spring.GetProjectileSpinAngle''' Deprecated in 95.0
( number projectileID ) -> nil | number angle
'''Spring.GetProjectileSpinSpeed''' Deprecated in 95.0
( number projectileID ) -> nil | number spinSpeed
'''Spring.GetProjectileSpinVec''' Deprecated in 95.0
( number projectileID ) -> nil | number x, number y, number z

'''Spring.GetProjectileDamages''' {{new|101.0}}
( number unitID, number weaponNum, string tag ) -> nil | number
`tag` can be:
"paralyzeDamageTime"
"impulseFactor"
"impulseBoost"
"craterMult"
"craterBoost"
"dynDamageExp"
"dynDamageMin"
"dynDamageRange"
"dynDamageInverted"
"craterAreaOfEffect"
"damageAreaOfEffect"
"edgeEffectiveness"
"explosionSpeed"
- or -
an armor type index to get the damage against it.

[[category: Lua]]

Lua SyncedCtrl

2016-01-15T21:35:20Z

Hokomoko: /* Unit Control */

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

= Game End =
'''Spring.KillTeam''' {{new|83.0}}
( number teamID ) -> nil
Will declare a team to be dead ( no further orders can be assigned to such teams's units ), Gaia team cannot be killed.

'''Spring.GameOver''' {{new|83.0}}
( {number allyTeamID1, number allyTeamID2, ...} ) -> nil
Will declare game over, a list of winning allyteams can be passed, if undecided ( like when dropped from the host ) it should be empty ( no winner ), in the case of a draw with multiple winners, all should be listed

= RulesParams =
string values are new since 95.0

'''Spring.SetUnitRulesParam'''
( number unitID, string paramName, number|string paramValue [, table losAccess] ) -> nil
possible keys for the losAccess table are:
`private` : only readable by the ally (default)
`allied` : readable by ally + ingame allied
`inlos` : readable if the unit is in LOS
`inradar` : readable if the unit is in AirLOS
`public` : readable by all
note: if one condition is fulfilled all beneath it are too (e.g. if an unit is in LOS it can read params with `inradar=true` even if the param has `inlos=false`)
note2: all GameRulesParam are public, TeamRulesParams can just be `private`,`allied` and/or `public`
note3: You can read RulesParams from '''any''' Lua enviroments! With those losAccess policies you can limit their access.

'''Spring.SetTeamRulesParam'''
( number teamID, string paramName, number|string paramValue [, table losAccess] ) -> nil
see above for further documentation of losAccess

'''Spring.SetGameRulesParam'''
( string paramName, number|string paramValue [, table losAccess] ) -> nil
see above for further documentation of losAccess

= Resources =
'''Spring.AddTeamResource'''
( number teamID, string "metal" | "energy", number amount ) -> nil
'''Spring.UseTeamResource'''
( number teamID,
string "metal" | "energy",number amount |
{ metal = number amount, energy = number amount}
) -> nil | boolean hadEnough

'''Spring.SetTeamResource'''
( number teamID, string res, number amount ) -> nil

possible values for res are:
"m" = metal
"e" = energy
"ms" = metal storage
"es" = energy storage


'''Spring.SetTeamShareLevel'''
( number teamID, string "metal" | "energy", number amount ) -> nil

'''Spring.ShareTeamResource''' 0.82 and later
( number teamID_src, number teamID_recv, string "metal" | "energy", number amount ) -> nil

= Teams =
'''Spring.SetAlly''' {{new|98.0}}
( number firstAllyTeamID, number secondAllyTeamID, boolean ally ) -> nil

Changes the value of the (one-sided) alliance between: firstAllyTeamID -> secondAllyTeamID


'''Spring.AssignPlayerToTeam''' {{new|98.0}} {{Sourcelinkhash|7ed9a7e34814c60e5ae16281520cccc4daf3c367}}
( number playerID, number teamID)

= Unit Handling =
'''Spring.CreateUnit''' note: offmap positions are clamped! (you still can use MoveCtrl todo so)
( string "defName" | number unitDefID,
number x, number y, number z,
(number facing | string "facing"),
number teamID
[, boolean build = false]
[, boolean flattenGround = true]
[, number unitID]
[, number builderID]) -> number unitID | nil (meaning unit was not created)

possible values for facing are:
"south" | "s" | 0
"east" | "e" | 1
"north" | "n" | 2
"west" | "w" | 3
if build is true the unit is created in "being built" state, with buildProgress = 0
unitID and builderID are {{new|92.0}}, the former allowing to spawn a unit with
a specific ID.


'''Spring.DestroyUnit'''
( number unitID
[, boolean selfd = false]
[, boolean reclaimed = false]
[, number attackerID ] ) -> nil

selfd := makes the unit act like it self-destructed
reclaimed := don't show any DeathSequences, don't leave a wreckage.
NOTE this does _not_ give back the resources to the team!


'''Spring.TransferUnit'''
( number unitID,
numer newTeamID
[, boolean given = true ] ) -> nil
if given=false, the unit is captured

== Unit Control ==
'''Spring.SetUnitCosts'''
( number unitID, {
[ buildTime = number amount ],
[ metalCost = number amount ],
[ energyCost = number amount ]
} ) -> nil

'''Spring.SetUnitTooltip'''
( number unitID, string "tooltip" ) -> nil

'''Spring.SetUnitHealth'''
( number unitID,
number health |
{ [ health = number health ],
[ capture = number capture ],
[ paralyze = number paralyze ],
[ build = number build ] }
) -> nil

'''Spring.SetUnitMaxHealth'''
( number unitID, number maxHealth ) -> nil

'''Spring.AddUnitDamage'''
( number unitID, number damage
[, number paralyze = 0 [, number attackerID = -1 [, number weaponID = -1
[, number impulse_x [, number impulse_y [, number impulse_z ]]] ]]] ) -> nil

'''Spring.SetUnitStockpile'''
( number unitID [, number stockpile [, number buildPercent ]]) -> nil

'''Spring.SetUnitExperience'''
( number unitID, number experience ) -> nil

'''Spring.SetUnitFuel'''
( number unitID, number fuel ) -> nil

'''Spring.SetUnitCrashing''' {{new|83.0}}
( number unitID, boolean crashing ) -> boolean success

'''Spring.SetUnitLineage''' Removed from version 83.0 
( number unitID, number teamID [, boolean isRoot] ) -> nil

'''Spring.SetUnitNeutral'''
( number unitID, boolean neutral ) -> nil

'''Spring.SetUnitTarget''' userTarget & success new in version 95.0, setting nil target new in 99.0
( number unitID,
number enemyUnitID | number x, number y, number z, | nil,
[ boolean dgun = false ], [ boolean userTarget = false ] ) -> success

'''Spring.SetUnitMaxRange'''
( number unitID, number maxRange ) -> nil

'''Spring.SetUnitBlocking''' crushable new in version 85.0
( number unitID, boolean blocking [, boolean collide [, boolean crushable]] ) -> nil

'''Spring.SetUnitBlocking''' {{new|95.0}} changed parameters:
number unitID,
boolean isBlocking,
boolean isSolidObjectCollidable,
boolean isProjectileCollidable,
boolean isRaySegmentCollidable,
boolean crushable,
boolean blockEnemyPushing,
boolean blockHeightChanges

'''Spring.SetUnitMetalExtraction'''
( number unitID, number depth [,number range] ) -> nil

'''Spring.SetUnitBuildSpeed'''
( number builderID,
number buildSpeed, [ number repairSpeed [, number reclaimSpeed
[,number resurrectSpeed [, number captureSpeed [, number terraformSpeed ]] ]]] ) -> nil

'''Spring.SetUnitNanoPieces''' {{new|92.0}}
( number builderID, table pieces ) -> nil
This saves a lot of engine calls, by replacing:
function script.QueryNanoPiece() return currentpiece end
Use it!

'''Spring.SetUnitPieceParent''' {{new|101.0}}
( number unitID, number AlteredPiece, number ParentPiece ) -> nil
Changes the pieces hierarchy of a unit, by attaching a piece to a new parent.

'''Spring.SetUnitArmored''' armorMultiple new in version 0.83.x
( number unitID, boolean armored [, number armorMultiple] ) -> nil

'''Spring.SetUnitShieldState'''
( number unitID [, number weaponID = -1] [, boolean enabled] [, number power] ) -> nil

'''Spring.SetUnitFlanking'''
( number unitID, string "mode", number mode ) -> nil
( number unitID, string "moveFactor", number factor) -> nil
( number unitID, string "minDamage", number minDamage ) -> nil
( number unitID, string "mazDamage", number maxDamage ) -> nil
( number unitID, string "dir", number x, number y, number z) -> nil

'''Spring.SetUnitWeaponState'''
( number unitID, number weaponNum, table states ) -> nil
( number unitID, number weaponNum, string key, number value ) -> nil
format of the states table:
{
["reloadState" = number value,]
["reloadFrame" = number value,] (synonym for reloadState!)
["reloadTime" = number value,]
["accuracy" = number value,]
["sprayAngle" = number value,]
["range" = number value,]
["projectileSpeed" = number value,]
["burst" = number value,]
["burstRate" = number value,]
["projectiles" = number value,]
["aimReady" = number value,] (<>0.0f := true)
}


'''Spring.SetUnitWeaponDamages''' {{new|101.0}}
( number unitID, number weaponNum | "selfDestruct" | "explode", table damages ) -> nil
( number unitID, number weaponNum | "selfDestruct" | "explode", string key, number value ) -> nil
format of the damages table:
{
["paralyzeDamageTime" = number value,]
["impulseFactor" = number value,]
["impulseBoost" = number value,]
["craterMult" = number value,]
["craterBoost" = number value,]
["dynDamageExp" = number value,]
["dynDamageMin" = number value,]
["dynDamageRange" = number value,]
["dynDamageInverted" = number value,] (<>0.0f := true)
["craterAreaOfEffect" = number value,]
["damageAreaOfEffect" = number value,]
["edgeEffectiveness" = number value,]
["explosionSpeed" = number value,]
[number armorType = number value,] (changes the damage against this armor type)
}


'''Spring.SetUnitCollisionVolumeData'''
( number unitID, number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetX,
number vType, number tType, number Axis
) -> nil
enum COLVOL_TYPES {
COLVOL_TYPE_DISABLED = -1,
COLVOL_TYPE_ELLIPSOID = 0,
COLVOL_TYPE_CYLINDER,
COLVOL_TYPE_BOX,
COLVOL_TYPE_SPHERE,
COLVOL_NUM_TYPES // number of non-disabled collision volume types
};
enum COLVOL_TESTS {
COLVOL_TEST_DISC = 0,
COLVOL_TEST_CONT = 1,
COLVOL_NUM_TESTS = 2 // number of tests
};
enum COLVOL_AXES {
COLVOL_AXIS_X = 0,
COLVOL_AXIS_Y = 1,
COLVOL_AXIS_Z = 2,
COLVOL_NUM_AXES = 3 // number of collision volume axes
};


'''Spring.SetUnitPieceCollisionVolumeData'''
( number unitID, number pieceIndex, boolean enable,
number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetZ
[, number volumeType [, number primaryAxis]]
) -> nil

'''Spring.SetUnitTravel'''
( number unitID, number travel [, number travelPeriod] ) -> nil

'''Spring.SetUnitMoveGoal''' used by default commands to get in build-,attackrange etc.
(number unitID, number goalx, number goaly, number goalz
[, number goalRadius [, number moveSpeed [, bool moveRaw ]]] )
{{new|98.0}} moveRaw: [http://springrts.com/mantis/view.php?id=4412 allow unit to dumbly move to a coordinate without calculating path.]

'''Spring.SetUnitPhysics''' drag new in version 95.0
( number unitID,
number posx, number posy, number posz,
number velx, number vely, number velz,
number rotx, number roty, number rotz,
number dragx, number dragy, number dragz,
) -> nil

'''Spring.SetUnitPosition'''
( number unitID, number x, number z [, boolean alwaysAboveSea] ) -> nil

'''Spring.SetUnitDirection''' {{new|90.0}}
( number unitID, number x, number y, number z ) -> nil

'''Spring.SetUnitVelocity'''
( number unitID, number velx, number vely, number velz ) -> nil

'''Spring.SetUnitRotation'''
( number unitID, number rotx, number roty, number rotz ) -> nil

'''Spring.AddUnitImpulse'''
( number unitID, number x, number y, number z [, decayRate ] ) -> nil

'''Spring.AddUnitSeismicPing'''
( number unitID, number pingSize ) -> nil

'''Spring.RemoveBuildingDecal'''
( number unitID ) -> nil

'''Spring.SetUnitMidAndAimPos''' {{new|89.0}}
( number unitID,
number mpx, number mpy, number mpz,
number apx, number apy, number apz,
[, boolean relative] ) -> boolean success


mpx, mpy, mpz: new middle position of unit

apx, apy, apz: new position that enemies aim at on this unit

relative: are the new coordinates relative to world or unit coordinates?


'''Spring.SetUnitRadiusAndHeight''' {{new|89.0}}
( number unitID, number radius, number height ) -> boolean success

'''Spring.UnitWeaponFire'''
( number unitID, number weaponID ) -> nil
'''Spring.UnitWeaponHoldFire'''
( number unitID, number weaponID ) -> nil

== Unit LOS ==
'''Spring.SetUnitCloak'''
( number unitID,
boolean cloaked | number scriptCloak,
[ number decloakDistance | boolean decloakAbs ] ) -> nil


If the 2nd argument is a number, the value works like this:
1:=normal cloak
2:=for free cloak (cost no E)
3:=for free + no decloaking (except the unit is stunned)
4>=ultimative cloak (no ecost, no decloaking, no stunned decloak)

The decloak distance is only changed if the 3th argument is a number or a boolean.
If the boolean is false it takes the default decloak distance for that unitdef,
if the boolean is true it takes the absolute value of it.

'''Spring.SetUnitSonarStealth'''
( number unitID, boolean sonarStealth ) -> nil

'''Spring.SetUnitStealth'''
( number unitID, boolean stealth ) -> nil

'''Spring.SetUnitAlwaysVisible'''
( number unitID, boolean alwaysVisible ) -> nil

'''Spring.SetUnitLosMask'''
( number unitID, number allyTeam, number los | table losTypes ) -> nil
the 3th argument is either the bit-and combination of the following numbers:
LOS_INLOS = 1
LOS_INRADAR = 2
LOS_PREVLOS = 4
LOS_CONTRADAR = 8
or a table of the following form:
losTypes = {
[los = boolean,]
[radar = boolean,]
[prevLos = boolean,]
[contRadar = boolean,]
}

'''Spring.SetUnitLosState'''
( number unitID, number allyTeam, number los | table losTypes ) -> nil
see above for more info on the arguments

'''Spring.SetUnitSensorRadius'''
( number unitID, string type, number radius ) -> nil | number newRadius
type can be:
"los","airLos","radar","sonar","seismic","radarJammer","sonarJammer"

'''Spring.SetRadarErrorParams''' {{new|95.0}}
(number allyTeamID, number allyteamErrorSize
[, number baseErrorSize [, number baseErrorMult ]]) -> nil

'''Spring.SetUnitPosErrorParams''' {{new|95.0}}
(number unitID, number posErrorVector.x, number posErrorVector.y, number posErrorVector.z,
number posErrorDelta.x, number posErrorDelta.y, number posErrorDelta.z
[ , number nextPosErrorUpdate]) --> nil

== Unit Resourcing ==
'''Spring.SetUnitResourcing'''
( number unitID,
string res, number amount |
{ res = number amount, ... }
) -> nil

possible values for res are: "[u|c][u|m][m|e]"
unconditional | conditional
use | make
metal | energy


'''Spring.AddUnitResource'''
( number unitID, string "m" | "e", number amount ) -> nil

'''Spring.UseUnitResource'''
( number unitID, string "m" | "e", number amount ) -> nil | boolean okay
( number unitID, { ["m" | "metal" | "e" | "energy"] = amount, ... } ) -> nil | boolean okay

'''Spring.SetUnitHarvestStorage''' {{new|97.0}}
( number unitid, number metal )

See also {{xtaglink|Gamedev:UnitDefs|harvestStorage}} UnitDef tag.

= Feature Handling =
'''Spring.CreateFeature'''
( string "defName" | number featureDefID,
number x, number y, number z
[, number heading
[, number AllyTeamID
[, number featureID ]]] ) -> number featureID

'''Spring.DestroyFeature'''
( number featureID ) -> nil

'''Spring.TransferFeature'''
( number featureID, number teamID ) -> nil

== Feature Control ==
'''Spring.SetFeatureHealth'''
( number featureID, number health) -> nil

'''Spring.SetFeatureReclaim'''
( number featureID, number reclaimLeft) -> nil

'''Spring.SetFeatureResurrect'''
( number featureID, string "UnitDefName?" [, number facing | string "facing" ] ) -> nil

possible values for facing are:
"south" | "s" | 0
"east" | "e" | 1
"north" | "n" | 2
"west" | "w" | 3


'''Spring.SetFeaturePosition'''
( number featureID, number x, number y, number z [, boolean snapToGround]) -> nil

'''Spring.SetFeatureDirection'''
( number featureID, number x, number y, number z ) -> nil

'''Spring.SetFeatureVelocity''' {{New|95.0}}

'''Spring.SetFeaturePhysics''' {{New|95.0}}

(like their feature counterparts at [[Lua_SyncedCtrl#Unit_Control]])

'''Spring.SetFeatureNoSelect'''
( number featureID, boolean noSelect ) -> nil

'''Spring.SetFeatureAlwaysVisible'''
( number featureID, boolean enable ) -> nil

'''Spring.SetFeatureCollisionVolumeData'''
( number featureID, number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetX,
number vType, number tType, number Axis
) -> nil
check Spring.SetUnitCollisionVolumeData for further explanation of the arguments

'''Spring.SetFeatureMidAndAimPos''' {{new|89.0}}
( number unitID,
number mpx, number mpy, number mpz,
number apx, number apy, number apz,
[, boolean relative] ) -> boolean success

check Spring.SetUnitMidAndAimPos for further explanation of the arguments

'''Spring.SetFeatureRadiusAndHeight''' {{new|89.0}}
( number unitID, number radius, number height ) -> boolean success

'''Spring.SetFeatureBlocking'''
(number featureID, boolean blocking, boolean collidable) --> boolean

'''Spring.SetFeatureBlocking''' {{new|95.0}} changed parameters:
number featureID,
boolean isBlocking,
boolean isSolidObjectCollidable,
boolean isProjectileCollidable,
boolean isRaySegmentCollidable,
boolean crushable,
boolean blockEnemyPushing,
boolean blockHeightChanges

= Lua to COB =
'''Spring.CallCOBScript'''
( number unitID, number funcID | string funcName, number retArgs, COBArg1, COBArg2, ... )
-> nil | number returnValue, number retArg1, number retArg2, ...

'''Spring.CallCOBScriptCB''' 
broken in 0.78.2.1; will be removed with the introduction of Lua as COB replacement
( number unitID, number funcID | string funcName, number retArgs, COBArg1, COBArg2, ... )
-> nil | number returnValue, number CallbackData, number retArg1, number retArg2, ...

'''Spring.GetCOBScriptID'''
( number unitID, string funcName ) -> nil | number funcID

Note: Don't use Spring.[Get|Set]UnitCOBValue in LUS just because you are familar with it since bos/cob, use the mighty LuaSpringAPI instead!

'''Spring.GetUnitCOBValue'''
( number unitID [, boolean splitData=false], number COBValue
[, number param1 [,number param2 [, number param3 [, number param4 ] ] ] ] )
-> number result | number result1, number result2
you find the possible values for `COBValue` in [[Lua_ConstCOB#Get.2FSet|Lua_ConstCOB]]
 also see [[Animation-CobConstants#Custom_Variables|Custom_Variables]]

'''Spring.SetUnitCOBValue'''
( number unitID, number COBValue, number param1 [,number param2] ) -> nil
you find the possible values for `COBValue` in [[Lua_ConstCOB#Get.2FSet|Lua_ConstCOB]]
 also see [[Animation-CobConstants#Custom_Variables|Custom_Variables]]

= Give Order =
options can also be a bitmask; e.g. 0 instead of an empty table (can avoid performance hit on table creation) 
see [[Lua CMDs]] for relevant constants


'''Spring.GiveOrderToUnit'''
( number unitID,
number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"} ) -> nil

'''Spring.GiveOrderToUnitMap'''
( unitMap = { [unitID] = dontCare, etc... },
number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"} ) -> nil

'''Spring.GiveOrderToUnitArray'''
( unitArray = { [1] = unitID, etc... },
number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"} ) -> nil

'''Spring.GiveOrderArrayToUnitMap'''
( unitMap = { [number unitID] = dontCare, etc... },
orderArray = {
{ number cmdID,
{number, etc...}, params
{"alt", "ctrl", "shift", "right"} options
}, ..
}
) -> nil

'''Spring.GiveOrderArrayToUnitArray'''
( unitArray = { [1] = number unitID, etc... },
orderArray = {
{ number cmdID,
{number, etc...}, params
{"alt", "ctrl", "shift", "right"} options
}, ..
}
) -> nil

=Ground=
== Grass ==
'''Spring.AddGrass'''
( number x, number z ) -> nil

'''Spring.RemoveGrass'''
( number x, number z ) -> nil

== Heightmap ==
Note that x & z coords are in worldspace (Game.mapSizeX/Z), still the heightmap resolution is Game.squareSize.

'''Spring.LevelHeightMap'''
( number x1, number z1 [, number x2, number z2], number height ) -> nil

'''Spring.AdjustHeightMap''' (heightmap[x][z] += height;)
( number x1, number z1 [, number x2, number z2], number height ) -> nil

'''Spring.RevertHeightMap'''
( number x1, number z1 [, number x2, number z2], number origFactor ) -> nil

'''Spring.SetHeightMapFunc'''
( lua_function [, arg1 ,[ arg2 [, ... ] ] ) -> nil | number absTotalHeightMapAmountChanged
Example code:<code><pre>
Spring.SetHeightMapFunc(function()
for z=0,Game.mapSizeZ, Game.squareSize do
for x=0,Game.mapSizeX, Game.squareSize do
Spring.SetHeightMap( x, z, 200 + 20 * math.cos((x + z) / 90) )
end
end
end)
</pre></code>
'''Spring.AddHeightMap''' can only be called in SetHeightMapFunc()
( number x, number z, number height ) -> nil | number newHeight
'''Spring.SetHeightMap''' can only be called in SetHeightMapFunc()
( number x, number z, number height [,number terraform = 1] ) -> nil | number absHeightDiff
the terraform argument is a scaling factor:
so if 0 nothing will be changed (the terraform starts) and if it is 1 the terraform will be finished.

'''Spring.LevelSmoothMesh'''
( number x1, number z1 [, number x2, number z2], number height ) -> nil
'''Spring.AdjustSmoothMesh'''
( number x1, number z1 [, number x2, number z2], number height ) -> nil
'''Spring.RevertSmoothMesh'''
( number x1, number z1 [, number x2, number z2], number origFactor ) -> nil

'''Spring.SetSmoothMeshFunc'''
( lua_function [, arg1 ,[ arg2 [, ... ] ] ) -> nil | number absTotalHeightMapAmountChanged
'''Spring.AddSmoothMesh''' can only be called in SetSmoothMeshFunc()
( number x, number z, number height ) -> nil | number newHeight
'''Spring.SetSmoothMesh''' can only be called in SetSmoothMeshFunc()
( number x, number z, number height [,number terraform = 1] ) -> nil | number absHeightDiff

== TerrainTypes ==
'''Spring.SetMapSquareTerrainType'''
( number x, number z, int newType ) -> nil | int oldType
'''Spring.SetTerrainTypeData'''
( int typeIndex
[, number speedTanks = nil ]
[, number speedKBOTs = nil ]
[, number speedHovers = nil ]
[, number speedShips = nil ] ) -> nil | boolean true

== MetalAmount ==
'''Spring.SetMetalAmount''' {{new|83.0}}
( number x, number z, number metalAmount)
x & z coords are in worldspace/16 metalAmount must be between 0 and 255*maxMetal (with maxMetal from the .smd or mapinfo.lua)

= Command Descriptions =
Doesn't work in unsynced code! 

'''Spring.EditUnitCmdDesc'''
( number unitID, number cmdDescID, table cmdArray ) -> nil

structure of cmdArray:
{
[ id = int ],
[ type = int ],
[ name = string ],
[ action = string ],
[ tooltip = string ],
[ texture = string ],
[ cursor = string ],
[ hidden = boolean ],
[ disabled = boolean ],
[ showUnique = boolean ],
[ onlyTexture = boolean ],
[ params = { string = string, ... } ]
}


'''Spring.InsertUnitCmdDesc'''
( number unitID [, number cmdDescID ] , table cmdArray ) -> nil

'''Spring.RemoveUnitCmdDesc'''
( number unitID [, number cmdDescID ] ) -> nil

= Other =
'''Spring.SetNoPause'''
( boolean noPause ) -> nil

'''Spring.SetUnitToFeature'''
( boolean tofeature ) -> nil

an ugly global switch that can be used to block units turning into features when they finish being built (like *A DT's do, which have the isFeature tag)
[http://springrts.com/phpbb/viewtopic.php?f=14&p=481521 thread]


'''Spring.SetExperienceGrade'''
( number expGrade
[, number ExpPowerScale [, number ExpHealthScale [, number ExpReloadScale ]]] ) -> nil

expGrade defines how often UnitExperience() will be called,
it is based on the following equation:
(int) [exp/(exp+1)] / expGrade
If this integer differs from the one before the experience change
it will call UnitExperience().
Also those 3 last params are only available in .cheat


'''Spring.SpawnCEG'''
( string "cegname" | number cegID,
number posX = 0, number posY = 0, number posZ = 0,
number dirX = 0, number dirY = 0, number dirZ = 0,
number radius = 0, number damage = 0
) -> nil | boolean success, cegID
cegID new in 95.0

= Projectiles =
'''Spring.SpawnProjectile'''
( number weaponDefID, table projectileParams ) -> nil | number projectileID
possible keys of projectileParams are:
pos = {number x, number y, number z},
end = {number x, number y, number z},
speed = {number x, number y, number z},
spread = {number x, number y, number z},
error = {number x, number y, number z},
owner = number,
team = number,
ttl = number,
gravity = number,
tracking = number,
maxRange = number,
startAlpha = number,
endAlpha = number,
model = string,
cegTag = string,


'''Spring.SetProjectileTarget'''

Pre 95.0: ( number projectileID,
[ number targetID, string targetTypeStr ] | [ number posX, number posY, number posZ ] )
-> nil | boolean validTarget

Post 95.0: ( number projectileID,
[ number targetID [, number targetType]] | [number posX, number posY, number posZ])
--> nil | boolean validTarget
targetTypeStr can be one of:
'u' - unit
'f' - feature
'p' - projectile
while targetTypeInt is one of:
string.byte('g') := GROUND
string.byte('u') := UNIT
string.byte('f') := FEATURE
string.byte('p') := PROJECTILE

'''Spring.SetProjectileIsIntercepted''' {{new|99.0}}
( number projID ) -> nil

'''Spring.SetProjectileMoveControl''' (disables engine movecontrol, so lua can fully control the physics)
( number projID, boolean enable ) -> nil
'''Spring.SetProjectilePosition'''
( number projID [, number x = 0 [, number y = 0 [, number z = 0 ]]] ) -> nil
'''Spring.SetProjectileVelocity'''
( number projID [, number x = 0 [, number y = 0 [, number z = 0 ]]] ) -> nil
'''Spring.SetProjectileCollision'''
( number projID ) -> nil
'''Spring.SetProjectileGravity'''
( number projID [, number grav = 0] ) -> nil
'''Spring.SetProjectileSpinAngle''' {{new|95.0}} Deprecated
( number projID [, number spinAngle = 0] ) -> nil
'''Spring.SetProjectileSpinSpeed''' {{new|95.0}} Deprecated
( number projID [, number speed = 0] ) -> nil
'''Spring.SetProjectileSpinVec''' {{new|95.0}} Deprecated
( number projID [, number x = 0 [, number y = 0 [, number z = 0]]] ) -> nil
'''Spring.SetProjectileCEG'''
( number projID, string ceg_name ) -> nil

'''Spring.SetPieceProjectileParams''' {{new|95.0}}
(number projectileID,
[ number explosionFlags, [ number spinAngle, [ number spinSpeed,
[ number spinVector.x, [ number spinVector.y, [ number spinVector.z ]]]]]]) --> nil

'''Spring.SetProjectileAlwaysVisible''' {{new|95.0}}
(number projectileID, boolean alwaysVisible) --> nil

'''Spring.SetProjectileDamages''' {{new|101.0}}
( number unitID, number weaponNum, table damages ) -> nil
( number unitID, number weaponNum, string key, number value ) -> nil
format of the damages table:
{
["paralyzeDamageTime" = number value,]
["impulseFactor" = number value,]
["impulseBoost" = number value,]
["craterMult" = number value,]
["craterBoost" = number value,]
["dynDamageExp" = number value,]
["dynDamageMin" = number value,]
["dynDamageRange" = number value,]
["dynDamageInverted" = number value,] (<>0.0f := true)
["craterAreaOfEffect" = number value,]
["damageAreaOfEffect" = number value,]
["edgeEffectiveness" = number value,]
["explosionSpeed" = number value,]
[number armorType = number value,] (changes the damage against this armor type)
}


[[category: Lua]]

Lua SyncedRead

2016-01-14T12:46:11Z

Hokomoko: /* Unit Weapon Informations */

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

== Game ==

=== Special TeamID Variables ===
(those special TeamIDs are not supported by all functions) 
'''Spring.ALL_UNITS''' 
'''Spring.MY_UNITS''' 
'''Spring.ALLY_UNITS''' 
'''Spring.ENEMY_UNITS'''

'''Spring.GetGaiaTeamID'''
( ) -> number teamID

=== GameStates ===
'''Spring.IsGodModeEnabled'''
( ) -> boolean
'''Spring.IsCheatingEnabled'''
( ) -> boolean
'''Spring.IsDevLuaEnabled'''
( ) -> boolean
'''Spring.IsEditDefsEnabled'''
( ) -> boolean
'''Spring.AreHelperAIsEnabled'''
( ) -> boolean
'''Spring.FixedAllies'''
( ) -> nil | boolean

'''Spring.IsGameOver'''
( ) -> boolean

=== RulesParams ===
Those functions allow to save data per Game,Team and Unit. The advantage of it is that it can be read from anywhere (even from LuaUI and AIs!) 
string values are new since 95.0

'''Spring.GetRulesInfoMap''' REMOVED in 0.82!
( ) -> { [key1] = string value1, [key2] = string value2, ... }
( string "key" ) -> string

'''Spring.GetGameRulesParam'''
( number ruleIndex | string ruleName ) -> nil | number value | string value
'''Spring.GetGameRulesParams'''
( ) -> nil | { [ruleIndex1] = {[ruleName1] = number | string value1}, ... }

'''Spring.GetTeamRulesParam'''
( number teamID, number index | string ruleName ) -> nil | number value | string value
'''Spring.GetTeamRulesParams'''
( number teamID ) -> nil | { [ruleIndex1] = {[ruleName1] = number | string value1}, ... }

'''Spring.GetUnitRulesParam'''
( number unitID, number index | string ruleName ) -> nil | number value | string value
'''Spring.GetUnitRulesParams'''
( number unitID ) -> nil | { [ruleIndex1] = {[ruleName1] = number | string value1}, ... }

=== Mod-/Map-Options ===
'''Spring.GetModOptions'''
( ) -> {} | { "keyName1" = string "value", "keyName2" = string "value", ... }
'''Spring.GetMapOptions'''
( ) -> {} | { "keyName1" = string "value", "keyName2" = string "value", ... }

! bool values are not transfered from C to Lua correctly, so in IF theres needed to use this condition: 
"if (tonumber(Spring.GetModOptions.exampleOption) == 1) then...end" 
not only: 
"if (Spring.GetModOptions.exampleOption) then...end"

=== Speed/Time ===
'''Spring.GetGameSpeed''' As of 98.0 moved to [[Lua_UnsyncedRead]] due to desyncs in replays/demos
( ) -> number userSpeedFactor, number speedFactor, boolean paused
'''Spring.GetGameFrame'''
( ) -> number frameNum%dayFrames, number frameNum/dayFrames
'''Spring.GetGameSeconds'''
( ) -> number seconds

=== Vectors ===
'''Spring.GetWind'''
( ) -> number dirX, number dirY, number dirZ,
number strength, number normDirX, number normDirY, number normDirZ

'''Spring.GetHeadingFromVector'''
( number x, number z ) -> number heading
'''Spring.GetVectorFromHeading'''
( number heading ) -> number x, number z

== Sides/Factions ==
'''Spring.GetSideData'''
( string sideName ) -> nil | string startUnit, string caseSensitiveSideName
( number sideID ) -> nil | string sideName, string startUnit, string caseSensitiveSideName
( ) -> { [1] = { sideName=string,caseName=string,startUnit=string}, [2] = .., .. }

== Teams ==
=== StartBoxes/StartPositions ===
'''Spring.GetAllyTeamStartBox'''
( number allyID ) -> nil | number xmin, number zmin, number xmax, number zmax
'''Spring.GetTeamStartPosition'''
( number teamID ) -> nil | number x, number y, number z

=== Player,Team,Ally Lists/Info ===
'''Spring.GetPlayerList'''
( [number teamID = -1 | boolean onlyActive = false] [, number teamID | boolean onlyActive])
-> nil | { [1] = number playerID, etc... }
'''Spring.GetTeamList'''
( [number allyTeamID = -1] ) -> nil | { [1] = number teamID, etc... }
'''Spring.GetAllyTeamList'''
( ) -> { [1] = number allyTeamID, etc... }

'''Spring.GetPlayerInfo'''
( number playerID ) ->
nil | string "name", (PRE-83.0: in synced code this is "SYNCED_NONAME"!)
boolean active,
boolean spectator,
number teamID,
number allyTeamID,
number pingTime,
number cpuUsage,
string country,
number rank
table customPlayerKeys
'''Spring.GetPlayerControlledUnit'''
( number playerID ) -> nil | number unitID

'''Spring.GetAIInfo'''
( number teamID ) ->
number skirmishAIID,
string name,
number hostingPlayerID,
string shortName, (synced => "SYNCED_NOSHORTNAME"; non-local => "UNKNOWN")
string version, (synced => "SYNCED_NOVERSION"; non-local => "UNKNOWN")
table options (synced & non-local => empty-table)
Note: Before 0.82, the first argument was teamID, and then every other argument with a shifted position.

'''Spring.GetAllyTeamInfo'''
( number allyteamID ) -> nil | table customTeamKeys

'''Spring.GetTeamInfo'''
( number teamID ) ->
nil | number teamID,
number leader, (:= a player id)
boolean isDead,
boolean isAiTeam,
string "side",
number allyTeam,
table customTeamKeys,
number incomeMultiplier
'''Spring.GetTeamResources'''
( number teamID, string "metal" | "energy" ) ->
nil | number currentLevel,
number storage,
number pull,
number income,
number expense,
number share,
number sent,
number received
'''Spring.GetTeamUnitStats'''
( number teamID ) ->
nil | number killed,
number died,
number capturedBy,
number capturedFrom,
number received,
number sent
'''Spring.GetTeamResourceStats''' 0.82 and later
( number teamID, string "metal" | "energy" ) ->
nil | number used,
number produced,
number excessed,
number received,
number sent
'''Spring.GetTeamStatsHistory'''
( number teamID [, number startIndex [, number endIndex = startIndex ]]) ->
nil |
number cur_max_index |
{
[1] = {
"time" = number,
"frame" = number,
"metalUsed" = number,
"metalProduced" = number,
"metalExcess" = number,
"metalReceived" = number,
"metalSent" = number,
"energyUsed" = number,
"energyProduced" = number,
"energyExcess" = number,
"energyReceived" = number,
"energySent" = number,
"damageDealt" = number,
"damageReceived" = number,
"unitsProduced" = number,
"unitsDied" = number,
"unitsReceived" = number,
"unitsSent" = number,
"unitsCaptured" = number,
"unitsOutCaptured" = number,
"unitsKilled" = number
}, ...
}
if called with just teamID as argument it returns the current possible range for startIndex/endIndex :={1..cur_max_index}

'''Spring.GetTeamLuaAI'''
( number teamID ) -> string "luaAI"

Returns string containing name of AI defined in file LuaAI.lua as name="<AI name>". Maybe it returns whole table with all values there, so maybe depends, but in my LuaAI.lua name is on first position...

=== Teams/PlayersAllied ===
'''Spring.AreTeamsAllied'''
( number teamID1, number teamID2 ) -> nil | boolean
'''Spring.ArePlayersAllied'''
( number playerID1, number playerID2 ) -> nil | boolean

== Units ==
=== GetUnits ===
'''Spring.GetAllUnits'''
( ) -> nil | unitTable = { [1] = number unitID, ... }
'''Spring.GetTeamUnits'''
( number teamID ) -> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetTeamUnitsSorted'''
( number teamID ) -> nil |
unitDefTable = {
[number unitDefID] = { [1] = [number unitID], etc... },
etc...
}
'''Spring.GetTeamUnitsCounts'''
( number teamID ) -> nil | countTable = { [number unitDefID] = count, etc... }
'''Spring.GetTeamUnitsByDefs'''
( number teamID, number unitDefID | { number unitDefID1, ... } )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetTeamUnitDefCount'''
( number teamID, number unitDefID ) -> nil | number count
'''Spring.GetTeamUnitCount'''
( number teamID ) -> nil | number count

'''Spring.GetUnitsInRectangle'''
( number xmin, number zmin, number xmax, number zmax [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInBox'''
( number xmin, number ymin, number zmin,
number xmax, number ymax, number zmax [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInSphere'''
( number x, number y, number z, number radius [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInCylinder'''
( number x, number z, number radius [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInPlanes'''
( planes = { [1] = { number nx, number ny, number nz, number d }, etc... } )
-> nil | unitTable = { [1] = number unitID, etc... }

plane normals point towards accepted space,
so the acceptance criteria for each plane is:
radius = unit radius
px, py, pz = unit position
[(nx * px) + (ny * py) + (nz * pz) + (d - radius)] <= 0


'''Spring.GetUnitNearestAlly'''
( number unitID [, number range ] ) -> nil | number unitID
'''Spring.GetUnitNearestEnemy'''
( number unitID [, number range [, bool useLOS]] ) -> nil | number unitID

Post 95.0 this no longer returns neutral units

=== Unit Informations ===
'''Spring.ValidUnitID'''
( number unitID ) -> boolean
'''Spring.GetUnitIsDead'''
( number unitID ) -> nil | boolean
Returns false if unit exists and is alive, true for a brief period of time after unit dies, nil otherwise 
keep this in mind when using (not Spring.GetUnitIsDead())

'''Spring.GetUnitTooltip'''
( number unitID ) -> nil | string tooltip
'''Spring.GetUnitDefID'''
( number unitID ) -> nil | number unitDefID
'''Spring.GetUnitTeam'''
( number unitID ) -> nil | number teamID
'''Spring.GetUnitAllyTeam'''
( number unitID ) -> nil | number allyID
'''Spring.GetUnitLineage''' Removed from version 0.83.x 
( number unitID ) -> nil | number lineage | number lineage, boolean lineageIsRoot
'''Spring.GetUnitNeutral'''
( number unitID ) -> nil | boolean neutral
'''Spring.GetUnitHealth'''
( number unitID ) -> nil | number health, number maxHealth, number paralyzeDamage,
number captureProgress, number buildProgress
build Progress is returned as floating Point between 0.0 and 1.0

'''Spring.GetUnitArmored''' armorMultiple new in version 0.83.x
( number unitID ) -> nil | boolean armored, number armorMultiple
'''Spring.GetUnitIsStunned'''
( number unitID ) -> nil | boolean stunned_or_inbuild, boolean stunned, boolean inbuild
'''Spring.GetUnitMaxRange'''
( number unitID ) -> nil | number maxEngagementRange
'''Spring.GetUnitResources'''
( number unitID ) -> nil | number metalMake, number metalUse,
number energyMake, number energyUse
'''Spring.GetUnitHarvestStorage'''
( number unitID ) -> nil | number metal
See also {{xtaglink|Gamedev:UnitDefs|harvestStorage}} UnitDef tag.

'''Spring.GetUnitMetalExtraction''' 0.82+ and later
( number unitID ) -> nil | number
'''Spring.GetUnitExperience'''
( number unitID ) -> nil | number experience
'''Spring.GetUnitStates'''
( number unitID ) -> nil | {
"firestate" = number,
"movestate" = number,
"repeat" = boolean,
"cloak" = boolean,
"active" = boolean,
"trajectory" = boolean,
["autoland" = boolean,]
["autorepairlevel" = number,]
["loopbackattack" = boolean]
}
'''Spring.GetUnitIsActive'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitIsCloaked'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitSelfDTime'''
( number unitID ) -> nil | number
'''Spring.GetUnitStockpile'''
( number unitID ) -> nil | number numStockpiled, number numStockpileQued,
number buildPercent
'''Spring.GetUnitHeight'''
( number unitID ) -> nil | number
'''Spring.GetUnitRadius'''
( number unitID ) -> nil | number
'''Spring.GetUnitBlocking''' {{new|85.0}}
( number unitID ) -> nil | boolean blocking, boolean crushable
{{new|95.0}} Now return values are:
boolean isBlocking,
boolean isSolidObjectCollidable,
boolean isProjectileCollidable,
boolean isRaySegmentCollidable,
boolean crushable,
boolean blockEnemyPushing,
boolean blockHeightChanges

'''Spring.GetUnitPosition'''
( number unitID, [, boolean midPos [, boolean aimPos ] ] ) ->
nil |
number bpx, number bpy, number bpz
[, number mpx, number mpy, number mpz ]
[, number apx, number apy, number apz ]
since 89.0, returns the base (default), middle or aim position of the unit.

'''Spring.GetUnitBasePosition''' Deprecated in 89.0, use GetUnitPosition
( number unitID ) -> nil | number x, number y, number z
returns the bottom of the unit.

'''Spring.GetUnitDirection'''
( number unitID ) -> nil | number dx, number dy, number dz
returns the direction vector

'''Spring.GetUnitHeading'''
( number unitID ) -> nil | number heading
returns heading directions used in COB scripts

'''Spring.GetUnitRotation''' {{New|95.0}}
(number unitID) --> nil | number pitch, number yaw, number roll
Marked as (WIP) in changelog

'''Spring.GetUnitVelocity''' velw new in 95.0
( number unitID ) -> nil | number velx, number vely, number velz, number velLength
'''Spring.GetUnitBuildFacing'''
( number unitID ) -> nil | number
'''Spring.GetUnitIsBuilding''' returns what unit a constructor/factory is currently building
( number unitID ) -> nil | number unitID
'''Spring.GetUnitCurrentBuildPower''' {{new|92.0}}
( number unitID ) -> nil | number buildPower
'''Spring.GetUnitNanoPieces'''
( number unitID ) -> nil | { [1] = number piece1, etc ... }
'''Spring.GetUnitTransporter'''
( number unitID ) -> nil | number unitID
'''Spring.GetUnitIsTransporting'''
( number unitID ) -> nil | { [1] = number unitID, etc... }
'''Spring.GetUnitShieldState'''
( number unitID [, number weaponID = -1] ) -> nil | number isEnabled, number curPower
'''Spring.GetUnitTravel'''
( number unitID ) -> nil | number travel, number travelPeriod
'''Spring.GetUnitFuel'''
( number unitID ) -> nil | number
'''Spring.GetUnitFlanking'''
( number unitID, string "dir" ) -> nil | number x, number y, number z
( number unitID, string "mode" | "moveFactor" | "minDamage" | "maxDamage" ) -> nil | number
( number unitID ) -> nil | number mode, number modilityAdd,
number minDamage, number maxDamage, number dirX, number dirY, number dirZ
'''Spring.GetUnitSensorRadius'''
( number unitID, string type ) -> nil | number radius
possible types are: los, airLos, radar, sonar, seismic, radarJammer & sonarJammer

'''Spring.GetUnitLosState''' raw is only available in gadgets
( number unitID [, number allyTeamID [, boolean raw] ] ) -> nil | number raw |
{ ["los" = true] [, "radar" = true] [, "typed" = true] }
'''Spring.GetUnitSeparation''' surfaceDist new in 95.0
( number unitID1, number unitID2 [, boolean 2D] [, boolean surfaceDist] ) -> nil | number distance
returns the distance of 2 units, surfaceDist calculates the distance between the unitsphere surfaces instead of their midpos

'''Spring.GetUnitDefDimensions'''
( number unitDefID ) -> nil |
{
"height" = number,
"radius" = number,
"midx" = number,
"minx" = number,
"maxx" = number,
"midy" = number,
"miny" = number,
"maxy" = number,
"midz" = number,
"minz" = number,
"maxz" = number
}
'''Spring.GetUnitLastAttacker'''
( number unitID ) -> nil | number unitID
'''Spring.GetUnitLastAttackedPiece''''
( number unitID ) -> nil | string pieceName, number gameframe
'''Spring.GetUnitMoveTypeData''' new in version 0.80+
( number unitID ) -> nil | { movetype data }
'''Spring.GetUnitCollisionVolumeData'''
( number unitID )
-> number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetZ,
number volumeType, number testType, number primaryAxis, boolean disabled
'''Spring.GetUnitPieceCollisionVolumeData'''
( number unitID, number pieceID )
-> number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetZ,
number volumeType, number testType, number primaryAxis, boolean disabled

==== Unit Weapon Informations ====
'''Spring.GetUnitWeaponState'''
( number unitID, number weaponNum ) -> nil |
boolean angleGood, boolean loaded, number reloadFrame, number salvoLeft, number numStockpiled
( number unitID, number weaponNum, string tag ) -> nil | number
`tag` can be:
"reloadState" == "reloadFrame"
"reloadTime"
"accuracy"
"sprayAngle"
"range"
"projectileSpeed"
"burst"
"burstRate"
"projectiles"

'''Spring.GetUnitWeaponDamages''' {{new|101.0}}
( number unitID, number weaponNum, string tag ) -> nil | number
`tag` can be:
"paralyzeDamageTime"
"impulseFactor"
"impulseBoost"
"craterMult"
"craterBoost"
"dynDamageExp"
"dynDamageMin"
"dynDamageRange"
"dynDamageInverted"
"craterAreaOfEffect"
"damageAreaOfEffect"
"edgeEffectiveness"
"explosionSpeed"
- or -
an armor type index to get the damage against it.

'''Spring.GetUnitWeaponVectors'''
( number unitID, number weaponNum ) -> nil | number posX, number posY, number posZ,
number dirX, number dirY, number dirZ

'''Spring.GetUnitWeaponTryTarget''' {{new|94.0}}
( number unitID, number weaponNum,
number targetID | number posX, number posY, number posZ ) -> nil | boolean success

'''Spring.GetUnitWeaponTestTarget''' {{new|94.0}}
( number unitID, number weaponNum,
number targetID | number posX, number posY, number posZ ) -> nil | boolean success

'''Spring.GetUnitWeaponTestRange''' {{new|94.0}}
( number unitID, number weaponNum,
number targetID | number posX, number posY, number posZ ) -> nil | boolean success

'''Spring.GetUnitWeaponHaveFreeLineOfFire''' {{new|94.0}}
( number unitID, number weaponNum,
number targetID | number posX, number posY, number posZ ) -> nil | boolean success

'''Spring.GetUnitWeaponCanFire''' {{new|95.0}}
( number unitID, number weaponNum ) -> nil | boolean canFire

'''Spring.GetUnitWeaponTarget''' {{new|95.0}}
( number unitID, number weaponNum ) -> nil |
number 0 | number 1, bool isUserTarget, number unitID |
number 2, bool isUserTarget, { number posX, number posY, number posZ } |
number 3, bool isUserTarget, number ProjectileID

'''Spring.GetRadarErrorParams''' {{new|95.0}}
(number allyTeamID) --> nil |
number allyteamErrorSize, number baseErrorSize, number baseErrorMult

'''Spring.GetUnitPosErrorParams''' {{new|95.0}}
(number unitID) --> nil |
number posErrorVector.x, number posErrorVector.y, number posErrorVector.z,
number posErrorDelta.x, number posErrorDelta.y, number posErrorDelta.z,
number nextPosErrorUpdate

=== Unit Pieces ===
'''Spring.GetUnitVectors'''
( number unitID ) -> nil | {frontX,frontY,frontZ}, {upX,upY,upZ}, {rightX,rightY,rightZ}
'''Spring.GetUnitPiecePosition'''
( number unitID, number piece ) -> number posx, number posy, number posz
Returns piece position in unit space. Also remember to multiply the x-axis value with -1 if you want move a piece to another piece.

'''Spring.GetUnitPieceDirection'''
( number unitID, number piece ) -> number dirx, number diry, number dirz
Consider this broken. It returns reverse direction in piece space (i.e. vertex(0)-vertex(1)) for pieces with >= 2 vertices and (1,1,1) for pieces with < 2 vertices)

'''Spring.GetUnitPieceMatrix'''
( number unitID, number piece ) -> { [1] = number, ... , [16] = number }
'''Spring.GetUnitPieceList'''
( number unitID ) -> { [1] = string "piecename", ... , [pieceNumN] = string "piecename" }
'''Spring.GetUnitPieceMap'''
( number unitID ) -> { "piecename1" = pieceNum1, ... , "piecenameN" = pieceNumN }
'''Spring.GetUnitPieceInfo'''
( number unitID, number piece ) -> {
"name" = string "piecename",
"isEmpty" = boolean,
"children" = { [1] = string "piecename", ... },
"min" = { [1] = number x, [2] = number y, [3] = number z },
"max" = { [1] = number x, [2] = number y, [3] = number z },
"offset" = { [1] = number x, [2] = number y, [3] = number z },
"parent" = string "parentpiecename",
}
"parent" field {{New|95.0}}

'''Spring.GetUnitScriptPiece'''
( number unitID [, number scriptPiece ] )
-> nil | { scriptPieceNum = number modelPieceNum } | number modelPieceNum

This functions translate the COB ScriptPiece numbers into the ModelPiece numbers (the set of ScriptPieces is a subset of the ModelPieces, means #ScriptPieces <= #ModelPieces), which is used in all other functions (the "number piece" means always the modelpiece). So if you get via Cob2Lua a pieceID you have to translate it with this function. Btw the COB ScriptPiece number is equal with the piece position in the piece definition in your cob/bos.

'''Spring.GetUnitScriptNames'''
( number unitID )
-> { "cobpiecename1" = ScriptPieceNum1, ... , "cobpiecenameN" = ScriptPieceNumN }
'''Spring.GetUnitPiecePosDir'''
( number unitID, number pieceNum ) -> nil | number posX, number posY, number posZ,
number dirX, number dirZ, number dirY
Returns piece position and direction in world space. The direction (dirX, dirY, dirZ) is not necessarily normalized. The position is defined as the position of the first vertex of the piece and it defines direction as the direction in which the line from the first vertex to the second vertex points.

=== CommandQueues ===
'''Spring.GetUnitCommands''' 
'''Spring.GetCommandQueue''' (Alias)
( number unitID, number count = 0 ) -> nil | number commandQueueSize {{new|96}}
( number unitID [, number count = -1] )
-> nil | table commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean,
"meta" = boolean
}
}, ...
}

This function can trigger an error if called too often without passing a second parameter. Refer to [https://github.com/spring/spring/blob/92c54d5b15775c39a8c67b203c28fe9b9db51cea/rts/Lua/LuaSyncedRead.cpp#L3983-L3996 LuaSyncedRead.cpp#L3983-L3996]

'''Spring.GetFullBuildQueue'''
( number unitID ) ->
nil | buildOrders = {
[1] = { [number unitDefID] = number count }, etc...
}
'''Spring.GetRealBuildQueue''' (cleans the buildqueue of things the unit can't build itself)
( number unitID ) ->
nil | buildOrders = {
[1] = { [number unitDefID] = number count }, etc...
}
'''Spring.GetFactoryCommands'''
( number unitID, number count = 0 ) -> nil | number commandQueueSize {{new|96}}
( number unitID [, number count = -1 ] )
-> nil | table commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean,
"meta" = boolean
}
}, ...
}

'''Spring.GetFactoryCounts''' (used to get the buildqueue of a factory, seems screwed o_O)
( number unitID [, number count [, boolean addCMDs ] ] ) -> nil | commandQueueTable = {
[2] = { [number unitDefID | number -cmdID] = number count }, ...
}

=== Command Descriptions/Buttons ===
'''Spring.GetUnitCmdDescs'''
( number unitID [, number startIndex [, number endIndex ] ] ) -> nil | {
[1] = {
"id" = number,
"type" = number,
"name" = string,
"action" = string,
"tooltip" = string,
"texture" = string,
"cursor" = string,
"hidden" = boolean,
"disabled" = boolean,
"showUnique" = boolean,
"onlyTexture" = boolean,

"params" = { [1] = string, ... }
}, ...
}
'''Spring.FindUnitCmdDesc'''
( number unitID, number cmdID ) -> nil | number index

== Features ==
=== GetFeatures ===
'''Spring.GetFeaturesInRectangle'''
( number xmin, number zmin, number xmax, number zmax )
-> featureTable = { [1] = number featureID, etc... }
'''Spring.GetFeaturesInSphere'''
( number x, number y, number z, number radius )
-> featureTable = { [1] = number featureID, etc... }
'''Spring.GetFeaturesInCylinder'''
( number x, number z, number radius )
-> featureTable = { [1] = number featureID, etc... }
'''Spring.GetAllFeatures'''
( ) -> { [1] = number featureID, ... }

=== Feature Informations ===
'''Spring.ValidFeatureID'''
( number featureID ) -> boolean
'''Spring.GetFeatureDefID'''
( number featureID ) -> nil | number featureDefID
'''Spring.GetFeatureTeam'''
( number featureID ) -> nil | number teamID
'''Spring.GetFeatureAllyTeam'''
( number featureID ) -> nil | number allyID
'''Spring.GetFeatureHealth'''
( number featureID ) -> nil | number health, number maxHealth, number resurrectProgress
'''Spring.GetFeatureHeight'''
( number featureID ) -> nil | number
'''Spring.GetFeatureRadius'''
( number featureID ) -> nil | number
'''Spring.GetFeaturePosition'''
( number featureID, [, boolean midPos [, boolean aimPos ] ] ) ->
nil |
number bpx, number bpy, number bpz [,
number mpx, number mpy, number mpz [,
number apx, number apy, number apz ]]
since 89.0, returns the base (default), middle or aim position of the feature.

'''Spring.GetFeatureVelocity''' {{new|95.0}}
( number featureID [, boolean norm] )
-> nil | number velx, number vely, number velz, number velLength

'''Spring.GetFeatureDirection'''
( number featureID ) -> nil | number dirx, number diry, number dirz
'''Spring.GetFeatureHeading'''
( number featureID ) -> nil | number heading
'''Spring.GetFeatureResources'''
( number featureID ) -> nil | number RemainingMetal, number maxMetal,
number RemainingEnergy, number maxEnergy, number reclaimLeft
'''Spring.GetFeatureNoSelect'''
( number featureID ) -> nil | boolean noSelect
'''Spring.GetFeatureResurrect'''
( number featureID ) -> nil | string UnitDefName, number buildFacing
'''Spring.GetFeatureCollisionVolumeData'''
( number featureID )
-> number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetZ,
number volumeType, number testType, number primaryAxis, boolean disabled

'''Spring.GetFeatureBlocking'''
(number featureID) --> boolean collidable, boolean crushable, boolean blocking
{{new|95.0}} Now return values are:
boolean isBlocking,
boolean isSolidObjectCollidable,
boolean isProjectileCollidable,
boolean isRaySegmentCollidable,
boolean crushable,
boolean blockEnemyPushing,
boolean blockHeightChanges

== COB ==
'''Spring.GetCOBUnitVar'''
( number unitID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBTeamVar'''
( number teamID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBAllyTeamVar'''
( number allyID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBGlobalVar'''
( integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY

== Ground ==
=== Ground Informations ===
Elevation is y. Water level is always at y=0. Ground height can be changed during play (terraform or deformation).

'''Spring.GetGroundHeight'''
( number x, number z ) -> number y
'''Spring.GetGroundOrigHeight'''
( number x, number z ) -> number y
'''Spring.GetGroundNormal'''
( number x, number z [, smoothedNormal] ) -> number x, number y, number z, number slope
{{new|100.0}}: smoothedNormal and slope

'''Spring.GetGroundInfo'''
( number x, number z ) -> string "Type", number metal, number hardness,
number tankSpeed, number kbotSpeed, number hoverSpeed,
number shipSpeed, boolean receiveTracks
'''Spring.GetGroundBlocked'''
( number x, number z |
number x1, number z1, number x2, number z2 )
-> nil | string "feature", number featureID | string "unit", number unitID
'''Spring.GetGroundExtremes'''
( ) -> nil | number minHeight, number maxHeight

'''Spring.GetSmoothMeshHeight'''
( number x, number z ) -> number y

'''Spring.GetMetalMapSize'''
( ) -> number sizeX, number sizeY

'''Spring.GetMetalAmount'''
( number x, number z ) -> number metalAmount
where x & z are in metal map coordinates (worldspace/16)

'''Spring.GetMetalExtraction'''
( number x, number z ) -> number extractionAmount
where x & z are in metal map coordinates (worldspace/16)

'''Spring.GetTerrainTypeData''' {{new|92.0}}
( number i )
-> nil | string "name", number hardness,
number tankSpeed, number kbotSpeed, number hoverSpeed, number shipSpeed,
boolean receiveTracks

=== Test Orders ===
'''Spring.TestMoveOrder'''
( number unitDefID, number x, number y, number z) -> boolean validMove
{{New|95.0}} parameters now are:
number unitDefID,
number pos.x, number pos.y, number pos.z
[, number dir.x
[, number dir.y
[, number dir.z
[, boolean testTerrain
[, boolean testObjects
[, boolean centerOnly ]]]]]]
) --> boolean

'''Spring.TestBuildOrder'''
( number unitDefID, number x, number y, number z, number facing)
-> number blocking [,number featureID]

blocking can be:
0 - blocked
1 - mobile unit in the way
2 - free (or if featureID is != nil then with a blocking feature that can be reclaimed)
facing can be:
0, "s", "south"
1, "e", "east"
2, "n", "north"
3, "w", "west"
'''Spring.Pos2BuildPos''' optional param ''facing'' supported in 0.83 and later
( number unitDefID, number x, number y, number z[, number facing] )
-> nil | number x, number y, number z

=== PathFinding ===
'''Spring.GetUnitEstimatedPath'''
( number unitID ) -> nil | {
[1] = { x,y,z }, ...
},{
[1] = startIdxOfDetailedPath,
[2] = startIdxOfDetailedEstimatedPath1,
[3] = startIdxOfDetailedEstimatedPath2,
}
GetUnitEstimatedPath() returns 2 tables:
1 table the waypoints and 1 table with indices (in the waypoint table)
when a new (more lazy) pathfinding algorithm begins.
So the waypoint table contains 3 different levels of details.

=== LOS ===
'''Spring.IsPosInLos'''
( number x, number y, number z, number allyID ) -> boolean
'''Spring.IsPosInRadar'''
( number x, number y, number z, number allyID ) -> boolean
'''Spring.IsPosInAirLos'''
( number x, number y, number z, number allyID ) -> boolean
'''Spring.GetPositionLosState''' jammed new in 95.0
( number x, number y, number z [, number allyID] )
-> boolean LosOrRadar, boolean inLos, boolean inRadar, boolean jammed
jammed indicates if a position is actively being radar- or sonar-jammed by '''any''' allyteam

'''Spring.GetClosestValidPosition''' //NOT FINISHED YET
( number unitDefID, number x, number z, number r ) -> nil

== Projectiles ==

'''Spring.GetProjectilesInRectangle'''

( number xmin, number zmin, number xmax, number zmax
[, boolean excludeWeaponProjectiles
[, boolean excludePieceProjectiles] ] )
-> nil | projectileTable = { [1] = number projectileID, etc... }

'''Spring.GetProjectileOwnerID''' {{new|99.0}}
(number projectileID) -> nil | number unitID

'''Spring.GetProjectileTeamID''' {{new|99.0}}
(number projectileID) -> nil | number teamID

'''Spring.GetProjectileDefID'''
(number projectileID) -> nil | number weaponDefID
using this to get a weaponDefID is HIGHLY preferred to indexing WeaponDefNames via GetProjectileName

'''Spring.GetProjectileName'''
( number projectileID ) -> nil | string name
'''Spring.GetProjectileType'''
( number projectileID ) -> nil | boolean weapon, boolean piece

'''Spring.GetProjectileTarget'''
( number projectileID )
Pre 95.0: -> nil | number targetID, string targetTypeStr
Post 95.0: -> nil | [number targetTypeInt, number targetID | table targetPos = {x, y, z}]

targetTypeStr can be one of:
'u' - unit
'f' - feature
'p' - projectile
while targetTypeInt is one of:
string.byte('g') := GROUND
string.byte('u') := UNIT
string.byte('f') := FEATURE
string.byte('p') := PROJECTILE

'''Spring.GetProjectileIntercepted''' {{new|99.0}}
( number projectileID ) -> nil | boolean isBeingIntercepted

'''Spring.GetProjectilePosition'''
( number projectileID ) -> nil | number px, number py, number pz
'''Spring.GetProjectileVelocity'''
( number projectileID ) -> nil | number vx, number vy, number vz
{{new|95.0}}: returns (targetPos - startPos) for Beamlasers and similar weapons

'''Spring.GetProjectileGravity'''
( number projectileID ) -> nil | number gravity

'''Spring.GetPieceProjectileParams''' {{new|95.0}}
( number projectileID ) -> nil | number explosionFlags, number spinAngle,
number spinSpeed, number spinVector.x, number spinVector.y, number spinVector.z
Where explosionFlags use binary flags with the following integer equivalents:
more info [http://springrts.com/wiki/Animation-CobConstants#explode here]
SHATTER = 1, EXPLODE = 2, EXPLODE_ON_HIT = 2, FALL = 4, SMOKE = 8, FIRE = 16
NONE = 32, NO_CEG_TRAIL = 64, NO_HEATCLOUD = 128 

'''Spring.GetProjectileTimeToLive''' {{new|99.0}}
( number projectileID ) -> nil | number ttl

'''Spring.GetProjectileDirection''' {{new|95.0}}
( number projectileID ) -> nil | number dir.x, number dir.y, number dir.z

'''Spring.GetProjectileSpinAngle''' Deprecated in 95.0
( number projectileID ) -> nil | number angle
'''Spring.GetProjectileSpinSpeed''' Deprecated in 95.0
( number projectileID ) -> nil | number spinSpeed
'''Spring.GetProjectileSpinVec''' Deprecated in 95.0
( number projectileID ) -> nil | number x, number y, number z

'''Spring.GetProjectileDamages''' {{new|101.0}}
( number unitID, number weaponNum, string tag ) -> nil | number
`tag` can be:
"paralyzeDamageTime"
"impulseFactor"
"impulseBoost"
"craterMult"
"craterBoost"
"dynDamageExp"
"dynDamageMin"
"dynDamageRange"
"dynDamageInverted"
"craterAreaOfEffect"
"damageAreaOfEffect"
"edgeEffectiveness"
"explosionSpeed"
- or -
an armor type index to get the damage against it.

[[category: Lua]]