Events - Meteor Scripting Functions

void onWorldStart()

Server only

Called after the map is loaded.

void onWorldStart()
{
print("onWorldStart: " + getWorldName());
}

void onPlayerSpawn(int playerID, bool respawn)

Server and clients

Called when any player spawns or respawns.

void onPlayerSpawn(int playerID, bool respawn)
{
    // check if local player
    if(playerID == getPlayer())
    {
        if(!respawn)
        {
            // first spawn
            print("Welcome to " + getWorldName() + ", " + getUnitDisplayName(getPlayer()));
        }
        else
        {
            // respawn
            print("You respawned");
        }
    }
}

Use setSinglePlayerRespawnEnabled to enable single player respawn.

setSinglePlayerRespawnEnabled getSinglePlayerRespawnEnabled

void onTriggerBoxEnter(int triggerBoxID, string triggerBoxTag, int objectID)

Server and clients (local only)

Called when any unit or player enters a trigger box.

// Display information every time any player or unit enters any trigger box
void onTriggerBoxEnter(int triggerBoxID, string triggerBoxTag, int objectID)
{
print(getUnitDisplayName(objectID) + " entered trigger box " + triggerBoxID + " '" + triggerBoxTag + "'");
}

onTriggerBoxExit createTriggerBox

void onTriggerBoxExit(int triggerBoxID, string triggerBoxTag, int objectID)

Server and clients (local only)

Called when any unit or player exits a trigger box.

// Display information every time any player or unit exits any trigger box
void onTriggerBoxExit(int triggerBoxID, string triggerBoxTag, int objectID)
{
print(getUnitDisplayName(objectID) + " left trigger box " + triggerBoxID + " '" + triggerBoxTag + "'");
}

onTriggerBoxEnter createTriggerBox

void onTick(float tickDelta)

Server and clients (local only)

Called on each tick (normally 30 times per second).

void onTick(float tickDelta)
{
// your code here
}

onUpdate

void onUpdate(float deltaTime)

Server and clients

Called rendered every frame.

void onUpdate(float tickDelta)
{
// your code here
}

onTick

void onClientConnected(int playerId)

Server only

Called when a client connects.

void onClientConnected(int playerId)
{
print(getUnitDisplayName(playerId) + " just connected");
}

onClientDisconnected

void onClientDisconnected(int playerId)

Server only

Called when a client connects.

void onClientDisconnected(int playerId)
{
print(getUnitDisplayName(playerId) + " has disconnected");
}

onClientConnected

void onUnitSpawn(int objectId)

Server and clients

Called after a unit or player spawns.

void onUnitSpawn(int objectID)
{
print(getUnitDisplayName(objectId) + " spawned");
}

onUnitKilled onUnitDamaged

void onUnitTargetChanged(int objectId, int targetId)

Server only

Called when a unit's target has changed.

void onUnitTargetChanged(int objectId, int targetId)
{
    if(targetId != -1)
        print(getUnitDisplayName(objectId) + "(" + objectId + ")" + " target changed to " + getUnitDisplayName(targetId) + " (" + targetId + ")");
    else
        print(getUnitDisplayName(objectId) + "(" + objectId + ") target cancelled");
}

targetId -1 is no target.

getUnitTarget

void onUnitDamaged(int objectId, int ownerId, int oldHits, int newHits)

Server only

Called after a unit or player is damaged.

void onUnitDamaged(int objectId, int ownerId, int oldHits, int newHits)
{
print(getUnitDisplayName(objectID) + " was damaged by " + getUnitDisplayName(ownerId) + " and now has " + newHits + " health");
}

onUnitKilled

void onUnitKilled(int objectId, int killerId)

Server only

Called when a unit or player is killed.

void onUnitKilled(int objectId, int killerId)
{
print(getUnitDisplayName(objectId) + " was killed by " + getUnitDisplayName(killerId));
}

onUnitDamaged

void onPickupItem(int playerID, string itemName, int itemAmount, string powerupName)

Server only

Called when any player picks up an item.

void onPickupItem(int playerID, string itemName, int itemAmount, string powerupName)
{
print(getUnitDisplayName(playerID) + " picked up " + itemAmount + "x " + itemName + " from the " + powerupName);
}

void onGameSave()

Single player only

Called while the game is being saved.

// global vars that are set once (no need to save)
vector2 triggerPos = vector2(100, 100);

// global vars that change in code (must be saved)
int someInt;
vector2 someVec1;

void onGameSave()
{
    // save variables to saved game file
    saveGameVar("someInt", someInt);
    saveGameVar("someVec1", someVec1);
}

Use onGameSave to save global script variables.

onGameLoad saveGameVar

void onGameLoad()

Single player only

Called while the game is being loaded.

// global vars that are set once (no need to save)
vector2 triggerPos = vector2(100, 100);

// global vars that change in code (must be saved)
int someInt;
vector2 someVec1;

void onGameLoad()
{
    // load variables from saved game file
    someInt = loadGameVar("someInt", 0);
    someVec1 = loadGameVar("someVec1", vector2(0,0));
}

onGameSave loadGameVar