Meteor 2 Scripting Functions

These script docs are designed for Meteor 2 v1.4+ (2026) not for Meteor 2 Legacy.

Audio

preloadSound
Preload a sound effect.
preloadSoundNumber
Preload a sound effect number.
playSound
Play a sound locally without spatialisation.
playSoundNumber
Play a sound by number (faster) locally without spatialisation and support instanceTag (looping).
playSound2D
Play a one shot sound from a 2D position.
playSoundNumber2D
Play a sound by number (faster) from a 2D position and support instanceID (looping).
playSoundDelayed
Play a sound locally without spatialisation after a specified delay in seconds.
playSoundDelayed2D
Play a sound from a position after a specified delay in seconds.
isSoundInstancePlaying
Determine if a sound instance is playing.
getSoundInstanceGain
Get the gain (volume) of a playing sound instance.
setSoundInstanceGain
Set the gain (volume) of a playing sound instance.
getSoundNumber
Get a sound number from a sound effect name.
playMusic
Play music from file.
getMusicPos
Get the currently playing music position in seconds.
setMusicPos
Seek the currently playing music to the current position in seconds.
getMusicLength
Get the currently playing music length in seconds.
getMusicFilename
Get the currently playing music filename.
stopMusic
Stop music playing.
restartMusic
Rewind currently playing music to the start.
pauseMusic
Pause currently playing music.
resumeMusic
Resume current music.
isMusicPaused
Is music paused?
isMusicPlaying
Is there music currently playing?
setMusicGainMultiplier
Multiply music gain for current playing track.

Drawing

setDrawLayer
Set the current drawing layer.
setDefaultDrawLayer
Set the current drawing layer back to default.
getDrawLayer
Get the current drawing layer.
drawText
Draws UI text to the screen for the current frame.
getDefaultFontSize
Get the default/native point size a font.
getFontHeight
Get the height of a font in pixels.
getTextWidth
Get the width of a string of text in pixels.
drawRectangle
Draw a rectangle using absolute coordinates.
drawRectangleWH
Draw a rectangle at the specified top-left position and width/height.
drawRectangleWHCentred
Draw a rectangle at the specified centre position and size.
drawRectangleRotated
Draw a rectangle at the specified centre position and size with rotation.
drawTriangle
Draw a triangle at the specified positions.
drawCircleCentred
Draw a circle at the specified centre position.
drawLine
Draw a rectangle at the specified centre position and size.
getSpriteNumber
Resolve a sprite filename to a sprite number.
getSpriteFramesCount
Get the number of frames in a sprite.
getSpriteFrameSize
Get the size of a sprite frame in pixels.
drawSprite
Draw a sprite to the screen UI.
drawSpriteFrame
Draw a sprite frame to the screen UI.
getImageNumber
Resolve a image filename to a sprite number.
getImageSize
Get the size of an image in pixels.
drawImage
Draw an image from the graphics\ folder to the screen UI.
drawCrtEffectOverlay
Draw CRT effect overlay.
drawScopeEffectOverlay
Draw scope effect overlay.
drawMonitorEffectOverlay
Draw monitor effect overlay.

Effects

getGraphicsQualityLevel
Get the graphics quality level from the local options.
createExplosion
Create an in-game explosion.
fade
Fades out the screen, displays a message and fades back in.
flash
Light up the world for a short time.
getCinematicBarsEnabled
Gets whether the cinematic bars are enabled.
setCinematicBarsEnabled
Sets whether the cinematic bars are enabled.
getMaxWildlifeDistance
Get the maximum wildlife particle distance.
addWildlifeParticle
Spawn a wildlife particle (e.g. insect or bird).
getWildlifeParticleInstanceCount
Get the current particles instance count of a willife particle type.
addPlantParticle
Spawn a plant particle (e.g. grass or flower).
getPlantParticleInstanceCount
Get the current particles instance count of a plant particle type.
isAddFireFrame
Determine if fire particles should be added this frame.
addFireParticle
Add a fire particle.
isAddSmokeFrame
Determine if smoke particles should be added this frame.
addSmokeParticle
Add a fire particle.
addSpriteParticle
Add a particle from a sprite.
drawLight
Draw a basic ellipse light.

Input

getMousePos
Get the mouse screen position in pixels
mouseWithin
Determine if a mouse cursor is within a rectangle.
mouseButtonDown
Determine if a mouse button is held down.
mouseButtonClicked
Determine if a mouse button was clicked (pressed and released).
keyDown
Determine if a keyboard key is being held down.
keyPressed
Determine if a keyboard key was pressed.
clearPressedKeys
Clears the pressed keys buffer.
waitForKeyRelease
Waits a short time for key to be released.

Inventory

giveItem
Give items to a player.
getItemCount
Get amount of an item a player has.
resetItems
Reset a player's items (server only).
getItemTypeName
Get the name of an item type by index.
getAllItemsTypesCount
Get the amount of item types.
getAllItemTypeNames
Get the names of all the item types.

Legacy

