Lua API

Overview

We list here all globals available among all different lua environments within Recoil. Some types listed here exist only as helpers for aliasing parameters and returns.

The documentation pages are still a work in progress.

Spring (table)

Members

Spring.Echo (function)

Prints values in the spring chat console. Useful for debugging.

Hint: the default print() writes to STDOUT.

[source]

Spring.Echo(any, [any, ]*) -> nil

Parameters

anyarg

any...

Returns

nil

Spring.Log (function)

Logs a message to the logfile/console.

[source]

Spring.Log(string, (LogLevel|LOG)?, [string, ]*) -> nil

Parameters

stringsection

Sets an arbitrary section. Level filtering can be applied per-section

(LogLevel|LOG)?logLevel

(Default: “notice”)

string...

messages

Spring.RequestPath (function)

Spring.RequestPath((integer|string), number, number, number, number, number, number, number?) -> userdata?

Parameters

(integer|string)moveID

numberstartX

numberstartY

numberstartZ

numberendX

numberendY

numberendZ

number?radius

Returns

userdata?path

Spring.InitPathNodeCostsArray (function)

Spring.InitPathNodeCostsArray(integer, integer, integer) -> boolean

Parameters

integeroverlayIndex

integersizeX

integersizeZ

Returns

booleansuccess

Spring.FreePathNodeCostsArray (function)

Spring.FreePathNodeCostsArray(integer) -> boolean

Parameters

integeroverlayIndex

Returns

booleansuccess

Spring.SetPathNodeCosts (function)

Spring.SetPathNodeCosts(integer) -> boolean

Parameters

integeroverlayIndex

Returns

booleansuccess

Spring.GetPathNodeCosts (function)

Spring.GetPathNodeCosts(integer) -> (boolean|table)

Parameters

integeroverlayIndex

Returns

(boolean|table)costs

Spring.SetPathNodeCost (function)

Spring.SetPathNodeCost(integer, integer, number) -> boolean

Parameters

integeroverlayIndex

integercostIndex

0-based index in the overlay

numbercost

Returns

booleansuccess

Spring.GetPathNodeCost (function)

Spring.GetPathNodeCost(integer, integer) -> number

Parameters

integernodeX

Heightmap node X coordinate

integernodeZ

Heightmap node Z coordinate

Returns

numbercost

Spring.GetMetalMapSize (function)

Spring.GetMetalMapSize() -> integer, integer

Returns

integerx

X coordinate in worldspace / Game.metalMapSquareSize.

integerz

Z coordinate in worldspace / Game.metalMapSquareSize.

Spring.GetMetalAmount (function)

Returns the amount of metal on a single square.

[source]

Spring.GetMetalAmount(integer, integer) -> number

Parameters

integerx

X coordinate in worldspace / Game.metalMapSquareSize.

integerz

Z coordinate in worldspace / Game.metalMapSquareSize.

Returns

numberamount

Spring.SetMetalAmount (function)

Sets the amount of metal on a single square.

[source]

Spring.SetMetalAmount(integer, integer, number) -> nil

Parameters

integerx

X coordinate in worldspace / Game.metalMapSquareSize.

integerz

Z coordinate in worldspace / Game.metalMapSquareSize.

numbermetalAmount

must be between 0 and 255*maxMetal (with maxMetal from the .smd or mapinfo.lua).

Returns

nil

Spring.GetMetalExtraction (function)

Spring.GetMetalExtraction(integer, integer) -> number

Parameters

integerx

X coordinate in worldspace / Game.metalMapSquareSize.

integerz

Z coordinate in worldspace / Game.metalMapSquareSize.

Returns

numberextraction

Spring.SetAlly (function)

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

[source]

Spring.SetAlly(AllyTeamID, AllyTeamID, boolean) -> nil

Parameters

AllyTeamIDfirstAllyTeamID

AllyTeamIDsecondAllyTeamID

booleanally

Returns

nil

Spring.SetAllyTeamStartBox (function)

Changes the start box position of an allyTeam.

[source]

Spring.SetAllyTeamStartBox(AllyTeamID, number, number, number, number) -> nil

Parameters

AllyTeamIDallyTeamID

numberxMin

left start box boundary (elmos)

numberzMin

top start box boundary (elmos)

numberxMax

right start box boundary (elmos)

numberzMax

bottom start box boundary (elmos)

Returns

nil

Spring.AssignPlayerToTeam (function)

Assigns a player to a team.

[source]

Spring.AssignPlayerToTeam(PlayerID, TeamID) -> nil

Parameters

PlayerIDplayerID

TeamIDteamID

Returns

nil

Spring.SetTeamStartPosition (function)

Set the starting position of a team.

If the position argument is outside the team’s startbox, the position is clamped.

[source]

Spring.SetTeamStartPosition(TeamID, number, number, number) -> boolean

Parameters

TeamIDteamID

numberx

left position (elmos)

numbery

vertical position (elmos)

numberz

top position (elmos)

Returns

booleansuccess

true if the position was set, false if the teamID is invalid

Spring.SetPlayerReadyState (function)

Set the ready state of a player.

Use to mark a player (un)ready in the pregame phase.

[source]

Spring.SetPlayerReadyState(PlayerID, boolean) -> boolean

Parameters

PlayerIDplayerID

booleanready

Returns

booleansuccess

true if the state was set, false if the playerID was invalid

Spring.SetGlobalLos (function)

Changes access to global line of sight for a team and its allies.

[source]

Spring.SetGlobalLos(AllyTeamID, boolean) -> nil

Parameters

AllyTeamIDallyTeamID

booleangloballos

Returns

nil

Spring.SetCheatingEnabled (function)

Changes whether activating cheats is allowed. Note that already activated cheats (e.g. god mode) stay active even if you disallow activating.

[source]

Spring.SetCheatingEnabled(boolean) -> nil

Parameters

booleancheatsEnabled

Returns

nil

Spring.SetGodMode (function)

Toggles ‘god mode’, i.e. whether control of teams other than one’s own is allowed. Affects all teams.

[source]

Spring.SetGodMode(boolean?, boolean?) -> nil

Parameters

boolean?controlAllies

boolean?controlEnemies

Returns

nil

Spring.KillTeam (function)

Will declare a team to be dead (no further orders can be assigned to such teams units).

[source]

Gaia team cannot be killed.

Spring.KillTeam(TeamID) -> nil

Parameters

TeamIDteamID

Returns

nil

Spring.GameOver (function)

