Spring - User contributions [en]

Animation-LuaCallins

2011-02-02T11:11:52Z

Seanheron: added hint regarding severity (which I'd just stumbled over myself)

== Introduction ==

Call-ins are calls from the engine, into the unit script. In other words, these functions are called, if they are defined, when a particular â€œeventâ€ happens.

For Lua unit scripts, a new callin mechanism has been implemented, which is faster than the regular callin mechanism which is used for widgets and gadgets.

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

* unitID: number
* piece: number
* axis: number (1 = x axis, 2 = y axis, 3 = z axis)
* heading/pitch: number (radians)

== Generic ==

'''Create''' ( ) -> nil

This is called just after the unit script has been created.

'''StartMoving''' ( ) -> nil 
'''StopMoving''' ( ) -> nil

These are called whenever the unit starts or stops moving. Typical use for them is to trigger wheels to start spinning, animate treads, or start/stop a walking animation.

'''Killed''' ( number recentDamage, number maxHealth ) -> number corpseType

This is called when the unit is killed. The severity of the kill may be calculated as severity=recentDamage/maxHealth ''(*100 so that it's in percent, no? at least that is how severity was expressed in Cob/bos, I think. Of course there's no reason to emulate that, just pointing it out for people "converting")''. Typically, this function would play a death animation for the unit, and finally return a corpse type.

'''WindChanged''' ( number heading, number strength ) -> nil

This is called for wind generators whenever the wind direction or strength changes.

'''ExtractionRateChanged''' ( number rate ) -> nil

Called for metal extractors each time their extraction rate (metal per second) changes.

'''setSFXoccupy''' ( number curTerrainType ) -> nil

Called when terrain type changes. Terrain type is calculated with the following rules (in this order):

* If unit is being transported -> curTerrainType = 0
* If ground height < -5 and unit is always upright -> curTerrainType = 2
* If ground height < -5 and unit is not always upright -> curTerrainType = 1
* If ground height < 0 and unit is always upright -> curTerrainType = 1
* Otherwise -> curTerrainType = 4

Where is curTerrainType = 3 ? :-)

Candidate to be changed to something saner later on.

'''MoveRate''' ( number curRate ) -> nil

Called only for certain types of aircraft (those which use ''CTAAirMoveType''.) The move rate is determined by the following rules (in this order):

* If the aircraft is landing or taking off -> curRate = 1
* Otherwise -> curRate = floor(curSpeed / maxSpeed * 3), clamped to be in the range [0, 2]

'''QueryLandingPads''' ( ) -> { number piece1, number piece2, ... }

Called one time for units with landing pads. Should return a table with pieces which should be used as landing pads. The number of pieces returned also determines the number of pads, so for Lua unit scripts there is no QueryLandingPadCount.

'''Activate''' ( ) -> nil 
'''Deactivate''' ( ) -> nil

Exact situation these are called depends a lot on the unit type. Factories are activated when they open their yard and deactivated when they close it. Aircraft are activated when they take off and deactivated when the land. Any unit that can be turned on or off is activated when it's turned on and deactivated when it's turned off. On ''SetUnitValue(COB.ACTIVATION, ...)'' one of these call-ins may be called too.

== Weapons ==

Weapon functions come in two variants.

* Separate function with numeric weapon number suffix. (e.g. ''AimWeapon1(heading, pitch)'')
* Combined function which gets weapon number as second argument. (e.g. ''AimWeapon(weaponNum, heading, pitch)'')

Only the first variant is listed here, so whenever you see a function whose name ends with a numeric one ("1"), you should either replace it with the actual weapon number, or you can write a single combined function that takes a ''weaponNum'' argument. For each script, all functions should use the same variant. Either all using name suffix, or all using combined functions.

'''QueryWeapon1''' ( ) -> number piece 
'''AimFromWeapon1''' ( ) -> number piece 
'''AimWeapon1''' ( heading, pitch ) -> boolean 
'''AimShield1''' ( ) -> boolean

Weapon support. The return value of QueryWeapon and AimFromWeapon determines the pieces which will be used for aiming: typically e.g. the barrel for QueryWeapon and the turret for AimFromWeapon. AimWeapon is then called to allow the script to turn the weapons in the target direction, which is passed as the heading and pitch argument (in radians). Only if AimWeapon returns true, the weapon is actually fired.

TODO: better explanation (?), note about AimWeapon being called very often etc.

'''FireWeapon1''' ( ) -> nil 
'''Shot1''' ( ) -> nil 
'''EndBurst1''' ( ) -> nil

If after aiming the unit actually fires it's weapon, FireWeapon is called once at the beginning of the salvo. Shot is called just before each projectile is fired. RockUnit (see below) is called just after all projectiles for that frame have been fired. At the end of the salvo, EndBurst is called.

Of these call-ins, FireWeapon is the more generic one and Shot and EndBurst are more specialized. FireWeapon is usually used to play a recoil animation or emit some smoke near the weapon's barrel using EmitSfx.

'''BlockShot1''' ( targetUnitID, boolean userTarget ) -> boolean

Allows you to block a weapon from shooting. TargetUnitID may be nil: in this case the unit has a ground-attack order.

'''TargetWeight1''' ( targetUnitID ) -> number

Allows you to tweak the priority of the target for this particular weapon. The target priority is multiplied by the return value of this function. Lower priority targets are targeted first, so return a value smaller than 1 to prioritize a target, or return a value larger than 1 to avoid a target.

The exact behavior of specific values shouldn't be relied upon.

'''RockUnit''' ( x, z ) -> nil

A bit like the weapon-specific FireWeapon function, although this is called after any weapon fires. As argument it gets a two dimensional vector in the direction the unit just fired. This may be used to â€œrockâ€ the unit as a whole a bit as part of the firing animation. Note though that this vector is in world space, so for a truly realistic rock direction it needs to be rotated according to the unit's current heading.

'''HitByWeapon''' ( x, z, weaponDefID, damage ) -> nil | number newDamage

This is called if a unit has been hit by a weapon. (x, z) is the direction from which the projectile came in unit space (the reverse direction of the impulse, to be exact.) It also gets the weaponDefID of the weapon which is dealing the damage, and the amount of damage. If HitByWeapon returns a number, this number will replace the damage value calculated by the engine.

Note: these call-in runs just before the LuaRules UnitPreDamaged callin (see also [[LuaCallinReturn]]). If HitByWeapon overrides the damage, UnitPreDamaged will see the new damage value, and may override again the damage value.

== Builders and factories ==

'''StartBuilding''' ( heading, pitch ) -> nil 
'''StartBuilding''' ( ) -> nil 
'''StopBuilding''' ( ) -> nil

These notify the script when a builder or factory starts or stops building.

The first variant (with heading and pitch arguments) is called for builders. For factories, the second variant is used. In this case the heading and pitch are not necessary, because the factory script specifies the build location itself using QueryBuildInfo.

BTW, don't forget to set INBUILDSTANCE to 1 to start building! For lua script, that is

<code>
function script.StartBuilding(heading, pitch)

SetUnitValue(COB.INBUILDSTANCE, 1)

end

function script.StopBuilding()
SetUnitValue(COB.INBUILDSTANCE, 0)
end
</code>

'''QueryBuildInfo''' ( ) -> number piece

For factories only. Should return the piece to which the unit which is going to be build will be attached while it's being build.

'''QueryNanopiece''' ( ) -> number piece

Called each time a nano particle is to be created. Should return the piece at which the particle will be spawned. This may be used to iterate through a few pieces, to simulate the factory/builder having multiple nanolathes.

== Transports ==

There are some different code paths inside Spring related to transports, each (unfortunately) also associated with a different set of unit script call-ins.

This table shows for the three different transportUnloadMethods for both air transports and ground transports which callins are used and roughly when and how often they are called. Refer to the documentation below for a description of the call-ins.

The entire behavior around transports should be considered subject to change; it is obvious it is far from a perfect design currently.

{|border="1" style="border-spacing:0px;"
|+
!
!Load
!UnloadLand (0)
!UnloadDrop (1)
!UnloadLandFlood (2)
|-
|
|
|default unload
|fly over and drop unit
|land, then release all units at once
|-
|air
|BeginTransport (each) QueryTransport (each)
|EndTransport (last)
|EndTransport (each)
|StartUnload (first) TransportDrop (each) EndTransport (last)
|-
|ground
|TransportPickup (each)
|TransportDrop (each)
|TransportDrop (each)
|TransportDrop (each) EndTransport (last)
|}

=== Air transports ===

'''BeginTransport''' ( passengerID ) -> nil 
'''QueryTransport''' ( passengerID ) -> number piece

For an air transport, if any one unit is picked up, these two are called in succession and the passenger is attached to the piece returned by the second one.

'''StartUnload''' ( ) -> nil

Only called in UnloadLandFlood behavior. Signals the start of an unload cycle.

'''TransportDrop''' ( passengerID, x, y, z ) -> nil

Only called in UnloadLandFlood behavior. Called when a passenger will be unloaded. Contrary to ground transports, Spring will detach the passenger after the call.

'''EndTransport''' ( ) -> nil

In UnloadLand and UnloadLandFlood behaviors, these are called one time after all units are unloaded. (The transport is empty.) For the UnloadDrop behavior, this is called for every unit that is unloaded.

=== Ground transports ===

'''TransportPickup''' ( passengerID ) -> nil

Called when a passenger should be loaded into the transport. This should eventually call AttachUnit to actually attach the unit. Assuming the transport is in range of the next passenger, this will be called again for the next passenger 16 frames later, ''unless'' the script enters the BUSY state: then Spring will not move on to the next passenger until the script leaves the BUSY state.

'''TransportDrop''' ( passengerID, x, y, z ) -> nil

Called when a passenger should be unloaded. This should eventually call DetachUnit to actually detach the unit, ''unless'' the used unload method is UnloadLandFlood, in which case Spring will actually detach the unit after the call.

'''EndTransport''' ( ) -> nil

Only called in UnloadLandFlood behavior, after the last unit has been unloaded.

=== Passenger ===

'''Falling''' ( ) -> nil

For a unit dropped from an UnloadDrop transport, this is called every frame to inform the script the unit is still falling. It may be used to show a parachute for example.

'''Landed''' ( ) -> nil

This is called one time after the unit reached the ground. May be used to hide a parachute for example.

== Internal ==

These call-ins are NOT available to Lua unit scripts. They are called by the engine however, but always 'intercepted' by the framework gadget. For completeness (or if you are poking at the gadget), they are listed here anyway.

'''MoveFinished''' ( piece, axis ) -> nil 
'''TurnFinished''' ( piece, axis ) -> nil

Called when a move or turn finished. The framework gadget uses this to resume the coroutines which are waiting for the particular move or turn to be finished.