SC_PlaySound
Deprecated function, use playSound instead.
SC_GetSoundNumberForName
Deprecated function, use getSoundNumber instead.
SC_PlayDirectionalNumber
Deprecated function, use playSoundNumber2D instead.
SC_PlayMusic
Deprecated function, use playMusic instead.
SC_MusicSeekToStart
Deprecated function, use restartMusic instead.
SC_StopMusic
Deprecated function, use stopMusic instead.
SC_TogglePauseMusic
Deprecated function, use pauseMusic/resumeMusic instead.
SC_AddExplosion
Deprecated function, use createExplosion instead.
SC_GiveItem
Deprecated function, use giveItem instead.
SC_GetItemCount
Deprecated function, use getItemCount instead.
SC_ResetAllItems
Deprecated function, use resetItems instead.
SC_Random
Deprecated function, use randomInt instead.
SC_EndCurrentLevel
Deprecated function, use endLevel instead.
SC_GameOver
Deprecated function, use gameOver instead.
SC_RunMap
Deprecated function, use runMap instead.
SC_PlayMovieClip
Deprecated function, use playMovieClip instead.
SC_SetSideId
Deprecated function, use setSideID instead.
SC_AddObject
Deprecated function, use createObject instead.
SC_BindObjectToWaypoint
Deprecated function, use bindToWaypoint instead.
SC_BindObjectToWaypointSoft
Deprecated function, use bindToWaypointSoft instead.
SC_SetObjectHidden
Deprecated function, use setHidden instead.
SC_GetObjectHidden
Deprecated function, use getHidden instead.
SC_ShowObjectTeleport
Deprecated function, use showTeleport instead.
SC_GetObjectSide
Deprecated function, use getSide instead.
SC_SetObjectSide
Deprecated function, use setSide instead.
SC_GetObjectCoords
Deprecated function, use getPos instead.
SC_SetObjectCoords
Deprecated function, use setPos instead.
SC_GetObjectAngle
Deprecated function, use getAngle instead.
SC_SetObjectAngle
Deprecated function, use setAngle instead.
SC_GetObjectHits
Deprecated function, use getHits instead.
SC_SetObjectHits
Deprecated function, use setHits instead.
SC_GetObjectIndestructible
Deprecated function, use getIndestructible instead.
SC_SetObjectIndestructible
Deprecated function, use setIndestructible instead.
SC_GetObjectSpeed
Deprecated function, use getSpeed instead.
SC_SetObjectSpeed
Deprecated function, use setMaxSpeed instead.
SC_GetObjectMaxSpeed
Deprecated function, use getMaxSpeed instead.
SC_SetObjectMaxSpeed
Deprecated function, use setMaxSpeed instead.
SC_GetObjectDefaultMaxSpeed
Deprecated function, use getDefaultMaxSpeed instead.
SC_GetObjectAiType
Deprecated function, use getAiType instead.
SC_SetObjectAiType
Deprecated function, use setAiType instead.
SC_GetObjectLocked
Deprecated function, use getLocked instead.
SC_SetObjectLocked
Deprecated function, use setLocked instead.
SC_GetObjectActive
Deprecated function, use getActive instead.
SC_SetObjectActive
Deprecated function, use setForceActive instead.
SC_GetObjectNoTarget
Deprecated function, use getNoTarget instead.
SC_SetObjectNoTarget
Deprecated function, use setNoTarget instead.
SC_DoesObjectExist
Deprecated function, use objectExists instead.
SC_PutObjectOnHorse
Deprecated function, use getInVehicle instead.
SC_KickObjectOffHorse
Deprecated function, use getOutOfVehicle instead.
SC_ObjectHoot
Deprecated function, use hoot instead.
SC_GetObjectTypeNameForNumber
Deprecated function, use getTypeName instead.
SC_GetObjectTypeNumberForName
Deprecated function, use objectTypeNameToNumber instead.
SC_SetObjectFollow
Deprecated function, use setFollow instead.
SC_ResetObjectRespawnCoords
Deprecated function, use resetRespawnCoords instead.
SC_ShowPda
Deprecated function, use setPdaOpen instead.
SC_AddPdaMessage
Deprecated function, use addPdaMessage instead.
SC_LoadPdaMessage
Deprecated function, use loadPdaMessage instead.
SC_RemovePdaMessage
Deprecated function, use removePdaMessage instead.
SC_ClearAllPdaMessages
Deprecated function, use clearAllPdaMessages instead.
SC_PlayerGetInVehicle
Deprecated function, use getInVehicle instead.
SC_PlayerGetOutOfVehicle
Deprecated function, use getOutOfVehicle instead.
SC_IsPlayerInVehicle
Deprecated function, use inVehicle instead.
SC_SetPlayerObjectId
Deprecated function, use setPlayerObject instead.
SC_GetPlayerObjectId
Deprecated function, use getLocalPlayer instead.
SC_SetPlayerInteractionEnabled
Deprecated function, use setPlayerInteractionEnabled instead.
SC_GetPlayerInteractionEnabled
Deprecated function, use getPlayerInteractionEnabled instead.
SC_SetSectorTexture
Deprecated function, use setSectorTexture instead.
SC_GetSectorTexture
Deprecated function, use getSectorTexture instead.
SC_SetSectorHidden
Deprecated function, use setSectorHidden instead.
SC_GetSectorHidden
Deprecated function, use getSectorHidden instead.
SC_SetSectorTriggerEnabled
Deprecated function, use setSectorTriggerEnabled instead.
SC_GetSectorTriggerEnabled
Deprecated function, use getSectorTriggerEnabled instead.
SC_OpenDoor
Deprecated function, use openDoor instead.
SC_OpenForcefield
Deprecated function, use openForcefield instead.
SC_CloseForcefield
Deprecated function, use closeForcefield instead.
SC_SetSectorDamage
Deprecated function, use setSectorDamage instead.
SC_GetSectorDamage
Deprecated function, use getSectorDamage instead.
SC_AddSprite
Deprecated function, use createSprite instead.
SC_SetSpriteHidden
Deprecated function, use setSpriteHidden instead.
SC_GetSpriteHidden
Deprecated function, use getSpriteHidden instead.
SC_PassToConsole
Deprecated function, use passToConsole instead.
SC_MessageBox
Deprecated function, use messageBox instead.
SC_GameMessage
Deprecated function, use gameMessage instead.
SC_ConsoleMessage
Deprecated function, use print instead.
SC_StringInputBox
Deprecated function, use stringInputBox instead.
SC_ConfirmBox
Deprecated function, use confirmBox instead.
SC_CreateToolbar
Deprecated function, use createToolbar instead. localOnly has no effect (always true).
SC_DestroyToolbar
Deprecated function, use deleteToolbar instead. localOnly has no effect (always true).
SC_AddToolbarButton
Deprecated function, use addToolbarButton instead. localOnly has no effect (always true).