Declare game over.

[source]

Spring.GameOver(AllyTeamID[]) -> integer

Parameters

AllyTeamID[]winningAllyTeamIDs

A list of winning ally team IDs.

Pass multiple winners to declare a draw. Pass no arguments if undecided (e.g. when dropped from the host).

Returns

integerteams

Number of accepted (valid) ally teams.

Spring.SetTidal (function)

Set tidal strength

[source]

Spring.SetTidal(number?) -> nil

Parameters

number?strength

Returns

nil

Spring.SetWind (function)

Set wind strength

[source]

Spring.SetWind(number?, number?) -> nil

Parameters

number?minStrength

number?maxStrength

Returns

nil

Spring.AddTeamResource (function)

Adds metal or energy resources to the specified team. Counts as production in post-game graph statistics.

[source]

Spring.AddTeamResource(TeamID, ResourceName, number) -> nil

Parameters

TeamIDteamID

ResourceNametype

numberamount

Returns

nil

Spring.UseTeamResource (function)

Consumes metal or energy resources of the specified team. Counts as usage in post-game graph statistics.

[source]

Spring.UseTeamResource(TeamID, ResourceName, number) -> boolean

Parameters

TeamIDteamID

ResourceNametype

Resource type.

numberamount

Amount of resource to use.

Returns

booleanhadEnough

Spring.UseTeamResource (function overload 1)

Consumes metal and/or energy resources of the specified team. Counts as usage in post-game graph statistics.

[source]

Spring.UseTeamResource(TeamID, ResourceUsage) -> boolean

Parameters

TeamIDteamID

ResourceUsageamount

Returns

booleanhadEnough

Spring.SetTeamResource (function)

Spring.SetTeamResource(TeamID, (ResourceName|StorageName), number) -> nil

Parameters

TeamIDteamID

(ResourceName|StorageName)resource

numberamount

Returns

nil

Spring.SetTeamShareLevel (function)

Changes the resource amount for a team beyond which resources aren’t stored but transferred to other allied teams if possible.

[source]

Spring.SetTeamShareLevel(TeamID, ResourceName, number) -> nil

Parameters

TeamIDteamID

ResourceNametype

numberamount

Returns

nil

Spring.AddTeamResourceExcessStats (function)

Records resource excess for a team without moving resources.

The engine normally tracks excess, but if you use gadget:ResourceExcess to handle it manually it’s now also up to you to track stats.

[source]

Spring.AddTeamResourceExcessStats(TeamID, ResourceName, number) -> nil

Parameters

TeamIDteamID

ResourceNametype

numberexcess

Amount wasted this tick.

Returns

nil

Spring.ShareTeamResource (function)

Transfers resources between two teams. Transfers directly, without involving AllowResourceTransfer callin. Approximately equivalent to doing Use and Add for the sender and receiver, the difference being that it counts to sent/received stats rather than used/produced in end-game statistics graphs.

[source]

Spring.ShareTeamResource(TeamID, TeamID, ResourceName, number) -> nil

Parameters

TeamIDteamID_src

TeamIDteamID_recv

ResourceNametype

numberamount

Returns

nil

Spring.SetGameRulesParam (function)

Spring.SetGameRulesParam(string, (number|string|boolean)?, losAccess?) -> nil

Parameters

stringparamName

(number|string|boolean)?paramValue

numeric paramValues in quotes will be converted to number.

losAccess?losAccess

Returns

nil

Spring.SetTeamRulesParam (function)

Spring.SetTeamRulesParam(TeamID, string, (number|string|boolean)?, losAccess?) -> nil

Parameters

TeamIDteamID

stringparamName

(number|string|boolean)?paramValue

numeric paramValues in quotes will be converted to number.

losAccess?losAccess

Returns

nil

Spring.SetPlayerRulesParam (function)

Spring.SetPlayerRulesParam(PlayerID, string, (number|string|boolean)?, losAccess?) -> nil

Parameters

PlayerIDplayerID

stringparamName

(number|string|boolean)?paramValue

numeric paramValues in quotes will be converted to number.

losAccess?losAccess

Returns

nil

Spring.SetUnitRulesParam (function)

Spring.SetUnitRulesParam(UnitID, string, (number|string|boolean)?, losAccess?) -> nil

Parameters

UnitIDunitID

stringparamName

(number|string|boolean)?paramValue

numeric paramValues in quotes will be converted to number.

losAccess?losAccess

Returns

nil

Spring.SetFeatureRulesParam (function)

Spring.SetFeatureRulesParam(FeatureID, string, (number|string|boolean)?, losAccess?) -> nil

Parameters

FeatureIDfeatureID

stringparamName

(number|string|boolean)?paramValue

numeric paramValues in quotes will be converted to number.

losAccess?losAccess

Returns

nil

Spring.CallCOBScript (function)

Spring.CallCOBScript(UnitID, (integer|string)?, integer, [any, ]*) -> integer ...

Parameters

UnitIDunitID

(integer|string)?funcName

Function ID or name.

integerretArgs

Number of values to return.

any...

Arguments

Returns

integer ...

Spring.GetCOBScriptID (function)

Spring.GetCOBScriptID(UnitID, string) -> integer?

Parameters

UnitIDunitID

stringfuncName

Returns

integer?funcID

Spring.CreateUnit (function)

See Spring.DestroyUnit

Spring.CreateUnit((string|integer), number, number, number, Facing, TeamID?, boolean?, boolean?, UnitID?, UnitID?) -> UnitID?

Parameters

(string|integer)unitDef

UnitDef name or ID.

numberposX

numberposY

numberposZ

Facingfacing

TeamID?teamID

boolean?build

(Default: false) The unit is created in “being built” state with zero buildProgress.

boolean?flattenGround

(Default: true) The unit flattens ground, if it normally does so.

UnitID?unitID

Request a specific unitID.

UnitID?builderID

Returns

UnitID?unitID

The ID of the created unit, or nil if the unit could not be created.

Spring.DestroyUnit (function)

See Spring.CreateUnit

Spring.DestroyUnit(UnitID, boolean?, boolean?, UnitID?, boolean?) -> nil

Parameters

UnitIDunitID

boolean?selfd

(Default: false) makes the unit act like it self-destructed.

boolean?reclaimed

(Default: false) don’t show any DeathSequences, don’t leave a wreckage. This does not give back the resources to the team!

UnitID?attackerID

boolean?cleanupImmediately