'''Destroy''
' ( ) -> nil

Called right before the unit's script is destroyed. This may happen if the unit is being destroyed, but also if the unit's script is being replaced by another script. The framework gadget uses this to stop all threads and remove the unit from some internal data structures.
[[Category:Unit_development]]
[[Category:Animation]]
[[Category:Lua]]

SetupGuide

2010-07-17T15:05:39Z

Seanheron: /* Linux Setup Guide */ put images into Linktemplate - strangely, the interal links increase the vertical box size :/ . However, the external link one does not, so "navimgx" could be used (see Fedora)

=Linux Setup Guide=

{{#css:
table.glossy {
margin: 4px; padding:10px;
border: 1px solid rgba(0,0,0,0.5);
border-radius: 10px 10px 10px 10px;
box-shadow: 0 2px 6px rgba(0,0,0,0.5), inset 0 1px rgba(255,255,255,0.3), inset 0 10px rgba(255,255,255,0.2), inset 0 10px 20px rgba(255,255,255,0.25), inset 0 -15px 30px rgba(0,0,0,0.3);
text-align: center;
}
/*table.glossy:hover {
background: rgba(160,160,220,0.4);
}*/
}}

{| style="width:70%; margin-left:15%; margin-right:15%;" |

|<center>
{| class="glossy" style="width:120px;" |
| style="height:31px" align="center"| {{navimg|xsize=64|ysize=64|image=Git.png|link=Build_from_source}} 
|-
| [[Build_from_source|From Source]]
|}
</center>

|<center>
{| class="glossy" style="width:120px;" |
| align="center"|
{{navimg|xsize=64|ysize=64|image=Distributions-ubuntu.png|link=Ubuntu_install}} 
|-
| [[Ubuntu_install| Ubuntu]]
|}
</center>

|<center>
{| class="glossy" style="width:120px;" |
| align="center"| {{navimg|xsize=64|ysize=64|image=Distributions-gentoo.png|link=Gentoo_install}} 
|-
| [[Gentoo_install|Gentoo]]
|}
</center>

|<center>
{| class="glossy" style="width:120px; padding:10px 0px 10px 0px;" |
| align="center"| {{navimg|xsize=64|ysize=64|image=Distributions-slackware.pngâ€Ž|link=Slackware12_install}} 
|-
| [[Slackware12_install|Slackware]]
|}
</center>

|-

|<center>
{| class="glossy" style="width:120px; padding:10px 0px 5px 0px;" |
| align="center"| {{navimg|xsize=64|ysize=64|image=Distributions-debian.pngâ€Ž|link=Debian_unstable_install}} 
|-
|Debian: [[Debian_lenny_install|Lenny]] - [[Debian_etch_install|Etch]] - [[Debian_unstable_install|Squeeze]]
|}
</center>

|<center>
{| class="glossy" style="width:120px;" |
| align="center"| {{navimg|xsize=64|ysize=64|image=Distributions-mandriva_linux.pngâ€Ž|link=Mandriva_install}} 
|-
| [[Mandriva_install|Mandriva]]
|}
</center>

|<center>
{| class="glossy" style="width:120px;" |
| align="center"| {{navimg|xsize=64|ysize=64|image=Distributions-opensuse_linux.pngâ€Ž|link=openSUSE_install}} 
|-
| [[openSUSE_install|openSUSE]]
|}
</center>

|<center>
{| class="glossy" style="width:120px;" |
| align="center"| {{navimgx|xsize=64|ysize=64|image=Distributions-fedora.pngâ€Ž|link=http://projects.springlobby.info/projects/springlobby/wiki/Install#Fedora-10}} 
|-
| [http://projects.springlobby.info/projects/springlobby/wiki/Install#Fedora-10 Fedora]
|}
</center>

|}

[[Category:Linux]]

GamesDownloads

2010-07-17T14:37:02Z

Seanheron: Engine download link - to appropriate section of download page, else we're sending people in circles

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

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

/*table.glossy:hover {
background: rgba(160,160,220,0.4);
}*/
}}
= Game installers (for players) =
Below are some of the download pages of games using the Spring engine:
<div id="installers" style="padding-left:7px">
{| class="glossy" |
| [http://www.evolutionrts.info/wordpress/?page_id=16 Evolution RTS]
| [[Image:EvoRTS_screenshot.jpg|55px]]
|}

{| class="glossy" |

| [http://springfiles.com/1683 Kernel Panic]
| [[Image:Kernel_Panic_3.4.jpg|55px]]
|}

{| class="glossy" |
| [http://spring1944.net/downloads.php Spring 1944]
| [[Image:S44_tigers.jpg|55px]]
|}
</div>

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

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

[http://trac.caspring.org/wiki/sd Spring Downloader]
[http://springlobby.info/landing/index.php SpringLobby]

more advanced Linux users may use [http://github.com/tvo/rapid rapid].

(Note: Spring Downloader and SpringLobby are included in the Engine Installer which you can [[Download#Spring_Engine_Updates|download here]].)

GadgetDatabase

2010-02-23T21:23:12Z

Seanheron: plastered some more stuff in

[b]Some Logistics thoughts:[/b]

There's already been some worthy gadgets suggested for inclusion (on the thread this idea was discussed). And of course I'd like to see them online! While it wouldn't be too great an effort for me to upload them, for two reasons, I'd prefer not too:

- First, if we get even a fraction of the potential general use gadgets that are out there onto the database, that'd be a considerable workload for me to shoulder alone.
- Second (and perhaps more importantly), a good number of them will continue to be improved or kept up to date - and would thus be outdated pretty soon on the database, if the authors can't easily update it themselves.

For the second reason, I'd also be happy to set up shared accounts for game development groups (since you can only edit gadgets you've uploaded with your account, and there's no way of allowing other accounts edit-powers).

Since the Gadget-DB builds on the great system made for the Widget-Database, if you've ever used the Browser-based interface of that ([url=http://www.springinfo.info/?page_id=690]as seen on Springinfo[/url]) - this is the same. Accordingly, if you happen to have managed Widgets, the system is the same here :) !

some technicalities/suggestions regarding documentation of Gadgets you upload and such
Finally, the technicalities (I'm wondering if there'd be a better place for this info - maybe wiki ?):

And/or have a look at the docu I included with [url=http://gadgetdb.springrts.de/lua_manager.php?m=10&id=356]the KeyboardSteering Gadget[/url]

[b]"Modules"[/b] - As pointed out repeatedly, a lot of gadgets actually require multiple files, and potentially entries in unitdefs (or whatnot) to work properly. Thanks to the setup vbs has made though, it is trivial to upload multiple files and specify different places for them to go different :).

I would suggest that where eg unitdefs are required. I realise anyone more savvy with lua will not require this per se - I think with a little extra effort though, we can keep the database accessible to people with little grasp of lua.

In that vein, the following also seem a pretty much "must-have" to me:
As well as including an "Api" text file explaining how the gadget interfaces with the rest of Spring:
- ie what unitdefs it needs;
- any "calls" it requires (ie global vars be set) from non-generalisable seperate gadgets;
Or to pick up your example:
- what info it passes on to GUI elements;
- CMDs it depends on being given, etc.

Finally, I'd suggest some categories (if you want to categorise that is - as of now there's no functionality, since it's made with SpringDownloader in mind).

UI, (GUI), Map, Unitbehaviour, Unitdefs, Unitvars, Antihack,
(I'm sure there's some more that might be added.)

GadgetDatabase

2010-02-17T23:01:47Z

Seanheron: started docu page, for what would be good to include with gadgets uploaded to the DB

Finally, the technicalities (I'm wondering if there'd be a better place for this info - maybe wiki ?):

[b]"Modules"[/b] - As pointed out repeatedly, a lot of gadgets actually require multiple files, and potentially entries in unitdefs (or whatnot) to work properly. Thanks to the setup vbs has made though, it is trivial to upload multiple files and specify different places for them to go different :).

I would suggest that where eg unitdefs are required. I realise anyone more savvy with lua will not require this per se - I think with a little extra effort though, we can keep the database accessible to people with little grasp of lua.

In that vein, the following also seem a pretty much "must-have" to me:
As well as including an "Api" text file explaining how the gadget interfaces with the rest of Spring:
- ie what unitdefs it needs;
- any "calls" it requires (ie global vars be set) from non-generalisable seperate gadgets;
Or to pick up your example:
- what info it passes on to GUI elements;
- CMDs it depends on being given, etc.

Finally, I'd suggest some categories (if you want to categorise that is - as of now there's no functionality, since it's made with SpringDownloader in mind).

UI, (GUI), Map, Unitbehaviour, Unitdefs, Unitvars, Antihack,
(I'm sure there's some more that might be added.)

Game and Unit development

2010-02-05T13:08:10Z

Seanheron: /* Scripting and Animation - COB/BOS Files */ added link

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

=Mod development=
Mods, next to Maps, is the content used in Spring. 
A mod is simply a combined file containing a small structure of files and directories holding all the data required. 

[[Mod_Development | Mod Development]] wiki is a starting page, linking to very useful information on the files included in a mod, their hierarchy and more.
 

Almost the entire mod developing is the creation of units. Which isn't an easy job. 
Information about the creation of units are everywere, but not combined. 
This is a gathered list of all Tutorials and helpfull forums threads I could find: 

==General==
*[[Mod Development]]
*[[Mod specification]] 
*[http://spring.clan-sy.com/phpbb/viewtopic.php?t=6015 What do I need to create a mod]
*[[Simple Mod Tutorial]]
*[[Freely available and reusable content|Freely available and reusable content/games/mods]]
*[[tools & software for make :map mod unit]]

==Unit Development==
====Automated Mod Creation====
* [[TA2Spring]] - Automatically adds and converts Total Annihilation unit packs (.ufo files, etc..) into Spring mods (requires a base modification for the game rules, XTA is recommended)
====Models - s3o Files====
*[http://user.supradigital.org/jcnossen/UpspringInstaller-1.54-EulerAngles.exe UpSpring, our second-gen import / export / rigging / animation tool.]
* [http://lassie.student.utwente.nl/vliet/springtut.pdf Maestro's tutorial of Upspring and textures].
* [[Basic s3o unit making guide]]
* [[Simple Mod Tutorial]]
* [[Units:CreateModel|UV Mapping in Wings3D]]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10612 Wings UV Mapping Tutorial]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?f=9&t=12354 Saving polygons in Wings3d Tutorial]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10947 Greeble Tutorial 1]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?f=9&t=12356 Greeble Tutorial 2]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?p=75495 various things about unit making. (Also contains an illustrated alpha-channel tut)]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10503 Runecrafter's 3DS Max UV Mapping Tutorial]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?f=9&t=15106 Argh's UpSpring Easy Workflow Guide]
* [[Trouble-shooting s3o units]]

====Models - 3do Files====
outdated model format used by OTA 
(Note: UpSpring has some problems with empty objects and groundplates)
*use [http://spring.clan-sy.com/phpbb/viewtopic.php?f=12&t=7208&p=126129&hilit=upspring#p126129 UpSpring] and [http://www.fileuniverse.com/?p=show&a=it&id=305 3doBuilder] to edit those files

====[http://springrts.com/wiki/Category:Animation Scripting and Animation - COB/BOS Files]====
To edit .bos files you need a program/compiler. The most famous one is [http://jobjol.nl/1384 Scriptor]
*[[Animation-LuaScripting]]
**[[Animation-LuaCallins]]
**[[Animation-LuaCallouts]]
**[[Animation-CobLuaDifferences]]
*[[Animation-CobOverview]]
**[[Animation-CobExamples]]
**[[Animation-CobAnimation]]
**[[Animation-CobCallins]]
**[[Animation-CobConstants]]
**[[Animation-CobThreads]]
**[[Animation-CobHitByWeaponID]]
*[http://www.planetannihilation.com/tadc/tut_unit_01_1.asp PlanetAnnihilation] has a nice tutorial
*[[Units:LuaCOB]] - how to interface COB with LUA
*[[CEG_For_Units|Mod Development:Calling basic CEGs from COB]]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?p=132943#132943 GPL-compliant sourcecode, scripting code examples, and other things.]

====Units - FBI Files====
*[[Units:FBI]]
*[[All_FBI-variable_values:_min,_max,_default,_type|Units:FBI (variable datatype list)]]
*[[Unit_Categories]]

====Units - MoveTypes====
*[[Units:MoveTypes]]

====Weapons - TDF Files====
*[[Weapon Variables]] : This is the most up to date
*[[Units:WeaponMainDir]]
*[[Units:Weapons]] : Various informations about the weapontypes (uncompleted)
*[[All_Weapons_variable_values:_min%2C_max%2C_default%2C_type|Weapon datatype list]] : All weapon variables min/max/default values and datatypes listed.
*[[Weapons:Antinukes]]: All about antinukes.

====Explosions====
*[[CEG]]
**[[CEG-Calls]]
**[[CEG-Format]]
**[[CEG-Classes]]
**[[CEG-Operators]]
**[[CEG-Miscellaneous]]
**[[CEG-OldInfo]]

====Misc====
*[[Units:Design]]
*[[Units:Textures]]
*[[Units:Buildpics]]
*[[Units:SideData TDF]]
*[[Units:Download TDF]]
*[[Units:FlankingBonus]]
*[[Mod Development:Armor]]
*[[Mod Development:Cursors]]
*[[Mod Development:Archives]]
*[[Mod Development:Sidepics]]
*[[CustomUnitIcons|Mod Development:Custom unit icons]]

LuaCallinReturn

2010-01-04T11:52:43Z

Seanheron: /* Unit-Specific: */ this value is also available for UnitDestroyed

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

===Lua Call-Ins, with parameters===

''Here are the known reserved parameter values for all Lua Call-Ins. If you add new Call-Ins to Spring, please document them here.''

==Commands, general-purpose:==

Shutdown() --> none.

LayoutButtons() --> unknown, please document.

ConfigureLayout() --> "command".

CommandNotify() --> "id, params, options", where id = the CommandID

KeyPress() --> "key, mods, isRepeat", where key = keymap, mods = SHIFT, etc.

KeyRelease() --> "key"

MouseMove() --> "x, y, dx, dy, button"

MousePress() --> "x, y, button"

MouseRelease() --> "x, y, button"

IsAbove() --> "x, y" where x,y = screen coordinates.

GetTooltip() --> "x, y" where x,y = screen coordinates. Returns WorldTooltip.

AddConsoleLine() --> "msg, priority"

AllowCommand() --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag, synced"

CommandFallback() --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag"

CommandsChanged() --> unknown (none?)

AllowUnitCreation() --> "unitDefID, builderID, builderTeam, x, y, z"

AllowUnitTransfer() --> "unitID, unitDefID, oldTeam, newTeam, capture"

AllowUnitBuildStep() --> "builderID, builderTeam, unitID, unitDefID, part"

AllowFeatureCreation() --> "featureDefID, teamID, x, y, z"

AllowFeatureBuildStep() --> unknown, please document.

AllowResourceLevel() --> "teamID, res, level"

AllowResourceTransfer() --> "teamID, res, level"

==Unit-Specific:==

UnitPreDamaged() --> "unitID, unitDefID, unitTeam, damage, paralyzer, weaponID, attackerID, attackerDefID, attackerTeam"

UnitDamaged() --> "unitID, unitDefID, unitTeam, damage, paralyzer, weaponID, attackerID, attackerDefID, attackerTeam"

UnitCreated() --> "unitID, unitDefID, teamID" ... I hope that's self-explanatory

UnitFinished() --> "unitID, unitDefID, teamID"

UnitFromFactory() --> "unitID, unitDefID, unitTeam, factID, factDefID, userOrders"

UnitDestroyed() --> "unitID, unitDefID, teamID, attackerID?"

UnitTaken() --> "unitID, unitDefID, unitTeam, newTeam"

UnitGiven() --> "unitID, unitDefID, unitTeam, oldTeam"

UnitIdle() --> "unitID, unitDefID, teamID"

UnitCommand() --> unknown, please document.

UnitSeismicPing() --> "x, y, z, strength"

UnitEnteredRadar() --> "unitID, unitTeam"

UnitEnteredLos() --> "unitID, teamID"

UnitLeftRadar() --> "unitID, unitTeam"

UnitLeftLos() --> "unitID, unitDefID, teamID"

UnitLoaded() --> "unitID, unitDefID, unitTeam, transportID, transportTeam"

UnitUnloaded() --> "unitID, unitDefID, teamID, transportID"

UnitCloaked() --> "unitID, unitDefID, teamID"

UnitDecloaked)--> "unitID, unitDefID, teamID"

UnitMoveFailed() --> "unitID, unitDefID, unitTeam"

StockpileChanged() --> "unitID, unitDefID, unitTeam, weaponNum, oldCount, newCount"

UnitEnteredWater() --> "unitID, unitDefID, teamID"

UnitEnteredAir() --> "unitID, unitDefID, teamID"

UnitLeftWater() --> "unitID, unitDefID, teamID"

UnitLeftAir() --> "unitID, unitDefID, teamID"

==Feature-Specific:==

FeatureCreated() --> "featureID, allyTeam"

FeatureDestroyed() --> "featureID, allyTeam"

TerraformComplete() --> "unitID, unitDefID, unitTeam, buildUnitID, buildUnitDefID, buildUnitTeam"

UnitCmdDone() --> "unitID, unitDefID, unitTeam, cmdID, cmdTag"

==Drawing:==

* DrawGenesis() --> none. Don't render here.

* Spring draws the sky, the map, some water types, and unit selection.

* DrawWorldPreUnit() --> none.

* Spring draws units, features, some water types, cloaked units, and the sun.

* DrawWorld() --> none.

* Spring draws command queues, 'map stuff', and map marks.

Each unit might also have a DrawUnit call, [[Lua_UnitRendering|enabled here.]]

DrawUnit(unitID,DrawMode) 
With enum DrawMode { 
notDrawing = 0, 
normalDraw = 1, 
shadowDraw = 2, 
reflectionDraw = 3, 
refractionDraw = 4 
};

DrawScreenEffects() --> "vsx, vsy" where vsx, vsy are screen coords.

DrawScreen() --> none.

DrawInMiniMap() --> "sx, sy" where sx,sy are values relative to the minimap's position and scale.

DrawWorldShadow() --> none.

DrawWorldReflection() --> none.

DrawWorldRefraction() --> none.

==Game Events:==

Explosion() --> "weaponID, px, py, pz, ownerID"

ShockFront() --> "power, dx, dy, dz"

GameFrame() --> "frameNum"

CobCallback() --> unknown, marked FIXME.

GroupChanged() --> "groupID" where groupID is the value of Group whose table value changed.

WorldTooltip() --> "ttType, data1, data2, data3" special, should be documented in detail.

GamePreload() --> none.

GameStart() --> none.

GameOver() --> none.

TeamDied() --> "TeamID" where TeamID = the team that has been eliminated.

==Projectiles:==

ProjectileCreated() --> "proID, proOwnerID"

ProjectileDestroyed() --> "proID"

Lua UnsyncedCtrl

2009-09-03T06:31:04Z

Seanheron: /* Unit NoDraw,NoSelect,NoMinimap */

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

= UI =
'''Spring.SetLastMessagePosition'''
( number x, number y, number z ) -> nil

= Ingame Console =
'''Spring.Echo'''
( arg1 [, arg2 [, ... ] ] ) -> nil

Useful for debugging. Prints values in the spring chat console. Hint: the default print() writes to STDOUT.

'''Spring.SendCommands''' (needs ModUICtrl)
( string command1 [, string command2 [ ... ] ] ) -> nil
( {string command1, string command2, ...} ) -> nil

== GUI ==
'''Spring.SetActiveCommand''' (needs ModUICtrl)
( string action [, string actionExtra ] ) -> nil | boolean
( number cmdIndex [, number button = 1
[, boolean leftClick, boolean rightClick,
boolean alt, boolean ctrl, boolean meta, boolean shift]] ) -> nil | boolean
'''Spring.ForceLayoutUpdate''' (needs ModUICtrl)
( ) -> nil
'''Spring.SetDrawSelectionInfo''' disables the "Selected Units x" box in the GUI (needs ModUICtrl)
( boolean enable ) -> nil

== Mouse ==
'''Spring.SetMouseCursor''' (needs ModUICtrl)
( string cursorName [, number scale ] ) -> nil
'''Spring.WarpMouse''' (needs ModUICtrl)
( number x, number y ) -> nil

== LOS Colors ==
'''Spring.SetLosViewColors''' (needs ModUICtrl)
( table reds = { number always, number LOS, number radar, number jam },
table greens = { number always, number LOS, number radar, number jam },
table blues = { number always, number LOS, number radar, number jam } ) -> nil

== SendMessage ==
'''Spring.SendMessage'''
( string "message" ) -> nil
'''Spring.SendMessageToPlayer'''
( number playerID, string "message" ) -> nil
'''Spring.SendMessageToTeam'''
( number teamID, string "message" ) -> nil
'''Spring.SendMessageToAllyTeam'''
( number allyID, string "message" ) -> nil
'''Spring.SendMessageToSpectators'''
( string "message" ) -> nil

== Markers ==
'''Spring.MarkerAddPoint''' (needs ModUICtrl)
( number x, number y, number z [, string text = ""] ) -> nil
'''Spring.MarkerAddLine''' (needs ModUICtrl)
( number x1, number y1, number z1, number x2, number y2, number z2 ) -> nil
'''Spring.MarkerErasePosition''' (needs ModUICtrl)
( number x, number y, number z ) -> nil

= Sounds =
'''Spring.PlaySoundFile'''
( string "soundfile" [, number volume
[, number x, number y, number z ] ] ) -> nil | boolean
Plays WAV or OGG sounds. By default, the soundfile is expected to be in the "Sounds" folder.
'''Spring.PlaySoundStream'''
( string "oggfile" [, number volume = 1.0
[, number x, number y, number z ]] ) -> nil | boolean true
Allow you to play an Ogg Vorbis (.OGG) compressed sound file. Note: you may only play _ONE_ stream at a time. If another stream is playing and you try to start a second one the call will fail, and silence will result. 
'''Spring.StopSoundStream'''
( ) -> nil
Terminates any SoundStream is running. Since only one may play at any time (see above), this can be used as an interrupt.
'''Spring.PauseSoundStream'''
( ) -> nil
'''Spring.SetSoundStreamVolume'''
( number volume ) -> nil

= SendLuaMessage =
Very important! (allows synced inter-lua-enviroment communications)

'''Spring.SendLuaUIMsg''' (needs ModUICtrl)
( string message, string mode ) -> nil
possible modes are: "s"/"specs" & "a"/"allies"
'''Spring.SendLuaGaiaMsg''' (needs ModUICtrl)
( string message ) -> nil
'''Spring.SendLuaRulesMsg''' (needs ModUICtrl)
( string message ) -> nil

= Units =
== Unit Selection ==
'''Spring.SelectUnitMap'''
( { [unitID] = anything, ...} [,boolean append] ) -> nil
'''Spring.SelectUnitArray'''
( { [1] = unitID1 , [2] = unitID2 , ...} [,boolean append] ) -> nil

'''Spring.GetDrawSelectionInfo'''
( boolean drawSelectionInfo ) -> nil

== Unit Group ==
'''Spring.SetUnitGroup''' (needs ModUICtrl)
( number unitID, number groupID ) -> nil

== Give Order ==
'''Spring.GiveOrder''' gives order to all selected units (needs ModUICtrl)
( number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"} ) -> nil | boolean true
'''Spring.GiveOrderToUnit''' (needs ModUICtrl)
( number unitID,
number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"} ) -> nil | boolean true
'''Spring.GiveOrderToUnitMap''' (needs ModUICtrl)
( unitMap = { [unitID] = dontCare, etc... },
number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"} ) -> nil | boolean true
'''Spring.GiveOrderToUnitArray''' (needs ModUICtrl)
( unitArray = { [1] = unitID, etc... },
number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"} ) -> nil | boolean true
'''Spring.GiveOrderArrayToUnitMap''' (needs ModUICtrl)
( unitMap = { [number unitID] = dontCare, etc... },
orderArray = {
{ number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"}
}, ..
}
) -> nil | boolean true
'''Spring.GiveOrderArrayToUnitArray''' (needs ModUICtrl)
( unitArray = { [1] = number unitID, etc... },
orderArray = {
{ number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"}
}, ..
}
) -> nil | boolean true

'''Spring.SetBuildFacing'''
( int Facing ) -> nil

'''Spring.SetBuildSpacing'''
( int Spacing ) -> nil

== Unit NoDraw,NoSelect,NoMinimap ==
'''Spring.SetUnitNoDraw''' LuaGadgets only!
( number unitID, boolean noDraw ) -> nil
'''Spring.SetUnitNoSelect''' Erm, LuaGadgets only! erm, this seems to work only in "Synced" for me... So don't know if this might be misplaced
( number unitID, boolean noSelect ) -> nil
'''Spring.SetUnitNoMinimap''' LuaGadgets only!
( number unitID, boolean noMinimap ) -> nil

= GUI =
'''Spring.SetDrawSky'''
( boolean drawSky ) -> nil
'''Spring.SetDrawWater'''
( boolean drawWater ) -> nil
'''Spring.SetDrawGround'''
( boolean drawGround ) -> nil

'''Spring.DrawUnitCommands'''
( number unitID ) -> nil
( { [1] = unitID, ... } [, false ] ) -> nil
( { [unitID] = anything, ... }, true ) -> nil

'''Spring.SetTeamColor'''
( number teamID, number r, number g, number b ) -> nil

'''Spring.AssignMouseCursor''' default hotspot is center!
( string "cmdName", string "iconFileName"
[, boolean overwrite [, boolean hotSpotTopLeft] ] ) -> nil | boolean
'''Spring.ReplaceMouseCursor''' default hotspot is center!
( string "oldFileName", string "newFileName" [, boolean hotSpotTopLeft] ) -> nil | boolean

'''Spring.SetCustomCommandDrawData''' register your custom cmd so it gets visible in the unit's cmd queue
( number cmdID,
number cmdIconID | string iconname | nil,
{ number r, number g, number b, number a } [, boolean showArea ] ) -> nil | true

= Sharing =
'''Spring.SetShareLevel''' note: shareLevel is 0<= x <= 1 (needs ModUICtrl)
( string "metal" | "energy", number shareLevel ) -> nil
'''Spring.ShareResources''' (needs ModUICtrl)
( number teamID, string "units" ) -> nil
( number teamID, string "metal" | "energy", number amount ) -> nil

= UnitDef RadarIcons & BuildPics =
'''Spring.AddUnitIcon''' (needs ModUICtrl)
( string iconName, string texFile [, number size [, number dist [, boolean radAdjust ]]] ) -> nil | boolean
'''Spring.FreeUnitIcon''' (needs ModUICtrl)
( string iconName ) -> nil | boolean
'''Spring.SetUnitDefIcon''' (RadarIcon) (needs ModUICtrl)
( number unitDefID, string iconName ) -> nil
'''Spring.SetUnitDefImage''' (BuildPic) (needs ModUICtrl)
( number unitDefID, luaTexture | string texFile ) -> nil

= Camera =
'''Spring.SetCameraState'''
( table camState, number camTime) -> nil | boolean
camState has the same format as the output of Spring.GetCameraState(). See [[Lua_camState]] for details about camState.

'''Spring.SetCameraTarget'''
( number x, number z, number y [,number transTime] ) -> nil
For Spring Engine XZ represents horizontal, from north west corner of map and Y vertical, from water level and rising.

'''Spring.SetCameraOffset''' (needs ModUICtrl)
( [number px = 0 [, number py = 0 [, number pz = 0
[, number tx = 0 [, number ty = 0 [, number tz = 0]]]]]] ) -> nil

= (Virtual-)FileSystem =
'''Spring.ExtractModArchiveFile'''
( string modfile ) -> boolean
'''Spring.CreateDir''' (needs ModUICtrl)
( number path ) -> nil | boolean

= Engine Config =
The following functions read the engine configs saved in .springrc, registry or what ever your os prefers.

'''Spring.GetConfigInt''' (needs ModUICtrl)
( string name [, number default] ) -> nil | number
'''Spring.SetConfigInt''' (needs ModUICtrl)
( string name, number value ) -> nil
'''Spring.GetConfigString''' (needs ModUICtrl)
( string name [, string default] ) -> nil | string
'''Spring.SetConfigString''' (needs ModUICtrl)
( string name, string value ) -> nil

= Make Font =
'''Spring.MakeFont''' (needs ModUICtrl)
( [string inputFile], table options ) -> nil | boolean
options = {
outName = string,
inData = string,
height = number,
texWidth = number,
minChar = number,
maxChar = number,
outlineMode = number,
outlineRadius = number,
outlineWeight = number,
padding = number,
stuffing = number,
debug = number,
}

= World Primitives =
outdated! use opengl api instead!

'''Spring.AddWorldIcon'''
( number cmdID, number x, number y, number z ) -> nil
'''Spring.AddWorldText'''
( string "text", number x, number y, number z ) -> nil
'''Spring.AddWorldUnit'''
( number unitDefID,
number x, number y, number z,
number team, number facing) -> nil

= Misc =

'''Spring.Restart''' (0.79+)
( string commandline_args, string startscript ) -> if this call returns, something went wrong
commandline_args are commandline arguments passed to spring executable

startscript is the CONTENT of the script.txt spring should use to start (if empty, no startscript is added, you can still point spring to your custom script.txt when you add the filepath to commandline_args

Lua SyncedCtrl

2009-09-02T20:45:56Z

Seanheron: /* Unit Control */ Doh - of course it's unsynced...!

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

= Resources =
'''Spring.AddTeamResource'''
( number teamID, string "m" | "e", number amount ) -> nil
'''Spring.UseTeamResource'''
( number teamID,
string "m" | "e", number amount |
{ m = number amount, e = 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 "m" | "e", number amount ) -> nil

= 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 ) -> number unitID

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


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

selfd makes the unit act like it self-destructed
reclaimed makes the unit act like it was reclaimed


'''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.SetUnitLineage'''
( number unitID, number teamID [, boolean isRoot] ) -> nil

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

'''Spring.SetUnitTarget'''
( number unitID,
number enemyUnitID | number x, number y, number z,
[ boolean dgun = false ] ) -> nil

'''Spring.SetUnitBlocking'''
( number unitID, boolean blocking [, boolean collide ] ) -> nil

'''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.SetUnitArmored'''
( number unitID, boolean armored ) -> nil

'''Spring.SetUnitShieldState'''
( number unitID, 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
format of the states table:
{
["reloadState" = number value,]
["reloadTime" = number value,]
["accuracy" = number value,]
["sprayAngle" = number value,]
["range" = number value,]
["projectileSpeed" = number value,]
["burst" = number value,]
["burstRate" = number value,]
["projectiles" = number value,]
}

'''Spring.SetUnitCollisionVolumeData'''
( number unitID, number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetX,
number vType, number tType, number Axis
) -> 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 x, number y, number z,
[, number radius = 0 [, number speed = unit->maxSpeed * 2 ] ] ) -> nil

'''Spring.SetUnitPhysics'''
( number unitID,
number posx, number posy, number posz,
number velx, number vely, number velz,
number rotx, number roty, number rotz,
) -> nil

'''Spring.SetUnitPosition'''
( number unitID, number x, number z [, boolean alwaysAboveSea] ) -> 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 ) -> nil

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

'''Spring.RemoveBuildingDecal'''
( number unitID ) -> 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"

== Unit Ressourcing ==
'''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