Math

randomInt
Generate a int between lower and upper (both inclusive).
randomFloat
Generate a random float between lower and upper (both inclusive).
randomDir
Generate a random direction/angle.
randomSeed
Generate a random seed value.
randomArray
Pick a random element from an array.
getPerlinSample
Generate a value based on a 2D vector and a seed using perlin noise.
getRotatedSize
Get the bounds size of a rectangle rotated in degrees.
rotatePoint
Rotate a point around a pivot.
pixelsToMetres
Convert pixels to metres.
pixelsToMeters
Alias for pixelsToMetres
metresToPixels
Convert metres to pixels.
metersToPixels
Alias for metresToPixels
degToRad
Convert degrees to radians.
radToDeg
Convert radians to degrees.
getBearingTo
Get the bearing from fromPos to toPos in the range 0-360.
moveForwardOnBearing
Move a position along bearing and return the result.
bearingToCompassText
Convert a bearing to approximate compass text heading (e.g N, NE, E etc)
rotateTowards
Rotate angle towards target angle.
getDistance
Get the distance between 2 points in pixels.
getDistanceMetres
Get the distance between 2 points in metres.
getDistanceMeters
Alias for getDistanceMetres.
clamp
Clamp a number between two values.
min
Return the smallest of two values.
max
Return the largest of two values.
lerp
Linear interpolate a value between a and b by the normalised fraction t.
fmodf
Return the fraction remainder of x/y.
createStringHash
Generate a hash value from a string (string is case sensitive).
createStringHashLowerCase
Generate a lower case hash value from a string (string is automatically converted to lower case).

Mission

getSinglePlayerRespawnEnabled
Determine if single player respawn is enabled.
setSinglePlayerRespawnEnabled
Enable or disable single player respawn instead of reloading the level.
getSinglePlayerPowerUpsStay
Get whether "stay in coop" power-ups also stay in single player (single player/server only).
setSinglePlayerPowerUpsStay
Set whether "stay in coop" power-ups also stay in single player (single player/server only).
getSwimmingEnabled
Determine if swimming is enabled.
setSwimmingEnabled
Enable or disable swimming (server only).
endLevel
End the current level (server only).
gameOver
Fails the mission in single player and multiplayer.
runMap
Play a map (server only).
playMovieClip
Play a FLC movie clip from the base folder.
setSideID
Set side ID of an entire side (faction) for the duration of the mission.
setMissionMoveToPos
Display a distance and direction indicator to the specified position.
clearMissionMoveToPos
Clear the current mission move to position (stops displaying the distance/direction indicators).
getMissionMoveToPos
Get the current mission move to position.
getMissionMoveToName
Get the current mission move to name.
createTriggerBox
Create a trigger box (local only).
deleteTriggerBox
Delete a trigger box (local only).
setTriggerBoxEnabled
Create a trigger box (local only).
getTriggerBoxEnabled
Get the enabled status of a trigger box.
inTriggerBox
Determine if an object is within a trigger box.
getMinimapOpen
Get whether the minimap is currently open on the local computer.
setMinimapOpen
Open or close the minimap on the local computer.
getMinimapEnabled
Get the enabled status of the minimap.
setMinimapEnabled
Set the enabled status of the minimap (server only).
getShowRemotePlayerLocations
Get the enabled status of the minimap.
setShowRemotePlayerLocations
Enable or disable showing remote player locations (server only).
skipShowPlayerLocation
Skip the "you are here" screen when starting the mission in single player (local only).
getMapTreesUpdateSpeed
Get trees minimap update speed.
setMapTreesUpdateSpeed
Set the speed trees are added to the minimap (local only).
getCorpseLimit
Get the maximum number of corpses allowed on the map.
setCorpseLimit
Set the maximum number of corpses allowed on the map (server only).
getWreckLimit
Get the maximum number of wrecks allowed on the map.
setWreckLimit
Set the maximum number of wrecks allowed on the map (server only).
getSkillLevel
Get the game skill level.
setSkillLevel
Set the game skill level.
getTimeLimit
Get the remaining mission time limit in seconds.
setTimeLimit
Set the mission time remaining in seconds.
sendAirstrike
Send airstrike/air support for the specified side (server and client).
getFlashlightSize
Get the current player flashlight size.
setFlashlightSize
Change the player flashlight colour.
getFlashlightColour
Get the current player flashlight size.
setFlashlightColour
Set the player flashlight colour for the duration of the mission.

Network

isSinglePlayer
Is game single player?
isMultiplayer
Is game multiplayer?
isServer
Is local computer a server or single player?
isMultiplayerServer
Is local computer a multiplayer server?
isClient
Is local computer network client?
isCoop
Is game cooperative?
isHeadToHead
Is game head to head (aka deathmatch)?
getMaxPlayers
Get the maximum number of players that can possibly be in the current game.
syncVar
Syncs a variable to all players.
netExec
Execute a string of code on a remote computer.
getNetExecEnabled
Get netExec function enabled status.
setNetExecEnabled
Enable netExec function on all computers (server only).
getClientsConsoleEnabled
Get clients script console enabled status.
setClientsConsoleEnabled
Enable clients script console on all clients (server only).
netExecSelf
Execute the current function with the same arguments on a remote computer.

Object