(Default: false) stronger version of reclaimed, removes the unit unconditionally and makes its ID available for immediate reuse (otherwise it takes a few frames)

Returns

nil

Spring.TransferUnit (function)

Spring.TransferUnit(UnitID, TeamID, boolean?, boolean?) -> boolean

Parameters

UnitIDunitID

TeamIDnewTeamID

boolean?given

(Default: true) if false, the unit is captured.

boolean?adjustUnitLimit

(Default: false) if true, also transfer the limit slot

Returns

booleansuccessfulTransfer

Spring.TransferTeamMaxUnits (function)

Transfer capacity of units from one team to another

[source]

There are some conditions that must be satisfied for the operation to be successful:

• transferAmnt must be lower or equal than the origin team current maxunits (can’t transfer limit team does not have available)
• transferAmnt must be lower than origin team maxunits - currentunitscount (can’t transfer limit if origin team would be already over the limit after transfer)

Spring.TransferTeamMaxUnits(TeamID, TeamID, integer) -> boolean

Parameters

TeamIDfromTeamID

TeamIDnewTeamID

integertransferAmnt

Returns

booleansuccessfulTransfer

Whether the max unit limit was successfully transferred.

Spring.SetUnitCosts (function)

Spring.SetUnitCosts(UnitID, table<number,number>) -> nil

Parameters

UnitIDunitID

table<number,number>where

keys and values are, respectively and in this order: buildTime=amount, metalCost=amount, energyCost=amount

Returns

nil

Spring.SetUnitResourcing (function)

Spring.SetUnitResourcing(UnitID, string, number) -> nil

Parameters

UnitIDunitID

stringres

numberamount

Returns

nil

Spring.SetUnitResourcing (function overload 1)

Spring.SetUnitResourcing(UnitID, table<string,number>) -> nil

Parameters

UnitIDunitID

table<string,number>res

keys are: “[u|c][u|m][m|e]” unconditional | conditional, use | make, metal | energy. Values are amounts

Returns

nil

Spring.SetUnitStorage (function)

Spring.SetUnitStorage(UnitID, string, number) -> nil

Parameters

UnitIDunitID

stringres

numberamount

Spring.SetUnitStorage (function overload 1)

Spring.SetUnitStorage(UnitID, ResourceUsage) -> nil

Parameters

UnitIDunitID

ResourceUsageres

keys are: “[m|e]” metal | energy. Values are amounts

Spring.SetUnitTooltip (function)

Spring.SetUnitTooltip(UnitID, string) -> nil

Parameters

UnitIDunitID

stringtooltip

Returns

nil

Spring.SetUnitHealth (function)

[source]

Note, if your game’s custom shading framework doesn’t support reverting into nanoframes then reverting into nanoframes via the “build” tag will fail to render properly.

See SetUnitHealthAmounts

Spring.SetUnitHealth(UnitID, (number|SetUnitHealthAmounts)) -> nil

Parameters

UnitIDunitID

(number|SetUnitHealthAmounts)health

If a number, sets the units health to that value. Pass a table to update health, capture progress, paralyze damage, and build progress.

Returns

nil

Spring.SetUnitMaxHealth (function)

Spring.SetUnitMaxHealth(UnitID, number) -> nil

Parameters

UnitIDunitID

numbermaxHealth

Returns

nil

Spring.SetUnitStockpile (function)

Spring.SetUnitStockpile(UnitID, integer?, number?) -> nil

Parameters

UnitIDunitID

integer?stockpile

number?buildPercent

Returns

nil

Spring.SetUnitUseWeapons (function)

Spring.SetUnitUseWeapons(UnitID, number?, number?) -> nil

Parameters

UnitIDunitID

number?forceUseWeapons

number?allowUseWeapons

Returns

nil

Spring.SetUnitWeaponState (function)

Spring.SetUnitWeaponState(UnitID, integer, WeaponState) -> nil

Parameters

UnitIDunitID

integerweaponNum

WeaponStatestates

Returns

nil

Spring.SetUnitWeaponState (function overload 1)

Spring.SetUnitWeaponState(UnitID, integer, string, number) -> nil

Parameters

UnitIDunitID

integerweaponNum

stringkey

numbervalue

Returns

nil

Spring.SetUnitWeaponDamages (function)

Spring.SetUnitWeaponDamages(UnitID, (integer|"selfDestruct"|"explode"), WeaponDamages) -> nil

Parameters

UnitIDunitID

(integer|"selfDestruct"|"explode")weaponNum

WeaponDamagesdamages

Returns

nil

Spring.SetUnitWeaponDamages (function overload 1)

Spring.SetUnitWeaponDamages(UnitID, (integer|"selfDestruct"|"explode"), string, number) -> nil

Parameters

UnitIDunitID

(integer|"selfDestruct"|"explode")weaponNum

stringkey

numbervalue

Returns

nil

Spring.SetUnitMaxRange (function)

Spring.SetUnitMaxRange(UnitID, number) -> nil

Parameters

UnitIDunitID

numbermaxRange

Returns

nil

Spring.SetUnitExperience (function)

See Spring.GetUnitExperience

Spring.SetUnitExperience(UnitID, number) -> nil

Parameters

UnitIDunitID

numberexperience

Returns

nil

Spring.AddUnitExperience (function)

See Spring.GetUnitExperience

Spring.AddUnitExperience(UnitID, number) -> nil

Parameters

UnitIDunitID

numberdeltaExperience

Can be negative to subtract, but the unit will never have negative total afterwards

Returns

nil

Spring.SetUnitArmored (function)

Spring.SetUnitArmored(UnitID, boolean?, number?) -> nil

Parameters

UnitIDunitID

boolean?armored

number?armorMultiple

Returns

nil

Spring.SetUnitLosMask (function)

Set visibility status mask for a unit and team

Use this to allow or disallow a unit from having its visibility status against a certain team updated by the engine.

[source]

See Spring.SetUnitLosState

Spring.SetUnitLosMask(UnitID, AllyTeamID, (LosTable|LosMask|integer)) -> nil

Parameters

UnitIDunitID

AllyTeamIDallyTeam

(LosTable|LosMask|integer)losTypes

A bitmask of LosMask bits or a table. True bits disable engine updates to visibility.

Spring.SetUnitLosState (function)

Set current visibility status for a unit and team

Note this state will not be persisted if the visibility state is not masked.

Use it to change visibility state, once you set the unit to not receive engine visibility updates.

A few notes on certain bits:

• contradar: True when the unit entered los at some point, remains set until radar is lost. Useful for tracking the unit type in radar, if you lost los you still know what unit type that radar dot refers to.
• prevlos: True when the unit has entered los at least once, useful for tracking building locations (controls whether a ghost appears or not in the location)

[source]

See Spring.SetUnitLosMask

Spring.SetUnitLosState(UnitID, AllyTeamID, (LosTable|LosMask|integer)) -> nil

Parameters

UnitIDunitID

AllyTeamIDallyTeam

(LosTable|LosMask|integer)losTypes

A bitmask of LosMask bits or a table

Spring.SetUnitCloak (function)

[source]

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:=ultimate 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.SetUnitCloak(UnitID, (boolean|number)?, (boolean|number)?) -> nil

Parameters

UnitIDunitID

(boolean|number)?cloak

(boolean|number)?cloakArg

Returns

nil

Spring.SetUnitStealth (function)

Spring.SetUnitStealth(UnitID, boolean) -> nil

Parameters

UnitIDunitID

booleanstealth

Returns

nil

Spring.SetUnitSonarStealth (function)

Spring.SetUnitSonarStealth(UnitID, boolean) -> nil

Parameters

UnitIDunitID

booleansonarStealth

Returns

nil

Spring.SetUnitSeismicSignature (function)

Spring.SetUnitSeismicSignature(UnitID, number) -> nil

Parameters

UnitIDunitID

numberseismicSignature

Returns

nil

Spring.SetUnitLeavesGhost (function)

Set whether unit leaves static radar ghosts.

[source]

Spring.SetUnitLeavesGhost(boolean, boolean?) -> nil

Parameters

booleanleavesGhost

boolean?leaveDeadGhost

(Default: false) leave a dead ghost behind if disabling and the unit had a live static ghost.

Spring.SetUnitAlwaysVisible (function)

Spring.SetUnitAlwaysVisible(UnitID, boolean) -> nil

Parameters

UnitIDunitID

booleanalwaysVisible

Returns

nil

Spring.SetUnitUseAirLos (function)

Spring.SetUnitUseAirLos(UnitID, boolean) -> nil

Parameters

UnitIDunitID

booleanuseAirLos

Returns

nil

Spring.SetUnitMetalExtraction (function)

Spring.SetUnitMetalExtraction(UnitID, number, number?) -> nil

Parameters

UnitIDunitID

numberdepth

corresponds to metal extraction rate

number?range

similar to “extractsMetal” in unitDefs.

Returns

nil

Spring.SetUnitHarvestStorage (function)

See also harvestStorage UnitDef tag.

[source]

Spring.SetUnitHarvestStorage(UnitID, number?) -> nil

Parameters

UnitIDunitID

number?metal

Returns

nil

Spring.SetUnitBuildParams (function)

Spring.SetUnitBuildParams(UnitID, string, (number|boolean)?) -> nil

Parameters

UnitIDunitID

stringparamName

one of buildRange|buildDistance|buildRange3D

(number|boolean)?value

boolean when paramName is buildRange3D, otherwise number.

Returns

nil

Spring.SetUnitBuildSpeed (function)

Spring.SetUnitBuildSpeed(UnitID, number, number?, number?, number?, number?) -> nil

Parameters

UnitIDbuilderID

numberbuildSpeed

number?repairSpeed

number?reclaimSpeed

number?captureSpeed

number?terraformSpeed

Returns

nil

Spring.SetUnitNanoPieces (function)

[source]

This saves a lot of engine calls, by replacing: function script.QueryNanoPiece() return currentpiece end Use it!

Spring.SetUnitNanoPieces(UnitID, table) -> nil

Parameters

UnitIDbuilderID

tablepieces

Returns

nil

Spring.SetUnitBlocking (function)

Spring.SetUnitBlocking(UnitID, boolean?, boolean?, boolean?, boolean?, boolean?, boolean?, boolean?) -> boolean

Parameters

UnitIDunitID

boolean?isBlocking

If true add this unit to the GroundBlockingMap, but only if it collides with solid objects (or is being set to collide with the isSolidObjectCollidable argument). If false, remove this unit from the GroundBlockingMap. No change if nil.

boolean?isSolidObjectCollidable

Enable or disable collision with solid objects, or no change if nil.

boolean?isProjectileCollidable

Enable or disable collision with projectiles, or no change if nil.

boolean?isRaySegmentCollidable

Enable or disable collision with ray segments, or no change if nil.

boolean?crushable

Enable or disable crushable, or no change if nil.

boolean?blockEnemyPushing

Enable or disable blocking enemy pushing, or no change if nil.

boolean?blockHeightChanges

Enable or disable blocking height changes, or no change if nil.

Returns

booleanisBlocking

Spring.SetUnitCrashing (function)

Spring.SetUnitCrashing(UnitID, boolean?) -> boolean

Parameters

UnitIDunitID

boolean?crashing

Returns

booleansuccess

Spring.SetUnitShieldState (function)

Spring.SetUnitShieldState(UnitID, integer?, boolean?, number?) -> nil

Parameters

UnitIDunitID

integer?weaponID

(Default: -1)

boolean?enabled

number?power

Returns

nil

Spring.SetUnitShieldRechargeDelay (function)

Spring.SetUnitShieldRechargeDelay(UnitID, integer?, number?) -> nil

Parameters

UnitIDunitID

integer?weaponID

(optional if the unit only has one shield)

number?rechargeTime

(in seconds; emulates a regular hit if nil)

Returns

nil

Spring.SetUnitFlanking (function)

Spring.SetUnitFlanking(UnitID, string, number, number?, number?) -> nil

Parameters

UnitIDunitID

stringtype

“dir”|“minDamage”|“maxDamage”|“moveFactor”|“mode”

numberarg1

x|minDamage|maxDamage|moveFactor|mode

number?y

only when type is “dir”

number?z

only when type is “dir”

Returns

nil

Spring.SetUnitPhysicalStateBit (function)

Spring.SetUnitPhysicalStateBit(UnitID, ) -> nil

Parameters

UnitIDunitID

Physical

Returns

nil

Spring.GetUnitPhysicalState (function)

Spring.GetUnitPhysicalState(UnitID) -> integer

Parameters

UnitIDunitID

Returns

integerphysicalState

Unit’s PhysicalState bitmask

Spring.SetUnitNeutral (function)

Spring.SetUnitNeutral(UnitID, boolean) -> boolean?

Parameters

UnitIDunitID

booleanneutral