= Feature Handling =
'''Spring.CreateFeature'''
( string "defName" | number featureID, number x, number y, number z
[,number heading [, number AllyTeamID ]] ) -> 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 ) -> nil

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

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

'''Spring.SetFeatureCollisionVolumeData'''
( number featureID, number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetX,
number vType, number tType, number Axis
) -> nil

= 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

'''Spring.GetUnitCOBValue'''
( number unitID [, boolean splitData=false], number COBValue
[, number param1 [,number param2 [, number param3 [, number param4 ] ] ] ] )
-> number result | number result1, number result2
'''Spring.SetUnitCOBValue'''
( number unitID, number COBValue, number param1 [,number param2] ) -> nil

= Give Order =
'''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

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

= 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

'''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 posX = 0 [, number posY = 0 [, number posZ = 0
[, number dirX = 0 [, number dirY = 0 [, number dirZ = 0
[, number radius = 0 [, number damage = 0 ]] ]]] ]]]
) -> nil

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

Lua SyncedCtrl

2009-09-02T20:31:02Z

Seanheron: /* Unit Control */ Added command I found in use, but don't know documentation for

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

= Resources =
'''Spring.AddTeamResource'''
( number teamID, string "m" | "e", number amount ) -> nil
'''Spring.UseTeamResource'''
( number teamID,
string "m" | "e", number amount |
{ m = number amount, e = 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 "m" | "e", number amount ) -> nil

= 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 ) -> number unitID

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


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