createObject
Create an object (server only).
deleteObject
Delete an object (server only).
moveAwayVanish
Tell an object to move away before being deleted when out of sight (server only).
getHidden
Get the hidden status of an object.
setHidden
Set the hidden status of an object.
getSimulate
Get the simulate status of an object.
setSimulate
Start or stop simulating an object.
showTeleport
Perform a teleport effect on an object. This function: - Plays a teleport sound effect. - Shows the object. - Damages objects underneath the object.
getSide
Get the side of an object.
setSide
Set the side of an object.
getHostile
Determine if an object is hostile/enemy.
getHits
Get the hits (health) of an object.
setHits
Set the hits (health) of an object.
getMaxHits
Get the maximum hits (hp) of an object.
getArmour
Get the armour of an object in the range (0 to 90).
getIndestructible
Get the indestructible status of an object.
setIndestructible
Set the indestructible status of an object.
damageObject
Damage an object.
getSpeed
Get the current speed of an object.
getMaxSpeed
Get the maximum speed of an object.
setMaxSpeed
Set the maximum speed of an object.
getDefaultMaxSpeed
Get the default maximum speed of an object.
getAiType
Get the AI type of an object.
setAiType
Set the AI type of an object.
moveTo
Tell an object to move to a position.
getWanderChance
Get an object's wander chance (0 to 100).
setWanderChance
Set an object's wander chance.
getWanderDistance
Get how far an object can wander from it's home position.
setWanderDistance
Set how far an object can wander from it's home position.
getHomePos
Get an object's home position.
setHomePos
Set an object's home position.
getLocked
Get the locked status of an object.
setLocked
Set the locked status of an object.
getActive
Get the active status of an object.
getForceActive
Get the force active status of an object.
setForceActive
Set the force active status of an object (server only).
getWeaponsRange
Get the maximum weapons range of an object.
getSightRange
Get the sight range/distance of an object.
isEnemyNear
Determine if any enemies are nearby an object.
isEnemyVisible
Determine if an object can see any enemies.
getTarget
Get enemy that this object is currently targeting.
isTarget
Determine if an object is currently being targeted by an enemy.
getTargetingObjects
Get all objects currently targeting an object.
getNoTarget
Get the no target status of an object.
setNoTarget
Set the no target status of an object.
getHoldFire
Get the hold fire status of an object.
setHoldFire
Set the hold fire status of an object.
getUnitHasFlashlight
Determine if the specified unit has a flashlight.
setUnitHasFlashlight
Give or take a flashlight from the specified unit.
getFlashlightOn
Determine if a unit's flashlight is on.
setFlashlightOn
Switch a unit's flashlight on or off.
getLightMountEnabled
Get the local enabled status of an object light mount (local only).
setLightMountEnabled
Set the local enabled status of an object light mount (local only).
getDrawOrder
Get the draw order of an object.
setDrawOrder
Manually set the draw order of an object (server and clients).
getOriginalDrawOrder
Get the original/initial draw order of an object.
setOriginalDrawOrder
Manually override the original/initial draw order of an object (server and clients).
objectExists
Check if an object exists.
getTypeNumber
Get an object type number from an object ID.
getTypeName
Get an object type name from an object ID.
getTypeNameLowerHash
Get an object type lower hash name from an object ID.
objectTypeNameToNumber
Resolve an object type name to an object type number.
objectTypeNumberToName
Resolve an object type number to an object type name.
getClassName
Get the class name for an object (e.g. "Car" or "Helicopter")
getTypeClassLowerHash
Get an object class name lower hash from an object ID.
getTypeClassName
Get the class name of an object type.
setFollow
Set an object to follow another object.
getFollowingObjects
Get list object IDs that are following the specified object (leader).
getLeader
Get the leading object being followed by the specified object.
isOverWater
Is an object entirely over water?
getOverWaterScore
Get an object over water score.
isSwimming
Is an object swimming?
isUnderwater
Is an object underwater?
isSubmerged
Is an object submerged?
isMoving
Is an object moving?
getHasWetsuit
Determine if the specified unit has a wetsuit.
setHasWetsuit
Give or take wetsuit from the specified unit.
resetRespawnCoords
Update the respawn coordinates of an object to it's current coordinates (server only).
getDisplayName
Get the display name of an object.
getDescription
Get the description of an object.
getTypeSize
Get the size of an object type in pixels.
getInteractionEnabled
Get whether interaction is enabled for an object.
setInteractionEnabled
Set whether interaction is enabled for an object.
getMultiplayerRespawnEnabled
Get whether an object respawns in multiplayer.
setMultiplayerRespawnEnabled
Set whether an object respawns in multiplayer. (server only)
isLocal
Determine if an object is local.
getPaintEnabled
Determine if paint is enabled for an object.
setPaintEnabled
Enable or disable paint for an object.
getPaintColour
Get the paint colour of an object.
setPaintColour
Set the paint colour of an object.
getPaintTexture
Get the paint texture of an object.
setPaintTexture
Set the paint texture of an object.
getPaintTextureScale
Get the paint texture scale of an object.
setPaintTextureScale
Set the paint texture scale of an object.
attachObject
Attach an object to another object (server and clients).
detachObject
Detach an attached object from it's parent (server and clients).
getAttachedObjects
Get a list of object IDs that are attached to the specified parent object (server and clients).
getAttachedToParent
Get an attached object's parent object ID.
getIsVivTransport
Determine if an object is a vehicle in vehicle (VIV) transport (e.g. LCVP boat).
getVivObject
Get the object currently loaded onto the specified VIV transport vehicle.
getVivParent
Get the VIV transport vehicle that the specified object is loaded onto
vivLoad
Load object onto parent VIV transport vehicle. Will fail is another vehicle is already loaded.
vivUnload
Unload object from parent VIV transport vehicle.
getTrailerObject
Get the current trailer object by the specified parent object (server and clients).
getTrailerParent
Get the parent object for the specified trailer object (server and clients).
getTrailerFront
Get the front parent object for the specified trailer object (server and clients).
setTrailerObject
Set the trailer object of the specified parent object (server and clients).
createTrailerChain
Creates a chain of trailer objects (server and clients).
carryObject
Pick up a carriable object (server and clients).
dropCarryingObject
Drop a carried object (server and clients).
getCarryingObject
Get the current object carried by the specified parent object (server and clients).
getCarryingParent
Get the parent for an object that is being carried.
addAction
Add an object action.
removeAction
Remove an object action.
removeAllActions
Remove all actions from an object.
getActionEnabled
Determine if an object action is enabled.
setActionEnabled
Enable to disable an object action.
getActionEnabled
Determine if an object action exists.
getActionsCount
The the count of actions for an object.