Returns

boolean?setNeutral

Spring.SetUnitTarget (function)

Defines a unit’s target.

[source]

Spring.SetUnitTarget(UnitID, UnitID?, boolean?, boolean?, boolean?, integer?) -> boolean

Parameters

UnitIDunitID

UnitID?enemyUnitID

when nil drops the units current target.

boolean?dgun

(Default: false)

boolean?userTarget

(Default: false)

boolean?dontForceTarget

integer?weaponNum

(Default: -1)

Returns

booleansuccess

Spring.SetUnitTarget (function overload 1)

Spring.SetUnitTarget(UnitID, number?, number?, number?, boolean?, boolean?, boolean?, integer?) -> boolean

Parameters

UnitIDunitID

number?x

when nil or not passed it will drop target and ignore other parameters

number?y

number?z

boolean?dgun

(Default: false)

boolean?userTarget

(Default: false)

boolean?dontForceTarget

integer?weaponNum

(Default: -1)

Returns

booleansuccess

Spring.SetUnitMidAndAimPos (function)

Spring.SetUnitMidAndAimPos(UnitID, number, number, number, number, number, number, boolean?) -> boolean

Parameters

UnitIDunitID

numbermpX

new middle positionX of unit

numbermpY

new middle positionY of unit

numbermpZ

new middle positionZ of unit

numberapX

new positionX that enemies aim at on this unit

numberapY

new positionY that enemies aim at on this unit

numberapZ

new positionZ that enemies aim at on this unit

boolean?relative

(Default: false) are the new coordinates relative to world (false) or unit (true) coordinates? Also, note that apy is inverted!

Returns

booleansuccess

Spring.SetUnitRadiusAndHeight (function)

Spring.SetUnitRadiusAndHeight(UnitID, number?, number?) -> boolean

Parameters

UnitIDunitID

number?radius

number?height

Returns

booleansuccess

Spring.SetUnitBuildeeRadius (function)

[source]

Sets the unit’s radius for when targeted by build, repair, reclaim-type commands.

Spring.SetUnitBuildeeRadius(UnitID, number) -> nil

Parameters

UnitIDunitID

numberbuild

radius for when targeted by build, repair, reclaim-type commands.

Returns

nil

Spring.SetUnitPieceParent (function)

Changes the pieces hierarchy of a unit by attaching a piece to a new parent.

[source]

Spring.SetUnitPieceParent(UnitID, integer, integer) -> nil

Parameters

UnitIDunitID

integerAlteredPiece

integerParentPiece

Returns

nil

Spring.SetUnitPieceMatrix (function)

Sets the local (i.e. parent-relative) matrix of the given piece.

[source]

If any of the first three elements are non-zero, and also blocks all script animations from modifying it until {0, 0, 0} is passed.

Spring.SetUnitPieceMatrix(UnitID, integer, number[]) -> boolean?

Parameters

UnitIDunitID

integerpieceNum

number[]matrix

an array of 16 floats

Returns

boolean?valid

whether the matrix can be used for the purpose of defining the piece spatial transformation. Blocks the piece animation, if true.

Spring.SetUnitCollisionVolumeData (function)

Spring.SetUnitCollisionVolumeData(UnitID, number, number, number, number, number, number, integer, integer, integer) -> nil

Parameters

UnitIDunitID

numberscaleX

numberscaleY

numberscaleZ

numberoffsetX

numberoffsetY

numberoffsetZ

integervType

integertType

integerAxis

Returns

nilenum