selfd makes the unit act like it self-destructed
reclaimed makes the unit act like it was reclaimed


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

== Unit Control ==
'''SpringSetUnitNoSelect'''
????

'''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.SetUnitLineage'''
( number unitID, number teamID [, boolean isRoot] ) -> nil

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

'''Spring.SetUnitTarget'''
( number unitID,
number enemyUnitID | number x, number y, number z,
[ boolean dgun = false ] ) -> nil

'''Spring.SetUnitBlocking'''
( number unitID, boolean blocking [, boolean collide ] ) -> nil

'''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.SetUnitArmored'''
( number unitID, boolean armored ) -> nil

'''Spring.SetUnitShieldState'''
( number unitID, 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
format of the states table:
{
["reloadState" = number value,]
["reloadTime" = number value,]
["accuracy" = number value,]
["sprayAngle" = number value,]
["range" = number value,]
["projectileSpeed" = number value,]
["burst" = number value,]
["burstRate" = number value,]
["projectiles" = number value,]
}

'''Spring.SetUnitCollisionVolumeData'''
( number unitID, number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetX,
number vType, number tType, number Axis
) -> 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 x, number y, number z,
[, number radius = 0 [, number speed = unit->maxSpeed * 2 ] ] ) -> nil

'''Spring.SetUnitPhysics'''
( number unitID,
number posx, number posy, number posz,
number velx, number vely, number velz,
number rotx, number roty, number rotz,
) -> nil

'''Spring.SetUnitPosition'''
( number unitID, number x, number z [, boolean alwaysAboveSea] ) -> 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 ) -> nil

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

'''Spring.RemoveBuildingDecal'''
( number unitID ) -> 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"

== Unit Ressourcing ==
'''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

= Feature Handling =
'''Spring.CreateFeature'''
( string "defName" | number featureID, number x, number y, number z
[,number heading [, number AllyTeamID ]] ) -> 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 ) -> nil

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

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

'''Spring.SetFeatureCollisionVolumeData'''
( number featureID, number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetX,
number vType, number tType, number Axis
) -> nil

= 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

'''Spring.GetUnitCOBValue'''
( number unitID [, boolean splitData=false], number COBValue
[, number param1 [,number param2 [, number param3 [, number param4 ] ] ] ] )
-> number result | number result1, number result2
'''Spring.SetUnitCOBValue'''
( number unitID, number COBValue, number param1 [,number param2] ) -> nil

= Give Order =
'''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

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

= 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

'''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 posX = 0 [, number posY = 0 [, number posZ = 0
[, number dirX = 0 [, number dirY = 0 [, number dirZ = 0
[, number radius = 0 [, number damage = 0 ]] ]]] ]]]
) -> nil

= Projectiles =
'''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 talk:PageNamingConventions

2009-09-02T08:27:10Z

Seanheron: New page: Hey Athmos - sorry, I've been on holidays, so didn't see you're changes till today - I'll be making some changes as well I think, cause I don't agree with all of yours, and I'll be justify...

Hey Athmos - sorry, I've been on holidays, so didn't see you're changes till today - I'll be making some changes as well I think, cause I don't agree with all of yours, and I'll be justifying them here.
[[User:Seanheron|Seanheron]] 08:27, 2 September 2009 (UTC)