Output

print
print text to the screen and console.
log
Output text to the log only.
logPrint
Print text to the screen and console. Also output text to the log file.

PDA

getPdaOpen
Deterine if the PDA tablet is currently open.
setPdaOpen
Open or close the PDA tablet on the local computer.
addPdaMessage
Add message to the PDA tablet on the local computer.
loadPdaMessage
Load a PDA message from the current briefing file (MapName.txt).
removePdaMessage
Remove a message from the PDA tablet on the local computer.
clearAllPdaMessages
Remove all messages from the PDA tablet on the local computer.
getPdaBatteryLevel
Get the PDA battery level.
setPdaBatteryLevel
Set the PDA battery level.
getPdaSignalOn
Get the PDA signal/uplink status.
setPdaSignalOn
Set the PDA signal/uplink status.

Physics

getMass
Get the mass of an object in KG.
setMass
Set the mass of an object in KG.
getLinearVelocity
Get the linear velocity of an object in m/s.
setLinearVelocity
Set the linear velocity of an object in m/s.
getAngularVelocity
Get the angular velocity of an object in radians.
setAngularVelocity
Set the angular velocity of an object in radians.
getKinematic
Get the kinematic status of an object.
setKinematic
Set the kinematic status of an object.
applyForce
Apply a linear force to the centre of an object.
applyImpulse
Apply a linear impulse to the centre of an object.
applyAngularImpulse
Apply an angular impulse to an object.
setCollidesWith
Set if an object can collide with another object.

Player

isPlayer
Determine if an objectID is a player.
getLocalPlayerObject
Get local player game object. Same as using PLAYER_OBJECT global variable.
getPlayerObject
Get a player game object from a playerID.
setPlayerObject
Set a player object ID (player becomes that object) (local player and server only).
getObjectPlayer
Get a player ID from a player game object.
getLocalPlayer
Get the local playerID (not objectID).
getServerPlayer
Get the server player's object ID.
getPlayerAtIndex
Get the player ID of another player by index.
getPlayersCount
Get the number of players in the game.
playerExists
Determine if a player ID exists.
getPlayerName
Get a player's profile name.
getPlayerState
Get a player's current state.
getPlayerScopeAiming
Determine if a player is scope aiming.
getPlayerScopeImagingMode
Get player's scope imaging mode.
getPlayerInteractionEnabled
Get local player interaction enabled status.
setPlayerInteractionEnabled
Enable or disable local player interaction/E key (local only)
getPlayerGodModeEnabled
Get local player god mode enabled status.
getNearestPlayer
Get the nearest spawned player to a position.
getNearestPlayerDistance
Get the distance to the nearest spawned player from a position.
getPlayerCurrentWeaponRange
Get a player's current weapon range in pixels.
getPlayerWeaponLaserOn
Determine if player's weapon laser is switched on.
getPlayerWeaponLaserDistance
Get the length of a player's weapon laser.
getLookObject
Get the local player look object.

Prefab

loadPrefab
Additive load a map into the current map.
getPrefabTypesCount
Get the number of available prefab types (maps marked as "Prefab").
getPrefabTypeFilename
Get a prefab type filename by index.
getPrefabTypeDescription
Get a prefab type description by index.
getPrefabTypeSize
Get a the dimension in pixels of a prefab type by index.

Projectile

getProjectileOwner
Get a projectile owner's object ID.
getProjectileInstigator
Get a projectile instigators's object ID.
getProjectileSpeed
Get a projectile's speed.
getProjectilePos
Get a projectile's position in pixels.
setProjectilePos
Set a projectile's position in pixels (single player/server only).
getProjectileAngle
Get a projectile's angle in degress.
setProjectileAngle
Set a projectile's angle in degress (single player/server only).

Radio

sendRadioMessage
Send a radio transmission from the specified unit.
getUnitHasRadio
Determine if the specified unit has a radio.
setUnitHasRadio
Give or take a radio from the specified unit.
getUnitRadioRange
Get the current radio range on the specified unit in metres.
getRadioRange
Get the current radio range in metres.
setRadioRange
Set the current radio range in metres.
getSkipRadioRange
Get the miniumum distance in metres that nearby units use the radio.
setSkipRadioRange
Set the miniumum distance in metres that nearby units use the radio.
getRadioAirstrikesEnabled
Determine if radio random enemy airstrikes are enabled.
setRadioAirstrikesEnabled
Enable or disable random enemy airstrikes if the radio is used too much during the daytime.

Sector

