Meteor Scripting Functions

Audio

playSound
Play a sound locally without spatialisation.
playSound2D
Play a sound from a 2D position.
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.
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?

Effects

createExplosion
Create an in-game explosion (server only).
fade
Fades out the screen, displays a message and fades back in.
getCinematicBarsEnabled
Gets whether the cinematic bars are enabled.
setCinematicBarsEnabled
Sets whether the cinematic bars are enabled.

Input

mousePos
Get the mouse screen position in pixels
mouseWithin
Determine if a mouse button 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 (server only).
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.

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.
randomArray
Pick a random element from an array.
pixelsToMetres
Convert pixels to metres.
metresToPixels
Convert metres to pixels.
getBearingTo
Get the bearing from fromPos to toPos in the range 0-360.
moveForwardOnBearing
Move a position along bearing and return the result.
getDistance
Get the distance between 2 points in pixels.
getDistanceMetres
Get the distance between 2 points in metres.
clamp
Clamp a number between two values.

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).
getAutoPlayerNightGearEnabled
Determine whether to automatically issue players with night gear (single player/server only).
setAutoPlayerNightGearEnabled
Set whether to automatically issue players with night gear (single player/server only).
endLevel
End the current level (server only).
gameOver
Kill the local player.
runMap
Play a map (server only).
playMovieClip
Play a FLC movie clip from the base folder.
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.
getMinimapEnabled
Get the enabled status of the minimap.
setMinimapEnabled
Set the enabled status of the minimap (server only).
skipShowPlayerLocation
Skip the "you are here" screen when starting the mission in single player (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).

Network

isMultiplayer
Is game is multiplayer?
isServer
Is local computer a server or single player?
isClient
Is local computer network client?
isCoop
Is game cooperative?
isHeadToHead
Is game head to head (aka deathmatch)?
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).

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.

Player

isPlayer
Determine if an objectID is a player.
getPlayer
Get the local player ID.
getServerPlayer
Get the server player ID.
getPlayerAtIndex
Get the player ID of another player by index.
getPlayersCount
Get the number of players in the game.
getPlayerState
Get a player's current state.
getNearestPlayer
Get the nearest spawned player to a position.
getNearestPlayerDistance
Get the distance to the nearest spawned player from a position.
getPlayerLastKilledPos
Get a player's last killed position.
getPlayerWeapon
Get the specified player weapon slot index.
setPlayerWeapon
Set the specified player weapon slot index (local player or server only).
clampPlayerWeapon
Clamp the player weapon index to a valid/owned weapon slot (local player or server only).
playerHasWeapon
Determine if a player has a weapon.
getPlayerWeaponSlotItemNumber
Get the item type index for a player weapon slot.
getPlayerWeaponSlotItemName
Get the item type name for a player weapon slot.
getPlayerWeaponSlotsCount
Get the number of player weapon slots.
getPlayerNoTarget
Get whether enemies can target a player.
setPlayerNoTarget
Set whether enemies can target a player. (server only)

Power-Ups

createPowerUp
Create a powerup (server only).
getNearPowerUps
Get the powerups in a circle.

Spatial

getPos
Get the position of a unit or player.
setPos
Set the position of a unit or player.
getDir
Get the direction of a unit or player in the range 0-360.
setDir
Set the direction of a unit or player in the range 0-360.

Sprite

createSprite
Create a sprite (server only).
deleteSprite
Delete a sprite (server only).

System

passToConsole
Run console command.
isGamePaused
Check whether the game is paused.
gameHasFocus
Check whether the game is focused.
playerHasControl
Check whether the 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.
gameMessage
Show a game message.
drawText
Draws UI text to the screen for the current frame.
fontHeight
Get the height of a font.
textWidth
Get the width of a string of text in pixels.
addHint
Show a hint on the screen at specified position.
removeHint
Remove a hint by hintID.
generateHintID
Generates a unique ID for use with addHint and removeHint
drawRectangle
Draw a rectangle using absolute coordinates.
drawRectangleWH
Draw a rectangle at the specified top-left position, width and height.
drawRectangleWHCentred
Draw a rectangle at the specified centre position and size.
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.
showStringInputDialog
Show a string input dialog.
showConfirmDialog
Show a confirmation dialog.
showTextViewer
Display text from a file or from a single string.

Unit

createUnit
Create a unit (server only).
deleteUnit
Delete a unit (server only).
getNearUnits
Get all units in a circle.
getAllUnits
Get all units.
getUnitDisplayName
Get a unit or player's display name.
setUnitDisplayName
Set a unit's display name (server only).
getUnitDescription
Get the description of a unit (e.g. "Bird")
getUnitFilename
Get the filename of a unit (e.g. "BIRD.INI")
getUnitSide
Get the side of a unit.
getSideName
Get the name for a side number
getUnitSize
Get the size of a unit in pixels.
getUnitTypeSize
Get the size of a unit type in pixels.
setUnitForceActive
Enable/disable unit force active (server only).
getUnitForceActive
Get unit force active status.
setDamage
Set unit or player damage (server only).
getDamage
Get unit or player damage.
getUnitTarget
Get a unit's target (server only).
setUnitSight
Set unit sight (server only).
getUnitSight
Get unit sight.
getUnitClass
Get a unit class for unit.
getUnitTypeClass
Get a unit class for unit's type.
getNextUnitID
Get the next unit ID to be allocated.

World

getWorldName
Get the world name (map title)
getWorldSize
Get the world (map) size in pixels.
getWorldTilesSize
Get the world (map) size in tiles.
getTile
Get a tile from the map.
setTile
Set a tile on the map (server only).
isPosOnMap
Determine is 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.
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.
checkLineOfSight
Check line of sight is clear between 2 points.
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?

Events

onWorldStart
Called after the map is loaded.
onPlayerSpawn
Called when any player spawns or respawns.
onTriggerBoxEnter
Called when any unit or player enters a trigger box.
onTriggerBoxExit
Called when any unit or player exits a trigger box.
onTick
Called on each tick (normally 30 times per second).
onUpdate
Called rendered every frame.
onClientConnected
Called when a client connects.
onClientDisconnected
Called when a client connects.
onUnitSpawn
Called after a unit or player spawns.
onUnitTargetChanged
Called when a unit's target has changed.
onUnitDamaged
Called after a unit or player is damaged.
onUnitKilled
Called when a unit or player is killed.
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.