COLVOL_TYPES { COLVOL_TYPE_DISABLED = -1, COLVOL_TYPE_ELLIPSOID = 0, COLVOL_TYPE_CYLINDER, COLVOL_TYPE_BOX, COLVOL_TYPE_SPHERE, COLVOL_NUM_TYPES // number of non-disabled collision volume types }; enum COLVOL_TESTS { COLVOL_TEST_DISC = 0, COLVOL_TEST_CONT = 1, COLVOL_NUM_TESTS = 2 // number of tests }; enum COLVOL_AXES { COLVOL_AXIS_X = 0, COLVOL_AXIS_Y = 1, COLVOL_AXIS_Z = 2, COLVOL_NUM_AXES = 3 // number of collision volume axes };

Spring.SetUnitPieceCollisionVolumeData (function)

Spring.SetUnitPieceCollisionVolumeData(UnitID, integer, boolean, number, number, number, number, number, number, integer?, integer?) -> nil

Parameters

UnitIDunitID

integerpieceIndex

booleanenable

numberscaleX

numberscaleY

numberscaleZ

numberoffsetX

numberoffsetY

numberoffsetZ

integer?volumeType

integer?primaryAxis

Returns

nil

Spring.SetUnitPieceVisible (function)

Spring.SetUnitPieceVisible(UnitID, integer, boolean) -> nil

Parameters

UnitIDunitID

integerpieceIndex

booleanvisible

Returns

nil

Spring.SetUnitSensorRadius (function)

Spring.SetUnitSensorRadius(UnitID, ("los"|"airLos"|"radar"|"sonar"|"seismic"|"radarJammer"...), integer) -> integer?

Parameters

UnitIDunitID

("los"|"airLos"|"radar"|"sonar"|"seismic"|"radarJammer"...)type

integerradius

Returns

integer?newRadius

New radius, or nil if unit is invalid.

Spring.SetUnitPosErrorParams (function)

Sets a unit’s radar wobble

Controls how much a unit’s radar dot will wobble. Note that setting this above the allyTeam’s default wobble may result in the edgemost dot positions failing to register in ray traces, i.e. things like native “is under cursor” checks and some Lua interfaces.

[source]

Spring.SetUnitPosErrorParams(UnitID, number?, number?, number?, number?, number?, number?, integer?) -> nil

Parameters

UnitIDunitID

number?posErrorVectorX

number?posErrorVectorY

number?posErrorVectorZ

number?posErrorDeltaX

number?posErrorDeltaY

number?posErrorDeltaZ

integer?nextPosErrorUpdate

Returns

nil

Spring.SetUnitMoveGoal (function)

Used by default commands to get in build-, attackrange etc.

[source]

Spring.SetUnitMoveGoal(UnitID, number, number, number, number?, number?, boolean?) -> nil

Parameters

UnitIDunitID

numbergoalX

numbergoalY

numbergoalZ

number?goalRadius

number?moveSpeed

boolean?moveRaw

Returns

nil

Spring.SetUnitLandGoal (function)

Used in conjunction with Spring.UnitAttach et al. to re-implement old airbase & fuel system in Lua.

[source]

Spring.SetUnitLandGoal(UnitID, number, number, number, number?) -> nil

Parameters

UnitIDunitID

numbergoalX

numbergoalY

numbergoalZ

number?goalRadius

Returns

nil

Spring.ClearUnitGoal (function)

Spring.ClearUnitGoal(UnitID, boolean?) -> nil

Parameters

UnitIDunitID

boolean?maneuver

Returns

nil

Spring.SetUnitPhysics (function)

Spring.SetUnitPhysics(UnitID, number, number, number, number, number, number, number, number, number, number, number, number) -> nil

Parameters

UnitIDunitID

numberposX

numberposY

numberposZ

numbervelX

numbervelY

numbervelZ

numberrotX

numberrotY

numberrotZ

numberdragX

numberdragY

numberdragZ

Returns

nil

Spring.SetUnitMass (function)

Spring.SetUnitMass(UnitID, number) -> nil

Parameters

UnitIDunitID

numbermass

Returns

nil

Spring.SetUnitPosition (function)

Set unit position (2D)

[source]

Sets a unit’s position in 2D, at terrain height.

Spring.SetUnitPosition(UnitID, number, number, boolean?) -> nil

Parameters

UnitIDunitID

numberx

numberz

boolean?floating

(Default: false) If true, over water the position is on surface. If false, on seafloor.

Returns

nil

Spring.SetUnitPosition (function overload 1)

Set unit position (3D)

[source]

Sets a unit’s position in 3D, at an arbitrary height.

Spring.SetUnitPosition(UnitID, number, number, number) -> nil

Parameters

UnitIDunitID

numberx

numbery

numberz

Returns

nil

Spring.SetUnitRotation (function)

[source]

Note: PYR order

Spring.SetUnitRotation(UnitID, number, number, number) -> nil

Parameters

UnitIDunitID

numberpitch

Rotation in X axis

numberyaw

Rotation in Y axis

numberroll

Rotation in Z axis

Returns

nil

Spring.SetUnitDirection (function)

[source]

Set unit front direction vector. The vector is normalized in the engine.

Deprecated: It’s strongly that you use the overload that accepts a right direction as frontDir alone doesn’t define object orientation.

Spring.SetUnitDirection(UnitID, number, number, number) -> nil

Parameters

UnitIDunitID

numberfrontx

numberfronty

numberfrontz

Returns

nil

Spring.SetUnitDirection (function overload 1)

[source]

Set unit front and right direction vectors.

Both vectors will be normalized in the engine.

Spring.SetUnitDirection(UnitID, number, number, number, number, number, number) -> nil

Parameters

UnitIDunitID

numberfrontx

numberfronty

numberfrontz

numberrightx

numberrighty

numberrightz

Returns

nil

Spring.SetUnitHeadingAndUpDir (function)

[source]

Use this call to set up unit direction in a robust way. If unit was completely upright, new {upx, upy, upz} direction will be used as new “up” vector, the rotation set by “heading” will remain preserved.

Spring.SetUnitHeadingAndUpDir(UnitID, Heading, number, number, number) -> nil

Parameters

UnitIDunitID

Headingheading

numberupx

numberupy

numberupz

Returns

nil

Spring.SetUnitVelocity (function)

Set the velocity of a Unit

[source]

See Spring.SetUnitMoveCtrl for disabling/enabling this control

Spring.SetUnitVelocity(UnitID, number, number, number) -> nil

Parameters

UnitIDunitID

numbervelX

in elmos/frame

numbervelY

in elmos/frame

numbervelZ

in elmos/frame

Spring.SetFactoryBuggerOff (function)

Spring.SetFactoryBuggerOff(UnitID, boolean?, number?, number?, Heading?, boolean?, boolean?) -> number?

Parameters

UnitIDunitID

boolean?buggerOff

number?offset

number?radius

Heading?relHeading

boolean?spherical

boolean?forced

Returns

number?buggerOff

Spring.BuggerOff (function)

Spring.BuggerOff(number, number, number?, number, TeamID, boolean?, boolean?, UnitID?, UnitDefID[]?) -> nil

Parameters

numberx

numbery

number?z

uses ground height when unspecified

numberradius

TeamIDteamID

boolean?spherical

(Default: true)

boolean?forced

(Default: true)

UnitID?excludeUnitID

UnitDefID[]?excludeUnitDefIDs

Returns

nil

Spring.AddFeatureDamage (function)

Apply damage to feature

[source]

Will trigger FeaturePreDamaged and FeatureDamaged callins.

Won’t do anything if paralyze is not zero, the feature is already marked for deletion, or in void.

If health goes below 0 and featureDef is destructable the feature will be deleted and a wreck created.

See SyncedCallins:FeatureDamaged

Spring.AddFeatureDamage(FeatureID, number, integer?, UnitID?, WeaponDefID?, number?, number?, number?) -> nil

Parameters

FeatureIDfeatureID

numberdamage

integer?paralyze

(Default: 0) equals to the paralyzetime in the WeaponDef.

UnitID?attackerID

(Default: -1)

WeaponDefID?weaponID

(Default: -1)

number?impulseX

number?impulseY

number?impulseZ

Spring.AddUnitDamage (function)

Spring.AddUnitDamage(UnitID, number, integer?, UnitID?, WeaponDefID?, number?, number?, number?) -> nil

Parameters

UnitIDunitID

numberdamage

integer?paralyze

(Default: 0) equals to the paralyzetime in the WeaponDef.

UnitID?attackerID

(Default: -1)

WeaponDefID?weaponID

(Default: -1)

number?impulseX

number?impulseY

number?impulseZ

Returns

nil

Spring.AddUnitImpulse (function)

Spring.AddUnitImpulse(UnitID, number, number, number, number?) -> nil

Parameters

UnitIDunitID

numberx

numbery

numberz

number?decayRate

Returns

nil

Spring.AddUnitSeismicPing (function)

Spring.AddUnitSeismicPing(UnitID, number) -> nil

Parameters

UnitIDunitID

numberpindSize

Returns

nil

Spring.AddUnitResource (function)

Spring.AddUnitResource(UnitID, string, number) -> nil

Parameters

UnitIDunitID

stringresource

“m” | “e”

numberamount

Returns

nil

Spring.UseUnitResource (function)

Spring.UseUnitResource(UnitID, ResourceName, number) -> boolean?

Parameters

UnitIDunitID

ResourceNameresource

numberamount

Returns

boolean?okay

Spring.UseUnitResource (function overload 1)

Spring.UseUnitResource(UnitID, ResourceUsage) -> boolean?

Parameters

UnitIDunitID

ResourceUsageresources

Returns

boolean?okay

Spring.AddObjectDecal (function)

Spring.AddObjectDecal(UnitID) -> nil

Parameters

UnitIDunitID

Returns

nil

Spring.RemoveObjectDecal (function)

Spring.RemoveObjectDecal(UnitID) -> nil

Parameters

UnitIDunitID

Returns

nil

Spring.AddGrass (function)

Spring.AddGrass(number, number) -> nil

Parameters

numberx

numberz

Returns

nil

Spring.RemoveGrass (function)

Spring.RemoveGrass(number, number) -> nil

Parameters

numberx

numberz

Returns

nil

Spring.CreateFeature (function)

Spring.CreateFeature((string|integer), number, number, number, Heading?, TeamID?, FeatureID?) -> FeatureID?

Parameters

(string|integer)featureDef

name or id

numberx

numbery

numberz

Heading?heading

TeamID?teamID

FeatureID?featureID

Returns

FeatureID?featureID

returns nil if creation was unsuccessful

Spring.DestroyFeature (function)

Spring.DestroyFeature(FeatureID) -> nil

Parameters

FeatureIDfeatureID

Returns

nil

Spring.TransferFeature (function)

Feature Control

[source]

Spring.TransferFeature(FeatureID, TeamID) -> nil

Parameters

FeatureIDfeatureID

TeamIDteamID

Returns

nil

Spring.SetFeatureAlwaysVisible (function)

Spring.SetFeatureAlwaysVisible(FeatureID, boolean) -> nil

Parameters

FeatureIDfeatureID

booleanenable

Returns

nil

Spring.SetFeatureUseAirLos (function)

Spring.SetFeatureUseAirLos(FeatureID, boolean) -> nil

Parameters

FeatureIDfeatureID

booleanuseAirLos

Returns

nil

Spring.SetFeatureHealth (function)

Spring.SetFeatureHealth(FeatureID, number, boolean?) -> nil

Parameters

FeatureIDfeatureID

numberhealth

boolean?checkDestruction

(Default: false) Whether to destroy feature if feature goes below 0 health.

Returns

nil

Spring.SetFeatureMaxHealth (function)

Spring.SetFeatureMaxHealth(FeatureID, number) -> nil

Parameters

FeatureIDfeatureID

numbermaxHealth

minimum 0.1

Returns

nil

Spring.SetFeatureReclaim (function)

Spring.SetFeatureReclaim(FeatureID, number) -> nil

Parameters

FeatureIDfeatureID

numberreclaimLeft

Returns

nil

Spring.SetFeatureResources (function)

Spring.SetFeatureResources(FeatureID, number, number, number?, number?, number?, number?) -> nil

Parameters

FeatureIDfeatureID

numbermetal

numberenergy

number?reclaimTime

number?reclaimLeft

number?featureDefMetal

number?featureDefEnergy

Returns

nil

Spring.SetFeatureResurrect (function)

Spring.SetFeatureResurrect(FeatureID, (string|integer)?, Facing?, number?) -> nil

Parameters

FeatureIDfeatureID

(string|integer)?unitDef

Can be a number id or a string name, this allows cancelling resurrection by passing -1.

Facing?facing

(Default: “south”)

number?progress

Set the level of progress.

Returns

nil

Spring.SetFeatureMoveCtrl (function)

Enable feature movement control.

[source]

Spring.SetFeatureMoveCtrl(FeatureID, true, number?, number?, number?, number?, number?, number?) -> nil

Parameters

FeatureIDfeatureID

trueenabled

Enable feature movement.

number?initialVelocityX

Initial velocity on X axis, or nil for no change.

number?initialVelocityY

Initial velocity on Y axis, or nil for no change.

number?initialVelocityZ

Initial velocity on Z axis, or nil for no change.

number?accelerationX

Acceleration per frame on X axis, or nil for no change.

number?accelerationY

Acceleration per frame on Y axis, or nil for no change.

number?accelerationZ

Acceleration per frame on Z axis, or nil for no change.

Spring.SetFeatureMoveCtrl (function overload 1)

Disable feature movement control.

Optional parameter allow physics vectors to build when not using MoveCtrl.

It is necessary to unlock feature movement on x, z axis before changing feature physics.

For example:

lua – Unlock all movement before setting velocity. Spring.SetFeatureMoveCtrl(featureID,false,1,1,1,1,1,1,1,1,1)

– Set velocity. Spring.SetFeatureVelocity(featureID,10,0,10)

[source]

Spring.SetFeatureMoveCtrl(FeatureID, false, number?, number?, number?, number?, number?, number?, number?, number?, number?) -> nil

Parameters

FeatureIDfeatureID

falseenabled

Disable feature movement.

number?velocityMaskX

Lock velocity change in X dimension when not using MoveCtrl. 0 to lock, non-zero to allow, or nil to for no change.

number?velocityMaskY

Lock velocity change in Y dimension when not using MoveCtrl. 0 to lock, non-zero to allow, or nil to for no change.

number?velocityMaskZ

Lock velocity change in Z dimension when not using MoveCtrl. 0 to lock, non-zero to allow, or nil to for no change.

number?impulseMaskX

Lock impulse in X dimension when not using MoveCtrl. 0 to lock, non-zero to allow, or nil to for no change.

number?impulseMaskY

Lock impulse in Y dimension when not using MoveCtrl. 0 to lock, non-zero to allow, or nil to for no change.

number?impulseMaskZ

Lock impulse in Z dimension when not using MoveCtrl. 0 to lock, non-zero to allow, or nil to for no change.

number?movementMaskX

Lock move in X dimension when not using MoveCtrl. 0 to lock the axis, non-zero to allow, or nil for no change.

number?movementMaskY

Lock move in Y dimension when not using MoveCtrl. 0 to lock the axis, non-zero to allow, or nil for no change.

number?movementMaskZ

Lock move in Z dimension when not using MoveCtrl. 0 to lock the axis, non-zero to allow, or nil for no change.

Spring.SetFeaturePhysics (function)

Spring.SetFeaturePhysics(FeatureID, number, number, number, number, number, number, number, number, number, number, number, number) -> nil

Parameters

FeatureIDfeatureID

numberposX

numberposY

numberposZ

numbervelX

numbervelY

numbervelZ

numberrotX

numberrotY

numberrotZ

numberdragX

numberdragY

numberdragZ

Returns

nil

Spring.SetFeatureMass (function)

Spring.SetFeatureMass(FeatureID, number) -> nil

Parameters

FeatureIDfeatureID

numbermass

Returns

nil

Spring.SetFeaturePosition (function)

Spring.SetFeaturePosition(FeatureID, number, number, number, boolean?) -> nil

Parameters

FeatureIDfeatureID

numberx

numbery

numberz

boolean?snapToGround

Returns

nil

Spring.SetFeatureRotation (function)

[source]

Note: PYR order

Spring.SetFeatureRotation(FeatureID, number, number, number) -> nil

Parameters

FeatureIDfeatureID

numberpitch

Rotation in X axis

numberyaw

Rotation in Y axis

numberroll

Rotation in Z axis

Returns

nil

Spring.SetFeatureDirection (function)

[source]

Set feature front direction vector. The vector is normalized in the engine.

Deprecated: It’s strongly that you use the overload that accepts a right direction as frontDir alone doesn’t define object orientation.

Spring.SetFeatureDirection(FeatureID, number, number, number) -> nil

Parameters

FeatureIDfeatureID

numberfrontx

numberfronty

numberfrontz

Returns

nil

Spring.SetFeatureDirection (function overload 1)

[source]

Set feature front and right direction vectors.

Both vectors will be normalized in the engine.

Spring.SetFeatureDirection(FeatureID, number, number, number, number, number, number) -> nil

Parameters

FeatureIDfeatureID

numberfrontx

numberfronty

numberfrontz

numberrightx

numberrighty

numberrightz

Returns

nil

Spring.SetFeatureHeadingAndUpDir (function)

[source]

Use this call to set up feature direction in a robust way. If feature was completely upright, new {upx, upy, upz} direction will be used as new “up” vector, the rotation set by “heading” will remain preserved.

Spring.SetFeatureHeadingAndUpDir(FeatureID, Heading, number, number, number) -> nil

Parameters

FeatureIDfeatureID

Headingheading

numberupx

numberupy

numberupz

Returns

nil

Spring.SetFeatureVelocity (function)

Set the velocity of a Feature

[source]

See Spring.SetFeatureMoveCtrl for disabling/enabling this control

Spring.SetFeatureVelocity(FeatureID, number, number, number) -> nil

Parameters

FeatureIDfeatureID

numbervelX

in elmos/frame

numbervelY

in elmos/frame

numbervelZ

in elmos/frame

Spring.SetFeatureBlocking (function)

Spring.SetFeatureBlocking(FeatureID, boolean?, boolean?, boolean?, boolean?, boolean?, boolean?, boolean?) -> boolean

Parameters

FeatureIDfeatureID

boolean?isBlocking

If true add this feature to the GroundBlockingMap, but only if it collides with solid objects (or is being set to collide with the isSolidObjectCollidable argument). If false, remove this feature from the GroundBlockingMap. No change if nil.

boolean?isSolidObjectCollidable

Enable or disable collision with solid objects, or no change if nil.

boolean?isProjectileCollidable

Enable or disable collision with projectiles, or no change if nil.

boolean?isRaySegmentCollidable

Enable or disable collision with ray segments, or no change if nil.

boolean?crushable

Enable or disable crushable, or no change if nil.

boolean?blockEnemyPushing

Enable or disable blocking enemy pushing, or no change if nil.

boolean?blockHeightChanges

Enable or disable blocking height changes, or no change if nil.

Returns

booleanisBlocking

Spring.SetFeatureNoSelect (function)

Spring.SetFeatureNoSelect(FeatureID, boolean) -> nil

Parameters

FeatureIDfeatureID

booleannoSelect

Returns

nil

Spring.SetFeatureMidAndAimPos (function)

[source]

Check Spring.SetUnitMidAndAimPos for further explanation of the arguments.

Spring.SetFeatureMidAndAimPos(FeatureID, number, number, number, number, number, number, boolean?) -> boolean

Parameters

FeatureIDfeatureID

numbermpX

numbermpY

numbermpZ

numberapX

numberapY

numberapZ

boolean?relative

Returns

booleansuccess

Spring.SetFeatureRadiusAndHeight (function)

Spring.SetFeatureRadiusAndHeight(FeatureID, number?, number?) -> boolean

Parameters

FeatureIDfeatureID

number?radius

number?height

Returns

booleansuccess

Spring.SetFeatureCollisionVolumeData (function)

[source]

Check Spring.SetUnitCollisionVolumeData for further explanation of the arguments.

Spring.SetFeatureCollisionVolumeData(FeatureID, number, number, number, number, number, number, integer, integer, integer) -> nil

Parameters

FeatureIDfeatureID

numberscaleX

numberscaleY

numberscaleZ

numberoffsetX

numberoffsetY

numberoffsetZ

integervType

integertType

integerAxis

Returns

nil

Spring.SetFeaturePieceCollisionVolumeData (function)

Spring.SetFeaturePieceCollisionVolumeData(FeatureID, integer, boolean, number, number, number, number, number, number, number, number, number?) -> nil

Parameters

FeatureIDfeatureID

integerpieceIndex

booleanenable

numberscaleX

numberscaleY

numberscaleZ

numberoffsetX

numberoffsetY

numberoffsetZ

numberAxis

numbervolumeType

number?primaryAxis

Returns

nil

Spring.SetFeaturePieceVisible (function)

Spring.SetFeaturePieceVisible(FeatureID, integer, boolean) -> nil

Parameters

FeatureIDfeatureID

integerpieceIndex

booleanvisible

Returns

nil

Spring.SetFeaturePieceMatrix (function)

Sets the local (i.e. parent-relative) matrix of the given piece, for a feature.

[source]

Spring.SetFeaturePieceMatrix(FeatureID, integer, number[]) -> boolean?

Parameters

FeatureIDfeatureID

integerpieceIndex

number[]matrix

an array of 16 floats

Returns

boolean?valid

whether the matrix can be used for the purpose of defining the piece spatial transformation

Spring.SetFeatureFireTime (function)

Set the fire timer for a feature.

[source]

Starts or resets an internal feature fire timer, when reaching zero the feature will be destroyed.

Spring.SetFeatureFireTime(FeatureID, number) -> nil

Parameters

FeatureIDfeatureID

numberfireTime

in seconds