createSector
Create a new sector.
updateSectors
Update map sectors, physics and minimap etc after creating new sectors using createSector or changing sectors passable type using setSectorPassableType. This is called automatically once per frame if needed. Call this function to update instantly instead.
getDefaultSectorTexture
Get the default sector texture name (no texture).
getSectorTexture
Get a sector's texture name.
setSectorTexture
Set a sector's texture name.
getSectorPassableType
Get a sector's passable type. passableType value examples: TPT_LAND, TPT_WATER, TPT_SOLID, TPT_CLOSED, TPT_LOW_WALL
setSectorPassableType
Set a sector's passable type. passableType value examples: TPT_LAND, TPT_WATER, TPT_SOLID, TPT_CLOSED
getSectorBevelType
Get a sector's bevel type. bevelType value examples: BT_FLAT, BT_RAISED, BT_SUNK
setSectorBevelType
Set a sector's bevel type. bevelType value examples: BT_FLAT, BT_RAISED, BT_SUNK
getSectorWaterEffect
Get a sector's water effect flag.
setSectorWaterEffect
Set a sector's visual water effect flag.
getSectorIsShadow
Get a sector's shadow flag.
setSectorIsShadow
Set a sector's shadow flag.
getSectorShadowMode
Get a sector's shadow mode.
setSectorShadowMode
Set a sector's shadow mode.
getSectorHidden
Get a sector's hidden status.
setSectorHidden
Show or hide a sector.
getSectorTriggerEnabled
Determine if a sector's script trigger is enabled.
setSectorTriggerEnabled
Enable or disable a sector's script trigger.
getSectorDamage
Get a sector's damage amount to apply to ground objects (e.g. lava floor).
setSectorDamage
Set a sector's damage amount to apply to ground objects (e.g. lava floor).
getSectorLightLevel
Get a sector's light level.
setSectorLightLevel
Set a sector's light level.
getSectorFlowSpeed
Get a sector's flow speed (aka conveyor speed).
setSectorFlowSpeed
Set a sector's flow speed (aka conveyor speed).
getSectorTeleportID
Get a sector's teleport ID.
setSectorTeleportID
Set a sector's flow speed (aka conveyor speed).
getSectorPos
Get the centre position of the specified sector.
getFirstFreeTeleportID
Get the first (lowest) available free teleport ID on the map.
openDoor
Opens a door sector just as if the player had walked into it.
closeDoor
Closes a door.
openForcefield
Opens a forcefield (changes sector to passable and sets texture to forcefield opened texture).
closeForcefield
Closes a forcefield (changes sector to solid and sets texture to specified texture).

Spatial

getPos
Get the position of a unit or player.
setPos
Set the position of a unit or player.
getAngle
Get the direction/angle of a unit or player in the range 0-360.
getDir
Alias for getAngle
setAngle
Set the angle/direction of a unit or player in the range 0-360.
setDir
Alias for setAngle
getHeight
Get the height above the ground of an object.
getMaxHeight
Get the maximum height above the ground of an object.

Speech

sayText
Display a text message as if the object is speaking and optionally play speaking sound effect.
getVoiceNumber
Get an object's voice number.
setVoiceNumber
Set an object's voice number (server only).
getAnnouncementsEnabled
Determine if annoucements are enabled for the current mission.
setAnnouncementsEnabled
Enable or disable annoucements (server only).

Sprite

createSprite
Create a map sprite (server only).
deleteSprite
Delete a map sprite (server only).
getSpritePos
Get a map sprite position (in pixels).
setSpritePos
Set a map sprite position.
getSpriteAngle
Get a map sprite angle (in degrees).
setSpriteAngle
Set a map sprite angle.
getSpriteHidden
Get sprite hidden status.
setSpriteHidden
Show or hide a sprite.
getSpriteLifetime
Get a sprite's remaining lifetime (server only).
setSpriteLifetime
Set a sprite's remaining lifetime in seconds.
getPaintColour
Get the paint colour of a sprite.
setSpritePaintColour
Set the paint colour of a sprite.
spriteExists
Check if a map sprite exists.
getSpriteTypeNumber
Get a sprite type number from a map sprite ID.
getSpriteTypeName
Get a sprite type name from a map sprite ID.
getSpriteTypeNameLowerHash
Get a sprite type name lower case hash from a map sprite ID.
spriteTypeNumberToName
Resolve a sprite type number to a sprite type name.
spriteTypeNameToNumber
Get a sprite type number from a sprite type name.

String

string::lower
Convert a string to lower case.
string::upper
Convert a string to upper case.
extractFilename
Return the file name part only from a path string.
replaceFilename
Replace the file name part only from a path string.
extractPath
Return the path part only from a path string.
extractFileExtension
Return the file name part only from a path string.
replaceFileExtension
Return the file name part only from a path string.

System

getScriptPlayerID
Get the player ID that instigated the current script code.
getScriptPlayerNumber
Get the player index that instigated the current script code.
getScriptPlayerObject
Get the object for the player that instigated the current script code.
passToConsole
Run console command.
isGamePaused
Check whether the game is paused.
gameHasFocus
Check whether the game is focused.
playerHasControl
Check whether the local player currently has control.
getElapsedTime
Gets the time, in seconds, since the mission started.
saveGameVar
Sasve a game variable to a saved game file. Only works within onGameSave() event.
loadGameVar
Load a game variable from a saved game file. Only works within onGameLoad() event.

getScreenSize
Get the screen size in pixels
screenToWorld
Convert screen pixel coordinates to a world position.
worldToScreen
Convert a world position to screen pixel coordinates.
getWorldWindowStart
Get the world window start position (world position under top-left pixel).
getWorldWindowSize
Get the world window size in world pixels (not metres or screen pixels).
posInWorldWindow
Determine is a world position (in world pixels) is within the world window.
getWorldRenderScale
Get the current world render scale (zoom level).
colToHTML
Convert a unsigned byte colour in the format RGBA to HTML style string.
htmlToColR
Get the red value from HTML style colour string (0-255).
htmlToColG
Get the green value from HTML style colour string (0-255).
htmlToColB
Get the blue value from HTML style colour string (0-255).
htmlToColA
Get the alpha value from HTML style colour string (0-255).
gameMessage
Display a game message either locally (default) or on other computers.
gameMessageObject
Display a game message to the player with the specified object ID.
gameMessageNear
Display a game message to players near the specified object ID.
gameMessageNear
Display a game message to players near the specified position.
introMessage
Display an intro message (local only).
messageBox
Display a message box (local only).
confirmBox
Display a confirmation box with message (local only).
stringInputBox
Display a string input box with message (local only).
createToolbar
Create a toolbar (local only).
deleteToolbar
Delete a toolbar and all associated buttons (local only).
addToolbarButton
Add a button to an existing toolbar (local only).
addToolbarSeparator
Add a separator to an existing toolbar (local only).
addMenu
Add an interaction menu.
removeMenu
Remove an interaction menu.
addMenuItem
Add an interaction menu item.
removeMenuItem
Remove an interaction menu item.
menuItemExists
Determine if an interaction menu item exists.
getMenuItemHidden
Get if an interaction menu item is hidden.
setMenuItemHidden
Set if an interaction menu item is hidden.
openInteractionMenu
Open specified interaction menu.
showInteractionMenu
Show an interaction menu from an array of items.
getInteractionMenuOpen
Determine if any interaction menu is currently open.
getMissileAlarmEnabled
Determine if the "Missile alarm" option is enabled in the local options.