Template:Navimg

2009-09-01T15:40:05Z

Seanheron: fixed info

<div style="position: relative; width: {{{xsize|{{{size|}}}}}}px; height: {{{ysize|{{{size|}}}}}}px; overflow: hidden;"><div style="position: absolute; top: 0; left: 0; font-size: 200pt; width: {{{xsize|{{{size|}}}}}}px; height: {{{ysize|{{{size|}}}}}}px; overflow: hidden; line-height: {{{ysize|{{{size|}}}}}}px; z-index: 3;">[[:{{{link|}}}|{{{linktext| }}}]]</div><div style="position: absolute; top: 0; left: 0; z-index: 2;">[[Image:{{{image|}}}|{{{xsize|{{{size|}}}}}}px|image page]]</div></div>

<noinclude>This is the format the template needs to be used in: <pre>{{navimg|xsize=50|ysize=50|image=Wikimedia-logo.svg|link=Wikimedia}}</pre></noinclude>

Games

2009-09-01T15:34:34Z

Seanheron: fixed all images as links (this looses the borders though... use navimgx for external links, navimg for wikilinks!

__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. 
----
=Free/Open Source=
''These games are all free to download and play and may be modded without the author's permission (asking permission is considered a common courtesy though).''
{| class="wikitable" border="0"
|-
| align="center" | <h2>[http://www.evolutionrts.info Evolution RTS]</h2>
| width=40 |
| align="center" | <h2>'''[http://www.spring1944.com Spring: 1944]'''</h2>
|-
| align="center" | {{navimgx|xsize=300|ysize=225|image=EvoRTS screenshot.jpg|link=http://www.evolutionrts.info}}
|
| align="center" |{{navimgx|xsize=300|ysize=225|image=S44_tigers.jpg|link=http://www.spring1944.com}}
|-
| align="justify" | A new breed of Game for Spring. Prepare to engage in a war that changes every week, with objective based missions, evolving units, fast paced combat and a compelling plot line that YOU alter with every mission!
|
| align="justify" | 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.
|}

{| class="wikitable" border="0"
|-
| align="center" | <h2>[[Kernel Panic]]</h2>
| width=40 |
| align="center" | <h2>[[War Evolution]]</h2>
|-
| align="center" | {{navimg|xsize=300|ysize=225|image=Kernel_Panic_3.4.jpg|link=Kernel Panic}}
|
| align="center" |{{navimg|xsize=300|ysize=225|image=Warevoscreen.jpg|link=War Evolution}}
|-
| align="justify" | A game based around combat '''inside''' a computer, with 3 unique sides: the System, the Hacker and the Network waging war in a matrix of DOOM! No resource economy exists in KP, with the only constraints being time and space.
|
| align="justify" | In short words, War Evolution is different. Different from all other games. You dont have a base and you can not reinforce your "army". In fact, you command only one single mech and if he dies, you can only spectate until the game is over.
|}
----

=Proprietary=
''These games may or may not be free to play. Modifying their content (i.e. the art assets) is not allowed without the game authors explicit permission, although the code is GPL and some games (P.U.R.E.) include large GPL-friendly content collections.''
{| class="wikitable" border="0"
|-
| align="center" | <h2>[http://www.wolfegames.com P.U.R.E.]</h2>
| width=40 |
| align="center" | <h2>[[Gundam RTS]]</h2>
|-
| align="center" |{{navimgx|xsize=300|ysize=225|image=PURE_LOGO_1024.jpg|link=http://www.wolfegames.com}}
|
| align="center" |{{navimg|xsize=300|ysize=225|image=Screen104.jpg|link=Gundam RTS}}
|-
| align="justify" | A game based on a completely original IP, allowing players to participate in the epic, galaxy-spanning conflict between the human Resistance forces and the malevolent A.I. known as 'The Overmind'.
|
| align="justify" | Set during the One-Year War in the Universal Century timeline of the Gundam Metaseries, Gundam RTS features fast, intense mech combat gameplay in a truly Gundam style.
|}

{| class="wikitable" border="0"
|-
| align="center" | <h2>[http://www.imperialwinter.com Star Wars: Imperial Winter]</h2>
| width=40 |
| align="center" | <h2>[[Expand_and_Exterminate|Expand and Exterminate]]</h2>
|-
| align="center" | {{navimgx|xsize=300|ysize=225|image=Imperial Winter assault.jpg|link=http://www.imperialwinter.com}}
|
| align="center" |{{navimg|xsize=300|ysize=225|image=E&E-screenshot2.jpg|link=Expand and Exterminate}}
|-
| align="justify" | A Star Wars themed game set in the troubled post-Return of the Jedi era, SW:IW features over a hundred units for the fractured Galactic Empire and Rebel Alliance fighting for control of the galaxy.
|
| align="justify" | An original IP game loosely based around the Earth 2150 series of games.
|}

{| class="wikitable" border="0"
|-
| width=180 |
| align="center" | <h2>'''[http://azaremoth.supremedesign.org The Cursed]'''</h2>
| width=180 |
|-
|
| align="center" | {{navimgx|xsize=300|ysize=225|image=cursed.jpg|link=http://azaremoth.supremedesign.org}}
|
|-
|
| align="justify" | The unique game is about bones, undead, demons and magic settled in a futuristic environment.
|
|}

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

{| class="wikitable" border="0"
|-
| align="center" | <h2>[[Complete Annihilation]]</h2>
| width=40 |
| align="center" | <h2>[[NOTA]]</h2>
|-
| align="center" | {{navimg|xsize=300|ysize=225|image=Pyro.jpg|link=Complete Annihilation}}
|
| align="center" |{{navimg|xsize=300|ysize=225|image=Nota2nukes.jpg|link=NOTA}}
|-
| align="justify" | CA is a regularly updated game that is often regarded as a showcase of what the Spring Engine can do. The game is designed with a flat tech tree, where the effectiveness of a unit is based on its appropriateness to the situation rather than lighter units being superseded by heavier ones.
Although CA is a game that uses OTA content, it is currently working towards being TA-IP free.
|
| align="justify" | 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.
If you like complex warfare this is Your Mod.
|}

{| class="wikitable" border="0"
|-
| align="center" | <h2>[[XTA]]</h2>
| width=40 |
| align="center" | <h2>[[Balanced Annihilation]]</h2>
|-
| align="center" | {{navimg|xsize=300|ysize=225|image=XtaScreenShot.jpg|link=XTA}}
|
| align="center" | {{navimg|xsize=300|ysize=225|image=BAScreenShot.jpg|link=Balanced Annihilation}}
|-
| align="justify" | Originally developed as a Total Annihilation mod by the Swedish Yankspankers, XTA is the Original Public Mod released with first versions of Spring. Development of this mod by the SYs has stopped a while ago, but it is still played and actively developed by the community.
|
| align="justify" | A popular, highly balanced mod based on the late, immensely popular mod Absolute Annihilation. BA is designed for competitive 1v1 gameplay but is also perfectly suited for larger team games.
|}

----
=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" - in this case you will need to have [[Download|an installation of the Spring-Engine]], and place the file in the .../Spring/mods/ folder. If you are using a Lobby, this will often be able to do this for you automatically.

For an overview of information to get started, Click '''[[FAQ|Help]]'''.

=Game Development=

For information on creating games for the Spring engine, see the [[Mod_and_Unit_development|Game Making]] page.

[[Category: Games]]

Template:Navimg

2009-09-01T15:28:59Z

Seanheron: close, but no cigars...

<div style="position: relative; width: {{{xsize|{{{size|}}}}}}px; height: {{{ysize|{{{size|}}}}}}px; overflow: hidden;"><div style="position: absolute; top: 0; left: 0; font-size: 200pt; width: {{{xsize|{{{size|}}}}}}px; height: {{{ysize|{{{size|}}}}}}px; overflow: hidden; line-height: {{{ysize|{{{size|}}}}}}px; z-index: 3;">[[:{{{link|}}}|{{{linktext| }}}]]</div><div style="position: absolute; top: 0; left: 0; z-index: 2;">[[Image:{{{image|}}}|{{{xsize|{{{size|}}}}}}px|image page]]</div></div>

<noinclude>This is the format the template needs to be used in: <pre>{{navimgx|xsize=50|ysize=50|image=Wikimedia-logo.svg|link=Wikimedia}}</pre></noinclude>

Template:Navimg

2009-09-01T15:27:24Z

Seanheron: Doubt this is going to work, but worth a try

<div style="position: relative; width: {{{xsize|{{{size|}}}}}}px; height: {{{ysize|{{{size|}}}}}}px; overflow: hidden;"><div style="position: absolute; top: 0; left: 0; font-size: 200pt; width: {{{xsize|{{{size|}}}}}}px; height: {{{ysize|{{{size|}}}}}}px; overflow: hidden; line-height: {{{ysize|{{{size|}}}}}}px; z-index: 3;">[[{{{link|}}} {{{linktext| }}}]]</div><div style="position: absolute; top: 0; left: 0; z-index: 2;">[[Image:{{{image|}}}|{{{xsize|{{{size|}}}}}}px|image page]]</div></div>

<noinclude>This is the format the template needs to be used in: <pre>{{navimgx|xsize=50|ysize=50|image=Wikimedia-logo.svg|link=Wikimedia}}</pre></noinclude>

Category:Animation

2009-08-23T21:22:55Z

Seanheron: best? + Category

We might want to change this to something more catchy ? Animating ? Scripting (though that's a bit impresice...

[[Category:Development]]

Animation-LuaScripting

2009-08-23T21:21:28Z

Seanheron: hmm, not sure if "Animation" is the best of Category name choices...

== Getting started ==

=== Setup ===

Lua unit animation is implemented partially in the engine, and partially in a Lua gadget which is shipped with Spring in springcontent.sdz. By default, this gadget is not loaded, so a bit of setup is required to enable Lua unit scripts.

To enable Lua unit scripts, create a file ''LuaRules/Gadgets/unit_script.lua'', and paste the following into it:

{|border="0" cellpadding="4"
|style="background: #41545c; border: 1px #aaa solid;"|

-- Enables Lua unit scripts by including the gadget from springcontent.sdz

-- Uncomment to override the directory which is scanned for *.lua unit scripts.
--UNITSCRIPT_DIR = "scripts/"

return VFS.Include("LuaGadgets/Gadgets/unit_script.lua", nil, VFS.ZIP_ONLY)

|}

Now this is done, you can start putting *.lua files in your ''scripts/'' folder.

=== Workflow ===

Lua has the major advantage over BOS/COB that you do not need to compile it, which can reduce the time to develop scripts quite a bit.

To save further time, do not restart Spring for each small change. Simply run Spring in an window so you can easily switch between your editor and Spring, and use ''/luarules reload'' to reload all Lua unit scripts.

== Call-outs ==

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

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

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

=== Animation ===

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

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

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

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

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

Turn piece around axis to the destination angle. If speed is given, the piece isn't rotated immediately, but will turn at the desired angular velocity. Angles are in radians.

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

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

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

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

'''Spring.UnitScript.IsMoving''' ( unitID, piece, axis ) -> boolean 
'''Spring.UnitScript.IsTurning''' ( unitID, piece, axis ) -> boolean 
'''Spring.UnitScript.IsSpinning''' ( unitID, piece, axis ) -> boolean

Returns true iff the piece is moving along the axis, or turning/spinning around the axis.

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

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

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

Waits a number of milliseconds before returning.

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

Starts a new (animation) thread, which will execute the function 'fun'. All arguments after the function are passed as-is as arguments to 'fun'. A thread is just a Lua thread, ie. a coroutine, so please refer to the Lua documentation about coroutines for exact semantics.
=== Effects ===

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

Emits a particle from the given piece. The id may be one of:
TODO

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

Explodes a piece, optionally creating a particle which flies off. Typically used inside Killed. Explode does not hide the piece by itself; if using it outside Killed you may want to Hide the piece immediately after. The flags may be a combination of:
TODO

=== Other ===

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

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

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

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

Note that these are identical to Spring.GetUnitCOBValue and Spring.SetUnitCOBValue (see also [[Lua_SyncedCtrl#Lua_to_COB]] for the signature of those functions.)

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

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

== Call-ins ==

Call-ins are calls from the engine, into the unit script. In other words, these functions are called, if they are defined, when a particular â€œeventâ€ happens.

For Lua unit scripts, a new callin mechanism has been implemented, which is faster than the regular callin mechanism which is used for widgets and gadgets.

=== Generic ===

'''Create''' ( unitID ) -> nil

This is called just after the unit script has been created.

'''StartMoving''' ( unitID ) -> nil 
'''StopMoving''' ( unitID ) -> nil

These are called whenever the unit starts or stops moving. Typical use for them is to trigger wheels to start spinning, animate treads, or start/stop a walking animation.

'''Killed''' ( unitID, recentDamage, maxHealth ) -> number corpseType

This is called when the unit is killed. The severity of the kill may be calculated as severity=recentDamage/maxHealth. Typically, this function would play a death animation for the unit, and finally return a corpse type.

'''SetDirection''' ( heading ) -> nil
'''SetSpeed''' ( speed ) -> nil

Called only for wind generators and metal extractors.

For wind generators, both of these are called each time the wind changes. SetDirection receives the new wind direction and SetSpeed receives the new wind speed.

For metal extractors, only SetSpeed is called. It receives the amount of metal which will be extracted every second, and is called every time this amount changes. (Nearby overlapping metal extractor is destroyed, for example.)

'''QueryNanopiece''' ( unitID ) -> number piece

Called for factories and builders each time a nano particle is to be created. Should return the piece at which the particle will be spawned. This may be used to iterate through a few pieces, to simulate the factory/builder having multiple nanolathes.

'''setSFXOccupy''' ( number curTerrainType ) -> nil

I don't see any use for this. I'll probably remove this from Spring at some point. Called when terrain type changes. Terrain type is a number, calculated with the following rules (in this order):

* If unit is being transported -> curTerrainType = 0
* If ground height < -5 and unit is always upright -> curTerrainType = 2
* If ground height < -5 and unit is not always upright -> curTerrainType = 1
* If ground height < 0 and unit is always upright -> curTerrainType = 1
* Otherwise -> curTerrainType = 4

Where is curTerrainType = 3 ? :-)

'''QueryLandingPad''' ( ) -> { number piece1, number piece2, ... }

Called one time for units with landing pads. Should return a table with pieces which should be used as landing pads. The number of pieces returned also determines the number of pads, so for Lua unit scripts there is no QueryLandingPadCount.

=== Weapons ===

'''QueryWeapon1''' ( unitID ) -> number piece 
'''AimFromWeapon1''' ( unitID ) -> number piece 
'''AimWeapon1''' ( unitID, heading, pitch ) -> boolean 
'''FireWeapon1''' ( unitID ) -> nil

Weapon support. The suffix "1" should be replaced with the actual weapon number.
The return value of QueryWeapon and AimFromWeapon determines the pieces which will be used for aiming: typically e.g. the barrel for QueryWeapon and the turret for AimFromWeapon. AimWeapon is then called to allow the script to turn the weapons in the target direction, which is passed as the heading and pitch argument (in radians). Only if AimWeapon returns true, the weapon is actually fired, in which case FireWeapon will be called, to inform the script about this. FireWeapon may play a recoil animation or emit some smoke using EmitSfx, for example.

TODO: better explanation (?), note about AimWeapon being called very often etc.

'''RockUnit''' ( unitID, x, z ) -> nil

A bit like the weapon-specific FireWeapon function, this is called after any weapon fires. As argument it gets a two dimensional vector in the direction the unit just fired. This may be used to â€œrockâ€ the unit as a whole a bit as part of the firing animation. Note though that this vector is in world space, so for a truely realistic rock direction it needs to be rotated according to the unit's current heading.

'''HitByWeapon''' ( unitID, x, z ) -> nil
'''HitByWeaponId''' ( unitID, x, z, weaponDefID, damage ) -> nil | number newDamage

These are called if a unit has been hit by a weapon. (x, z) is the direction from which the projectile came in world space (the reverse direction of the impulse, to be exact.)

In addition, HitByWeaponId also gets the weaponDefID of the weapon which is dealing the damage, and the amount of damage. If HitByWeaponId returns a number, this number will replace the damage value calculated by the engine.

Note: these call-ins run just before the LuaRules UnitPreDamaged callin (see also [[LuaCallinReturn]]). If HitByWeaponId overrides the damage, UnitPreDamaged will see the new damage value, and may override again the damage value.

=== Transports ===

There are some different code paths inside Spring related to transports, each (unfortunately) also associated with a different set of unit script call-ins.

This table shows for the three different transportUnloadMethods for both air transports and ground transports which callins are used and roughly when and how often they are called. Refer to the documentation below for a description of the call-ins.

The entire behavior around transports should be considered subject to change; it is obvious it is far from a perfect design currently.

{|border="1" style="border-spacing:0px;"
|+
!
!Load
!UnloadLand (0)
!UnloadDrop (1)
!UnloadLandFlood (2)
|-
|
|
|default unload
|fly over and drop unit
|land, then release all units at once
|-
|air
|BeginTransport (each) QueryTransport (each)
|EndTransport (last)
|EndTransport (each)
|StartUnload (first) TransportDrop (each) EndTransport (last)
|-
|ground
|TransportPickup (each)
|TransportDrop (each)
|TransportDrop (each)
|TransportDrop (each) EndTransport (last)
|}

==== Air transports ====

'''BeginTransport''' ( unitID, passengerID ) -> nil 
'''QueryTransport''' ( unitID, passengerID ) -> number piece

For an air transport, if any one unit is picked up, these two are called in succession and the passenger is attached to the piece returned by the second one.

'''StartUnload''' ( unitID ) -> nil

Only called in UnloadLandFlood behavior. Signals the start of an unload cycle.

'''TransportDrop''' ( unitID, passengerID, x, y, z ) -> nil

Only called in UnloadLandFlood behavior. Called when a passenger will be unloaded. Contrary to ground transports, Spring will detach the passenger after the call.

'''EndTransport''' ( unitID ) -> nil

In UnloadLand and UnloadLandFlood behaviors, these are called one time after all units are unloaded. (The transport is empty.) For the UnloadDrop behavior, this is called for every unit that is unloaded.

==== Ground transports ====

'''TransportPickup''' ( unitID, passengerID ) -> nil

Called when a passenger should be loaded into the transport. This should eventually call AttachUnit to actually attach the unit. Assuming the transport is in range of the next passenger, this will be called again for the next passenger 16 frames later, ''unless'' the script enters the BUSY state: then Spring will not move on to the next passenger until the script leaves the BUSY state.

'''TransportDrop''' ( unitID, passengerID, x, y, z ) -> nil

Called when a passenger should be unloaded. This should eventually call DetachUnit to actually detach the unit, ''unless'' the used unload method is UnloadLandFlood, in which case Spring will actually detach the unit after the call.

'''EndTransport''' ( unitID ) -> nil

Only called in UnloadLandFlood behavior, after the last unit has been unloaded.

==== Passenger ====

'''Falling''' ( unitID ) -> nil

For a unit dropped from an UnloadDrop transport, this is called every frame to inform the script the unit is still falling. It may be used to show a parachute for example.

'''Landed''' ( unitID ) -> nil

This is called one time after the unit reached the ground. May be used to hide a parachute for example.

[[Category:Animation]]

Lua Unit Scripting

2009-08-23T21:18:00Z

Seanheron: Lua Unit Scripting moved to Animation-LuaScripting: moved as per naming convention

#REDIRECT [[Animation-LuaScripting]]

Animation-LuaScripting

2009-08-23T21:18:00Z

Seanheron: Lua Unit Scripting moved to Animation-LuaScripting: moved as per naming convention

Animation:CobHitByWeaponID

2009-08-23T21:12:59Z

Seanheron: delete

#REDIRECT [[Animation-CobHitByWeaponID]]
{{delete}}

Animation:CobThreads

2009-08-23T21:12:52Z

Seanheron: delete

#REDIRECT [[Animation-CobThreads]]
{{delete}}

Animation:CobConstants

2009-08-23T21:12:43Z

Seanheron: delete

#REDIRECT [[Animation-CobConstants]]
{{delete}}

Animation:CobCallins

2009-08-23T21:12:36Z

Seanheron: delete

#REDIRECT [[Animation-CobCallins]]
{{delete}}

Animation:CobAnimation

2009-08-23T21:12:29Z

Seanheron: delete

#REDIRECT [[Animation-CobAnimation]]
{{delete}}

Game and Unit development

2009-08-23T21:11:30Z

Seanheron: fix links

=Mod development=
Mods, next to Maps, is the content used in Spring. 
A mod is simply a combined file containing a small structure of files and directories holding all the data required. 

[[Mod_Development | Mod Development]] wiki is a starting page, linking to very useful information on the files included in a mod, their hierarchy and more.
 

Almost the entire mod developing is the creation of units. Which isn't an easy job. 
Information about the creation of units are everywere, but not combined. 
This is a gathered list of all Tutorials and helpfull forums threads I could find: 

==General==
*[[Mod Development]]
*[[Mod specification]] 
*[http://spring.clan-sy.com/phpbb/viewtopic.php?t=6015 What do I need to create a mod]
*[[Simple Mod Tutorial]]
*[[Freely available and reusable content|Freely available and reusable content/games/mods]]
*[[tools & software for make :map mod unit]]

==Unit Development==
====Automated Mod Creation====
* [[TA2Spring]] - Automatically adds and converts Total Annihilation unit packs (.ufo files, etc..) into Spring mods (requires a base modification for the game rules, XTA is recommended)
====Models - s3o Files====
*[http://user.supradigital.org/jcnossen/UpspringInstaller-1.54-EulerAngles.exe UpSpring, our second-gen import / export / rigging / animation tool.]
* [http://lassie.student.utwente.nl/vliet/springtut.pdf Maestro's tutorial of Upspring and textures].
* [[Basic s3o unit making guide]]
* [[Simple Mod Tutorial]]
* [[Units:CreateModel|UV Mapping in Wings3D]]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10612 Wings UV Mapping Tutorial]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?f=9&t=12354 Saving polygons in Wings3d Tutorial]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10947 Greeble Tutorial 1]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?f=9&t=12356 Greeble Tutorial 2]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?p=75495 various things about unit making. (Also contains an illustrated alpha-channel tut)]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10503 Runecrafter's 3DS Max UV Mapping Tutorial]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?f=9&t=15106 Argh's UpSpring Easy Workflow Guide]
* [[Trouble-shooting s3o units]]

====Models - 3do Files====
outdated model format used by OTA 
(Note: UpSpring has some problems with empty objects and groundplates)
*use [http://spring.clan-sy.com/phpbb/viewtopic.php?f=12&t=7208&p=126129&hilit=upspring#p126129 UpSpring] and [http://www.fileuniverse.com/?p=show&a=it&id=305 3doBuilder] to edit those files

====Scripting and Animation - COB/BOS Files====
To edit those you need a program/compiler. The most famous one is [http://jobjol.nl/1384 Scriptor]
***[[Animation-CobOverview]]
***[[Animation-CobExamples]]
***[[Animation-CobAnimation]]
***[[Animation-CobCallins]]
***[[Animation-CobConstants]]
***[[Animation-CobThreads]]
***[[Animation-CobHitByWeaponID]]
*[http://www.planetannihilation.com/tadc/tut_unit_01_1.asp PlanetAnnihilation] has a nice tutorial
*[[Units:LuaCOB]] - how to interface COB with LUA
*[[CEG_For_Units|Mod Development:Calling basic CEGs from COB]]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?p=132943#132943 GPL-compliant sourcecode, scripting code examples, and other things.]

====Units - FBI Files====
*[[Units:FBI]]
*[[All_FBI-variable_values:_min,_max,_default,_type|Units:FBI (variable datatype list)]]
*[[Unit_Categories]]

====Weapons - TDF Files====
*[[Weapon Variables]] : This is the most up to date
*[[Units:WeaponMainDir]]
*[[Units:Weapons]] : Various informations about the weapontypes (uncompleted)
*[[All_Weapons_variable_values:_min%2C_max%2C_default%2C_type|Weapon datatype list]] : All weapon variables min/max/default values and datatypes listed.
*[[Weapons:Antinukes]]: All about antinukes.

====Explosions====
*[[CEG]]
**[[CEG-Calls]]
**[[CEG-Format]]
**[[CEG-Classes]]
**[[CEG-Operators]]
**[[CEG-Miscellaneous]]
**[[CEG-OldInfo]]

====Misc====
*[[Units:Design]]
*[[Units:Textures]]
*[[Units:Buildpics]]
*[[Units:SideData TDF]]
*[[Units:Download TDF]]
*[[Units:FlankingBonus]]
*[[Mod Development:Armor]]
*[[Mod Development:Cursors]]
*[[Mod Development:Archives]]
*[[Mod Development:Sidepics]]
*[[CustomUnitIcons|Mod Development:Custom unit icons]]

Animation-CobOverview

2009-08-23T21:10:39Z

Seanheron: fixed links I hadn't fixed properly...

==What is COB?==

COB is the Spring engine's scripting system. Each unit has a .cob bitfile which defines many of its major behaviors, including animation and weapon aiming. Of course, COB is also capable of doing a lot more if you wish. When Spring is actually running, it interprets the bitfile for each unit as necessary. This interpreter runs in a very straightforward way, without any fancy optimizations, so don't expect great performance from it.

==BOS==

The code that gets compiled into a .cob is written in a .bos file. A program called Scriptor generally does this compilation. BOS uses a C-like syntax, although it has many Spring-specific features and isn't as powerful as C.

===BOS versus C===

Similarities:
*Function syntax. A function is defined by FunctionName(args).
*Block delimiters. Like C, a statement block is delimited by curly braces ({}).
*General syntax. For example, to add two variables and assign the result to a third, you say x = y + z;

Differences:
*Not case sensitive.
*Only one data type. There is only one type of data in COB, which is basically a 32-bit integer.
*Variable declaration.

You can declare a static variable, whose scope encompasses the entire script, using

static-var x;

You can declare multiple variables at once by separating them with commas.

Alternately, you can declare a local variable:

var x;

The scope is limited to the function that it is in.
*No pointers or arrays.
*No internal return values. When the script receives a callin, it may return a value to the "outside"; however, there is no way to return a value directly to another function within the script. You will have to use a static variable.
*Function calls.

Functions are called using

call-script Function(args);

or

start-script Function(args);

See [[Animation-CobThreads|COB-Threads]] for details.
*Multiple threads. This isn't as exciting as it sounds. Again, see [[Animation-CobThreads|COB-Threads]] for details.
*Spring-specific features. There are too many here to name; please consult the other COB articles.

==Further information==
Greater detail can be found on the following pages
*[[Animation-CobExamples]]
*[[Animation-CobAnimation]]
*[[Animation-CobCallins]]
*[[Animation-CobConstants]]
*[[Animation-CobHitByWeaponID]]

[[Category:Animation]]

Animation-CobOverview

2009-08-23T21:08:52Z

Seanheron: fix link and add links + category

==What is COB?==

COB is the Spring engine's scripting system. Each unit has a .cob bitfile which defines many of its major behaviors, including animation and weapon aiming. Of course, COB is also capable of doing a lot more if you wish. When Spring is actually running, it interprets the bitfile for each unit as necessary. This interpreter runs in a very straightforward way, without any fancy optimizations, so don't expect great performance from it.

==BOS==

The code that gets compiled into a .cob is written in a .bos file. A program called Scriptor generally does this compilation. BOS uses a C-like syntax, although it has many Spring-specific features and isn't as powerful as C.

===BOS versus C===

Similarities:
*Function syntax. A function is defined by FunctionName(args).
*Block delimiters. Like C, a statement block is delimited by curly braces ({}).
*General syntax. For example, to add two variables and assign the result to a third, you say x = y + z;

Differences:
*Not case sensitive.
*Only one data type. There is only one type of data in COB, which is basically a 32-bit integer.
*Variable declaration.

You can declare a static variable, whose scope encompasses the entire script, using

static-var x;

You can declare multiple variables at once by separating them with commas.

Alternately, you can declare a local variable:

var x;

The scope is limited to the function that it is in.
*No pointers or arrays.
*No internal return values. When the script receives a callin, it may return a value to the "outside"; however, there is no way to return a value directly to another function within the script. You will have to use a static variable.
*Function calls.

Functions are called using

call-script Function(args);

or

start-script Function(args);

See [[COB-Threads]] for details.
*Multiple threads. This isn't as exciting as it sounds. Again, see [[COB-Threads]] for details.
*Spring-specific features. There are too many here to name; please consult the other COB articles.

==Further information==
Greater detail can be found on the following pages
*[[Animation-CobExamples]]
*[[Animation-CobAnimation]]
*[[Animation-CobCallins]]
*[[Animation-CobConstants]]
*[[Animation-CobThreads]]
*[[Animation-CobHitByWeaponID]]

[[Category:Animation]]

Animation:CobOverview

2009-08-23T21:06:35Z

Seanheron: delete

#REDIRECT [[Animation-CobOverview]]
{{delete}}

Animation:CobHitByWeaponID

2009-08-23T21:05:39Z

Seanheron: Animation:CobHitByWeaponID moved to Animation-CobHitByWeaponID: oops

#REDIRECT [[Animation-CobHitByWeaponID]]

Animation-CobHitByWeaponID

2009-08-23T21:05:39Z

Seanheron: Animation:CobHitByWeaponID moved to Animation-CobHitByWeaponID: oops

'''HitByWeaponId(z,x,weapon_id,shot_power)'''

The z and x angles are not returned unless the impulse of the weapon is high enough to move the unit.

The weapon_id is the "id=xxx" from the weapon information in the weapon tdf.

Always return(100); or the weapon won't deal full damage.

Animation:CobThreads

2009-08-23T21:05:30Z

Seanheron: Animation:CobThreads moved to Animation-CobThreads: oops

#REDIRECT [[Animation-CobThreads]]

Animation-CobThreads

2009-08-23T21:05:30Z

Seanheron: Animation:CobThreads moved to Animation-CobThreads: oops

==Source==

https://spring.clan-sy.com/svn/spring/trunk/rts/Sim/Units/COB/CobThread.cpp

==Introduction==

Much of the time you can expect your script to execute sequentially; that is, looking through your code, the system progresses from statement to statement without anything "strange" (variables being changed, threads being started, etc.) between them. HOWEVER, "strange" things do happen, and in fact they happen quite regularly in scripts. We say that the script system has "concurrency" when things can happen between statements.

===Why Concurrency?===
So why go to all this trouble with concurrency? The script system has concurrency because we never know when things are going to happen. The player could give a command to the unit, the unit could run into a wall, rocks could fall out of the sky and kill the unit, and so forth. Without concurrency we would have to check very often whether which of all possible events had happened recently in order to determine what to do next. This would suck.

==Dealing With Concurrency==
Every time a callin is called or a start-script statement is executed, a "thread" is created. At any one time, only one thread is being executed at a time, but sometimes a thread will stop executing for a while and continue later, while several other threads will execute in the meantime. Most of the time your script is guaranteed to execute sequentially. If you say x = 1;, it will stay 1 unless you change it again. The exceptions are as follows:

*Before a script starts.
*After a wait-for-move or wait-for-turn statement.
*After a sleep statement.

During these times, any other thread has the ability to come in and change all your static variables, tell your pieces to move, turn, and spin, and so forth. Therefore, you cannot always assume these things will be the way you left them when execution of the thread resumes. If it is possible that another thread will change something that you need to know about, you need to check it after any of these times.

==Sleeping==

You can have a thread sleep by using a sleep statement:

sleep [time in ms];

This is useful for delaying events and in making loops execute every so often. If you want to wait until a piece moves into position, use wait-for-move or wait-for-turn instead.

==Signals==

Signals provide a way to kill threads in their sleep. Signals are bitmasks. There are two statement types dealing with signals: signal and set-signal-mask.

signal [bitmask];

kills all sleeping threads that overlap the bitmask.

set-signal-mask [bitmask];

sets what signals kill the current thread.

This has several applications. For functions that are called regularly, such as AimWeaponX(), this prevents multiple copies of the same thread from running at the same time. It is also a way (but not the only or necessarily best way) to interrupt another thread.

==call-script==

Use as follows:

call-script [function]([args]);

This does not start a new thread! The calling function will not continue until the called function returns.

==start-script==

At first glance, this is similar to call-script:

start-script [function]([args]);

However, start-script ''does'' create a new thread, and the calling function ''doesn't'' wait until the started function returns before continuing. By default, the new thread shares the same signal mask as its parent, although you can set it manually if you like. Apart from this, the two threads execute completely independently.

Animation:CobConstants

2009-08-23T21:05:22Z

Seanheron: Animation:CobConstants moved to Animation-CobConstants: oops

#REDIRECT [[Animation-CobConstants]]

Animation-CobConstants

2009-08-23T21:05:22Z

Seanheron: Animation:CobConstants moved to Animation-CobConstants: oops

==Source==

This has a list of all COB SET/GET constants: http://github.com/spring/spring/blob/master/rts/Sim/Units/COB/CobInstance.cpp

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

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

Animation:CobCallins

2009-08-23T21:05:11Z

Seanheron: Animation:CobCallins moved to Animation-CobCallins: oops

#REDIRECT [[Animation-CobCallins]]

Animation-CobCallins

2009-08-23T21:05:11Z

Seanheron: Animation:CobCallins moved to Animation-CobCallins: oops

==Source==

Some (but not all) are listed near the end of this file: https://spring.clan-sy.com/svn/spring/trunk/rts/Sim/Units/COB/CobFile.cpp

==Purpose==
Callins have two purposes:

First, they allow a script to be notified when an event happens, such as the unit being created or destroyed.

Second, they allow the engine to get information from the script. Sometimes this is accomplished through a return value, but usually this is done by setting one of the arguments to a function to the requested value.

==Callins==

===General===

*Create(): Called when the unit is created. "Created" means when the unit's nanoframe is created; if you want to wait until the unit is actually finished, you'll have to use something like

while(GET BUILD_PERCENT_LEFT) sleep 250;

*Activate()/Deactivate(): Called when the unit is turned on/off.
*Killed(severity, corpsetype): Called when the unit is killed. Severity indicates how many percent of the unit's hit points were dealt by the final blow. Corpsetype basically indicates the number of times the unit and its corpses are destroyed; for example, corpsetype = 3 acts as if the unit is destroyed, the corpse is destroyed, and the corpse's corpse is destroyed. If it runs out of corpses nothing is left behind. Set corpsetype to the desired value.

===Movement===

*StartMoving()/StopMoving(): Called when the unit starts/stops moving. This includes rotation, so don't be surprised if StartMoving() sometimes gets called when a unit starts aiming at a target.
*SetSFXOccupy(terraintype): Supposedly called when the unit changes terrain type, although it didn't work last time I tried it? Maybe I was using it wrong. terraintype: 0 = transported, 1 = sea, 2 = deep sea (greater than 5 water depth and unit is upright), 4 = land.
*MoveRate[0...3](): Appears to be the aircraft equivalent of SetSFXOccupy. MoveRate3 doesn't appear to actually be used. MoveRate1 is called when the aircraft takes off or lands. If the aircraft is not taking off or landing, MoveRate0 is called when the aircraft drops below 1/3 maximum speed, MoveRate2 is called when the aircraft exceeds 2/3 maximum speed, and MoveRate1 is called when the aircraft enters within 1/3-2/3 maximum speed. I don't know if this actually works.
*SetDirection(heading): Used only for wind generators. Gives the direction of the wind.
*SetSpeed(speed): Used for wind generators, tidals, and mexes. Basically more resources = higher speed.

===Weapons===

For weapons, X means either the number of the weapon, or "Primary", "Secondary", or "Tertiary" (don't put "Weapon" for these). I recommend using numbers, since it's cleaner and you can use more than three weapons that way.

*AimWeaponX(heading, pitch): Called every ~0.5s when the unit is aiming the weapon at a target. This is used to turn a unit's turrets toward the target. Return 1 when the weapon is ready to fire. Alternately, return 0 if you don't want the weapon to fire (you can use this to disable weapons).
*AimFromWeaponX(piecenum): You should set piecenum to a piece of the model; LOS is traced from the here to the target to see if the weapon can fire.
*FireWeaponX(): Called whenever the trigger is pulled on a weapon. This occurs before the ''first'' shot in a burst/projectile salvo (only).
*ShotX(): Called before every shot a weapon fires. This includes burst and projectile tags. This happens after FireWeaponX(), even for the first shot.
*QueryWeaponX(piecenum): You should set piecenum to a piece of the model. The shot starts from this piece of the model; this is called for this purpose after FireWeaponX() and ShotX(). LOS is also traced from here to the target to see if a weapon can fire. Make sure this is a piece on the weapon's turret. Not doing this right can cause headaches; example: http://trac.caspring.org/wiki/GunsJammingOnShips
*EndBurstX(): Called after the last shot in a burst.
*BlockShotX(unitID, block)
*TargetWeightX(unitID, weightMod)
*RockUnit(anglex, anglez): Called when the unit fires. Use it to rock the unit on firing, although there are other ways to do this.
*HitByWeaponID(damage, weaponid?, unitid?): Called when the unit is hit by a weapon.
*SetMaxReloadTime(time): Called on unit creation. time is the time in ms that it takes the slowest-firing weapon to reload.

===Construction===

*StartBuilding(): Called when the unit starts building.
*StopBuilding(): Called when the unit stops building.
*QueryNanoPiece(piecenum): You should set piecenum to the piece you want the nanospray to come from.
*QueryBuildInfo(piecenum): For factories. You should set piecenum to the piece you want the unit to be built on.

===Transportation===
*Falling(): Used for airdropping units?
*Landed(): Used for airdropping units?
*QueryTransport(piecenum): You should set piecenum to the piece you want the transported unit to be attached to.
*BeginTransport(): Called when an air transport picks up a unit.
*EndTransport(): Called when an air transport becomes empty.
*TransportPickup(): Called when a land transport picks up a unit.
*TransportDrop(): Called when a land transport becomes empty.
*StartUnload(): Called when the transport starts the unloading process.

===Landing Pads===
*QueryLandingPadCount(count): You should set count to the number of landing pads. However, it doesn't seem to be actually necessary to do this unless you want more than 16 pads.
*QueryLandingPad(piecenum1, piecenum2, piecenum3...): Set each piecenum to a different landing pad piece.

Animation:CobAnimation

2009-08-23T21:05:01Z

Seanheron: Animation:CobAnimation moved to Animation-CobAnimation: oops

#REDIRECT [[Animation-CobAnimation]]

Animation-CobAnimation

2009-08-23T21:05:01Z

Seanheron: Animation:CobAnimation moved to Animation-CobAnimation: oops

==Pieces==

Each unit has a root piece and a tree of other pieces attached to the root piece. At the top of each file you'll need to put the following line:

piece [names of pieces of the model separated by commas];

As usual, capitalization does not matter; neither does the order of the pieces. You do not need to name every piece that the model actually has, although you should do so, and you cannot do anything to a piece that you have not named. If you try to do something to a piece that doesn't exist, Spring will throw an error. Generally it will not crash but you'll probably get lots of chat spam, so avoid this.

Every piece starts in the position as it appears in any modeling program, such as Upspring. This is defined to be zero position and zero rotation.

Pieces are really numbers, although Scriptor usually throws a fit if you try to use them as numbers (it will not accept a number in places where it expects a piece name, although for functions that involve a piecenum you can use the piece's number instead of the piece name if you so desire). The first piece you list is 0, and it counts from there.

==Linear Units==

Everything linear ''really'' happens in a unit I'll call Spring distance (sd). This is a tiny distance--there are 216 = 65536 sd in an elmo, which is the unit that is most commonly used. For example, weapon ranges are specified in elmos. Fortunately, Scriptor can automatically convert elmos to sd: just put the number of elmos you want in brackets ([]). Sometimes you'll see scripts that use 2.5 * 216 = 163840 instead. I recommend not doing this since it makes conversion more difficult.

==Angular Units==

Likewise, everything angular ''really'' happens in a unit I'll call Spring angle (sa). There are 216 sa in a full circle. Generally you'll be working in degrees. There are 182 and 2/45 sa in a degree. Again, Scriptor can automatically convert from degrees to sa; just put the number of degrees you want in angles (<>).

==Axes==

All COB animation statements specify an axis. There are three axes, "x-axis", "y-axis", and "z-axis". Positive x is to the unit's left (the right if you are looking at the unit from the front). Positive y is to the unit's top. Positive z is to the unit's front.

The position and rotation of each piece defines the coordinate system for all of its child pieces. So, if you move or rotate a piece, all of its child pieces will move and rotate with it.

A positive angle is counterclockwise looking at the piece from the positive end of the axis toward the negative end of the axis.

==move==

move [piece] to [axis] [distance] now;

This moves the piece immediately. The piece will be in its new position along the axis before the next statement is executed.

move [piece] to [axis] [distance] speed [speed];

This moves the piece at some speed until it reaches its destination, or the piece is told to move to a different distance along the same axis, whichever comes first. After this statement, the piece moves independent of the script; indeed, the script proceeds immediately to the next statement after it sets the piece moving.

Speed is always positive, even if you are moving the piece to a negative distance. It is measured in Spring distance/second (sd/s).

wait-for-move [piece] along [axis];

Makes the thread sleep until the piece stops moving along the axis.

==turn==

These are similar to movement in behavior, except they rotate the piece.

turn [piece] to [axis] [angle] now;

Turns the piece to the specified angle around the axis immediately. The piece will be in its new rotation around the axis before the next statement is executed. Pieces rotate around their own center, not their parent's (although if the parent rotates, they do as well). If the piece moves, the center moves with it, so a piece's movement occurs "before" its rotation in determining its final position.

turn [piece] to [axis] [angle] speed [angular speed];

This turns the piece at some angular speed until it reaches its destination, or the piece is told to turn to a different distance around the same axis, whichever comes first. Angular speed is always positive, even if the angle is negative. The speed is in Spring angles/second (sa/s).

wait-for-turn [piece] around [axis];

Makes the thread sleep until the piece stops turning around the axis.

==spin==

spin [piece] around [axis] speed [angular speed];

This starts the piece spinning at a constant speed immediately. Again, the speed is in Spring angles/second (sa/s); however, it can be negative if you want it to spin in that direction.

spin [piece] around [axis] speed [angular speed] accelerate [angular acceleration];

The angular acceleration should always be positive, even if you are spinning the piece at a negative angular speed. It is measured in Spring angles per frame-second (sa/f*s); in other words, the speed of the piece will increase by that amount every ''frame'', not every second. There are 30 frames per second.

stop-spin [piece] around [axis];

Stops the piece from spinning immediately, regardless of its orientation.

stop-spin [piece] around [axis] decelerate [angular deceleration];

Slows the piece's spinning down until it stops. As with angular acceleration, the angular deceleration should always be positive and is measured in Spring angles per frame-second.

Animation:CobOverview

2009-08-23T21:04:27Z

Seanheron: Animation:CobOverview moved to Animation-CobOverview: oops - got confused with my own convention :P

#REDIRECT [[Animation-CobOverview]]

Animation-CobOverview

2009-08-23T21:04:27Z

Seanheron: Animation:CobOverview moved to Animation-CobOverview: oops - got confused with my own convention :P

==What is COB?==

COB is the Spring engine's scripting system. Each unit has a .cob bitfile which defines many of its major behaviors, including animation and weapon aiming. Of course, COB is also capable of doing a lot more if you wish. When Spring is actually running, it interprets the bitfile for each unit as necessary. This interpreter runs in a very straightforward way, without any fancy optimizations, so don't expect great performance from it.

==BOS==

The code that gets compiled into a .cob is written in a .bos file. A program called Scriptor generally does this compilation. BOS uses a C-like syntax, although it has many Spring-specific features and isn't as powerful as C.

===BOS versus C===

Similarities:
*Function syntax. A function is defined by FunctionName(args).
*Block delimiters. Like C, a statement block is delimited by curly braces ({}).
*General syntax. For example, to add two variables and assign the result to a third, you say x = y + z;

Differences:
*Not case sensitive.
*Only one data type. There is only one type of data in COB, which is basically a 32-bit integer.
*Variable declaration.

You can declare a static variable, whose scope encompasses the entire script, using

static-var x;

You can declare multiple variables at once by separating them with commas.

Alternately, you can declare a local variable:

var x;

The scope is limited to the function that it is in.
*No pointers or arrays.
*No internal return values. When the script receives a callin, it may return a value to the "outside"; however, there is no way to return a value directly to another function within the script. You will have to use a static variable.
*Function calls.

Functions are called using

call-script Function(args);

or

start-script Function(args);

See [[COB_Threads]] for details.
*Multiple threads. This isn't as exciting as it sounds. Again, see [[COB_Threads]] for details.
*Spring-specific features. There are too many here to name; please consult the other COB articles.

COB HitByWeaponID

2009-08-23T20:58:29Z

Seanheron: COB HitByWeaponID moved to Animation:CobHitByWeaponID: convention

#REDIRECT [[Animation:CobHitByWeaponID]]

Animation-CobHitByWeaponID

2009-08-23T20:58:29Z

Seanheron: COB HitByWeaponID moved to Animation:CobHitByWeaponID: convention

COB Threads

2009-08-23T20:58:01Z

Seanheron: COB Threads moved to Animation:CobThreads: convention

#REDIRECT [[Animation:CobThreads]]

Animation-CobThreads

2009-08-23T20:58:01Z

Seanheron: COB Threads moved to Animation:CobThreads: convention

COB Constants

2009-08-23T20:57:48Z

Seanheron: COB Constants moved to Animation:CobConstants: convention

#REDIRECT [[Animation:CobConstants]]

Animation-CobConstants

2009-08-23T20:57:48Z

Seanheron: COB Constants moved to Animation:CobConstants: convention

COB Callins

2009-08-23T20:57:31Z

Seanheron: COB Callins moved to Animation:CobCallins: convention

#REDIRECT [[Animation:CobCallins]]

Animation-CobCallins

2009-08-23T20:57:31Z

Seanheron: COB Callins moved to Animation:CobCallins: convention

COB Animation

2009-08-23T20:57:13Z

Seanheron: COB Animation moved to Animation:CobAnimation: convention

#REDIRECT [[Animation:CobAnimation]]

Animation-CobAnimation

2009-08-23T20:57:13Z

Seanheron: COB Animation moved to Animation:CobAnimation: convention