Var

getVar
Get a named variable value from an object.
setVar
Set a named variable value to an object.
getVarNames
Get an array with all the variable names from an object.

Vehicle

inVehicle
Get whether an object is in a vehicle.
getVehicle
Get the vehicle object ID which an object is in, or the object's ID if not in a vehicle.
getInVehicle
Place an object in a vehicle.
getOutOfVehicle
Get an object out of a vehicle.
createVehicleCrew
Create a crew within a vehicle (server only).
changeSeat
Change an object's seat in a vehicle.
getObjectSeatIndex
Get the seat index in the current vehicle for the specified object.
getVehicleOccupants
Get a list of all occupants in a vehicle.
getVehicleCrew
Get a list of all crew members in a vehicle.
getVehiclePassengers
Get a list of all passengers in a vehicle.
getVehicleOccupantsCount
Get the amount of occupants in a vehicle.
getVehicleSeatsData
Get information about the seats in a vehicle.
getVehicleTypeSeatsData
Get information about the seats in a vehicle.
hoot
Hoot vehicle horn (server and clients).
getFuel
Get the amount of fuel in a vehicle.
setFuel
Set the amount of fuel in a vehicle.
addFuel
Add fuel to a vehicle.
isFuelFull
Determine if a vehicle fuel tank is full.
getFuelCapacity
Get the fuel capacity of a vehicle in litres.
setFuelCapacity
Set the fuel capacity of a vehicle in litres.
getFuelConsumptionRatio
Get the fuel consumption ratio of a vehicle.
setFuelConsumptionRatio
Set the fuel consumption ratio of a vehicle.
getPumpFuel
Get the amount of fuel in a fuel pump.
setPumpFuel
Set the amount of fuel in a fuel pump.
addPumpFuel
Add fuel to a fuel pump.
getDefaultFuelPumpCapacity
Get the default fuel pump capacity for a game object.
refuelAtPump
Begin refilling vehicle fuel from a fuel pump.
stopRefueling
Stop an object refueling.
getRefuelingPumpID
Get the pump ID that a vehicle is currently refueling from.
getNeedsCarBattery
Determine if a vehicle requires a car battery to function.
getHasCarBattery
Determine if a vehicle has a car battery.
setHasCarBattery
Install or remove a car battery from a vehicle.
getAutoBrake
Get the automatic brake status of an object.
setAutoBrake
Set the automatic brake status of an object.
getEngineOn
Determine if a vehicle's engine is on.
setEngineOn
Switch a vehicle's engine on or off.
getHeadlightsOn
Determine if a vehicle's headlights are on.
setHeadlightsOn
Switch a vehicle's headlights on or off.
getBeaconLightsOn
Determine if a vehicle's beacon lights are on.
setBeaconLightsOn
Switch a vehicle's beacon lights on or off.
getNavLightsOn
Determine if a vehicle's navigation lights are on.
setNavLightsOn
Switch a vehicle's navigation lights on or off.

Waypoint

bindToWaypoint
Make an object follow a waypoint.
bindToWaypointSoft
Make an object follow a waypoint. The object will stop following the waypoint if it gets stuck.
getCurrentWaypointID
Get an object's current waypoint ID.
createWaypoint
Create a waypoint.
deleteWaypoint
Delete a waypoint.
getNextWaypointID
Get a waypoint's next waypoint ID.
setNextWaypointID
Set a waypoint's next waypoint ID.
getWaypointPos
Get a waypoint's position.
setWaypointPos
Set a waypoint's position.
waypointExists
Determine if a waypoint exists.

Weapon

getPlayerWeapon
Get the specified player's current weapon slot index.
setPlayerWeapon
Set the specified player's current weapon slot index (local player or server only).
clampPlayerWeapon
Clamp a player's current weapon index to a valid (and owned) weapon slot (local player or server only).
hasWeapon
Determine if an object has a specific weapon.
getWeaponSlotItemNumber
Get the item type index for an object weapon slot.
getWeaponSlotItemName
Get the item type name for a player weapon slot.
getWeaponSlotsCount
Get the number of weapon slots an object has.
hasLinkedWeapons
Determine if an object has linked weapons (all turrets fire at the same time).
isUsingMissileWeapon
Determine if an object is currently using a missile weapon.
getWeaponAimingAngle
Get the aiming angle of a specified turret.
getWeaponMountWorldPos
Get the world position of a specified turret mounting point.
getWeaponFireWorldPos
Get the world position of a specified turret firing point (end of barrel).
throwGrenade
Make an object throw a grenade.

World

getWorldName
Get the world name (map title)
getWorldSeed
Get the world random seed.
setWorldSeed
Set the world random seed for new objects. The random seed is used to generate object names (e.g. character names and vehicle callsigns). Using a seed ensures that object names will always be the same each time the map is run. The default seed is generated from the map filename so renaming a map will rename all the people on it.
getWorldSize
Get the world (map) size in pixels.
setWorldSize
Set the world (map) size in pixels.
getInfiniteMap
Determine if the map is infinite.
setInfiniteMap
Enable or disable infinite map. (server only)
getPlayerFlyOffMap
Determine if players are allowed to fly aircraft off the map.
setPlayerFlyOffMap
Enable or disable players being able to fly off and outside of the map. (server only)
getAirHeight
Get the air render layer height in pixels.
isPosOnMap
Determine if a position is on the map.
clampPosToMap
Clamp a position to the map.
isPosNearMap
Determine if a position is near the map.
isRectOnMap
Determine if a rectangular area intesects the map.
getPosTerrainPassableType
Get terrain passable type at exact position (in pixels).
getMaterialNameAtPos
Get material name of uppermost sector the texture at a position (in pixels).
getMaterialNameLowerHashAtPos
Get material name lower case hash of the uppermost sector texture at a position (in pixels).
getTextureNameAtPos
Get texture name of the uppermost sector texture at a position (in pixels).
findNearEmptyPos
Find an empty nearby land or water position.
findNearRandomPos
Find a random nearby position without any checking.
findEmptyPos
Find an empty land or water position anywhere on the map.
findRandomPos
Find a random position anywhere on the map without any checking.
isRectPassable
Check if a rectangle is passable to the specified terrain type.
checkLineOfSight
Check line of sight is clear between 2 points.
raycast
Perform a single raycast check along a line.
setLightLevel
Set the world light level (server only)
getLightLevel
Get the world light level.
getNightLightLevel
Get the night light level threshold value.
isNight
Is night?
setLightColour
Set the world light colour (server only)
getLightColour
Get the world light colour.
getNightLightsOn
Determine if it is dark enough for night only lights to be visible.
setRain
Set the rain intensity (server only)
getRain
Get the world rain intensity.
setWindSpeed
Set the world wind speed in m/s (server only)
getWindSpeed
Get the world wind speed in m/s.
getWindSpeedNormalised
Get the normalised world wind speed between 0 and 1 where 1 is the max wind speed (currently 33 m/s).
setWindDir
Set the world wind direction in degrees (0-360) (server only)
getWindDir
Get the wind direction in degrees (0-360).
getWindVector
Get the wind blowing vector in m/s.
getWindVectorNormalised
Get the wind blowing vector normalised (1 = 33 m/s).
setFog
Set the world fog density (server only)
getFog
Get the world fog density.
setFogColour
Set the world fog colour (server only)
setFogColor
Alias for setFogColour.
getFogColour
Get the world fog colour.
getFogColor
Alias for getFogColour.
setAmbientFlag
Set an ambient flag for the duration of the mission (local only).
setAllAmbientFlags
Set all ambient flags for the duration of the mission.
getAmbientFlag
Get an ambient flag value.
getAmbientValue
Get a current ambient flag evaluated value.
getAmbientSoundsGain
Get the ambient shore pos.
getAmbientSoundsGain
Get the ambient sound gain.
createTreeSpawner
Create a tree spawner.
deleteTreeSpawner
Delete a tree spawner.
updateTrees
Force trees and trees on minimap update.
saveMap
Save the map to a .map file.
saveMapSectorsOverlay
Save minimap sectors overlay image to .png file.
saveMapTreesOverlay
Save minimap trees overlay image to .png file.
getObjectsCount
Get total number of alive objects on the map.
getHumansCount
Get total number of alive humans on the map.
getVehiclesCount
Get total number of alive vehicles on the map.
getNearObjects
Get all objects in a circle.
getAllObjects
Get all objects.
getNearSprites
Get all map sprites in a circle.
getAllSprites
Get all map sprites.

Events

onWorldStart
Called after the map is loaded on the server.
onStart
Called after the map is loaded on each computer.
onPlayerSpawn
Called when any player spawns or respawns.
onTriggerBoxEnter
Called when any object or player enters a trigger box.
onTriggerBoxExit
Called when any object or player exits a trigger box.
onTick
Called on each tick (normally 30 times per second).
onUpdate
Called every frame.
onClientConnected
Called when a client connects.
onClientDisconnected
Called when a client connects.
onObjectSpawn
Called after an object or player spawns.
onObjectRespawn
Called after an object is respawned.
onObjectTargetChanged
Called when a object's target has changed.
onObjectDamaged
Called after an object or player is damaged.
onObjectKilled
Called when a object or player is killed.
onWaypointReached
Called when a object reaches a waypoint.
onMoveToComplete
Called when a object reaches its destination or fails to reach its destination using moveTo.
onVehicleEnter
Called when a unit enters a vehicle.
onVehicleExit
Called when a unit exits a vehicle.
onVehicleSubmerged
Called when a vehicle becomes submerged.
onPickupItem
Called when any player picks up an item.
onGameSave
Called while the game is being saved.
onGameLoad
Called while the game is being loaded.
onInitHud
Called when the HUD is initialised (also when player changes vehicle).
onBeforeDrawHud
Called just before the HUD is drawn.
onAfterDrawHud
Called just after the HUD is drawn.
onInitAmbientSounds
Called just after local ambient system is initialised.
onUpdateAmbientSounds
Called every frame to update ambient sounds.
onInitAmbientWildlife
Called just after local ambient widlife system is initialised.
onTickSpawnAmbientWildlife
Called to spawn ambient wildlife via script.
onInitAmbientPlants
Called just after local ambient plants system is initialised.
onTickSpawnAmbientPlants
Called to spawn ambient plants via script.
onProjectileSpawn
Called after an projectile is spawned.
onProjectileHit
Called after an projectile hits something.
onProjectileDelete
Called just before a projectile is deleted.

Legacy Events

OnMapStart
Deprecated event, use onWorldStart instead.
OnObjectHurt_???
Deprecated event, use onObjectDamaged instead.
OnObjectDie_???
Deprecated event, use onObjectKilled instead.
OnWaypointReached_???
Deprecated event, use onWaypointReached instead.
OnEnterVehicle_???
Deprecated event, use onVehicleEnter instead.
OnExitVehicle_???
Deprecated event, use onVehicleExit instead.
OnObjectTypeEnter
Deprecated event, use onVehicleEnter along with getTypeNumber instead.
OnObjectTypeExit
Deprecated event, use onVehicleExit along with getTypeNumber instead.
OnObjectLaserTrip_???
Deprecated event, use onLaserTripped instead.