Events - Meteor 2 Scripting Functions

void onWorldStart()

Server only

Called after the map is loaded on the server.

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

Called on server only.

onStart onPlayerSpawn

void onStart()

Server and clients

Called after the map is loaded on each computer.

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

Called after onWorldStart() on server and single player. Not called on clients.
In multiplayer this is called before the local player is spawned.

onWorldStart onPlayerSpawn

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 == getLocalPlayer())
    {
        if(!respawn)
        {
            // first spawn
            print("Welcome to " + getWorldName() + ", " + getDisplayName(PLAYER_OBJECT));
        }
        else
        {
            // respawn
            print("You respawned");
        }
    }
}

Use setSinglePlayerRespawnEnabled to enable single player respawn.

onStart setSinglePlayerRespawnEnabled getSinglePlayerRespawnEnabled getPlayerObject

void onStarterPack()

Server only

Called when the "starterpack" or "sp" console command is run.

void onStarterPack()
{
print("onStarterPack");
}

Called on server only.

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

Server and clients

Called when any object 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(getDisplayName(objectID) + " entered trigger box " + triggerBoxID + " '" + triggerBoxTag + "'");
}

onTriggerBoxExit createTriggerBox

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

Server and clients

Called when any object 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(getDisplayName(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 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(getDisplayName(playerId) + " just connected");
}

onClientDisconnected

void onClientDisconnected(int playerId)

Server only

Called when a client connects.

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

onClientConnected

void onObjectSpawn(int objectId)

Server and clients

Called after an object or player spawns.

void onObjectSpawn(int objectId)
{
print(getDisplayName(objectId) + " spawned");
}

onObjectRespawn onObjectKilled onObjectDamaged

void onObjectRespawn(int oldObjectId, int newObjectId)

Server

Called after an object is respawned.

void onObjectRespawn(int oldObjectId, int newObjectId)
{
print(getDisplayName(oldObjectId) + " respawned, new id is " + newObjectId);
}

onObjectSpawn onObjectKilled onObjectDamaged

void onObjectTargetChanged(int objectId, int targetId)

Server only

Called when a object's target has changed.

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

targetId -1 is no target.

getTarget

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

Server only

Called after an object or player is damaged.

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

onObjectKilled

void onObjectKilled(int objectId, int killerId, bool silent)

Server only

Called when a object or player is killed or deleted.

void onObjectKilled(int objectId, int killerId, bool silent)
{
    if (silent)
    {
        print(getDisplayName(objectId) + " was deleted");
    }
    else
    {
        print(getDisplayName(objectId) + " was killed by " + getDisplayName(killerId));
    }
}

onObjectDamaged

void onWaypointReached(int waypointID, int objectID)

Server only

Called when a object reaches a waypoint.

void onWaypointReached(int waypointID, int objectID)
{
print(getDisplayName(objectID) + " reached waypoint " + waypointID);
}

onMoveToComplete

void onMoveToComplete(int objectID)

Server only

Called when a object reaches its destination or fails to reach its destination using moveTo.

void onMoveToComplete(int objectID, bool success)
{
    if (success)
    {
        print(getDisplayName(objectID) + " moveTo successful");
    }
    else
    {
        print(getDisplayName(objectID) + " moveTo failed");
    }
}

Called for objects moved using moveTo only (not related to waypoints).

onWaypointReached

void onVehicleEnter(int vehicleId, int objectId)

Server only

Called when a unit enters a vehicle.

void onVehicleEnter(int vehicleId, int objectId)
{
print(getDisplayName(objectId) + " got in vehicle " + getDisplayName(vehicleId));
}

The legacy events OnObjectTypeEnter() and onEnterVehicle_???() fire for players only.

onVehicleExit

void onVehicleExit(int vehicleId, int objectId)

Server only

Called when a unit exits a vehicle.

void onVehicleExit(int vehicleId, int objectId)
{
print(getDisplayName(objectId) + " got out of vehicle " + getDisplayName(vehicleId));
}

The legacy events OnObjectTypeExit() and OnExitVehicle_???() fire for players only.

onVehicleEnter

void onVehicleSubmerged(int vehicleId)

Server and clients

Called when a vehicle becomes submerged.

void onVehicleSubmerged(int vehicleId)
{
print(getDisplayName(vehicleId) + " has submerged");
}

isSubmerged

void callOnSetCommander(int objectID, int commanderID)

Server only

Called when an object's commander is changed.

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(getDisplayName(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

void onInitHud()

Local only

Called when the HUD is initialised (also when player changes vehicle).

int hudArrowSprite = 0;

void onInitHud()
{
// resolve hudArrowSprite once (not every frame)
hudArrowSprite = getSpriteNumber("objects\\arrow.spr");
}

onBeforeDrawHud onAfterDrawHud

void onBeforeDrawHud(float deltaTime)

Local only

Called just before the HUD is drawn.

void onBeforeDrawHud(float deltaTime)
{
drawText(vector2(100,100), "onBeforeDrawHud", "#FFFFFF", true, FONT_STANDARD, 20);
}

onAfterDrawHud

void onAfterDrawHud(float deltaTime)

Local only

Called just after the HUD is drawn.

void onAfterDrawHud(float deltaTime)
{
drawText(vector2(100,150), "onAfterDrawHud", "#00FF00", true, FONT_STANDARD, 20);
}

onBeforeDrawHud

void onInitAmbientSounds()

Local only

Called just after local ambient system is initialised.

Normally found in base\scripts\ambient\sounds.as
Can also be placed in map script as either additional call or to replace entirely if sounds script is disabled in map properties.

onUpdateAmbientSounds

void onUpdateAmbientSounds(float deltaTime, vector2 ambientPos)

Local only

Called every frame to update ambient sounds.

Normally found in base\scripts\ambient\sounds.as
Can also be placed in map script as either additional call or to replace entirely if sounds script is disabled in map properties.

onInitAmbientSounds

void onInitAmbientWildlife()

Local only

Called just after local ambient widlife system is initialised.

Normally found in base\scripts\ambient\wildlife.as
Can also be placed in map script as either additional call or to replace entirely if wildlife script is disabled in map properties.

onTickSpawnAmbientWildlife

void onTickSpawnAmbientWildlife(float tickDelta, vector2 ambientPos)

Local only

Called to spawn ambient wildlife via script.

Normally found in base\scripts\ambient\wildlife.as
Can also be placed in map script as either additional call or to replace entirely if wildlife script is disabled in map properties.

onInitAmbientWildlife

void onInitAmbientPlants()

Local only

Called just after local ambient plants system is initialised.

Normally found in base\scripts\ambient\plants.as (specified in map properties plants script).
Can also be placed in map script as either additional call or to replace entirely if plants script is disabled in map properties.

onTickSpawnAmbientPlants

void onTickSpawnAmbientPlants(float tickDelta, vector2 ambientPos, float plantsDistance, vector2 lastPlantsUpdatedPos, bool plantsFirstGenerated)

Local only

Called to spawn ambient plants via script.

Normally found in base\scripts\ambient\plants.as (specified in map properties plants script).
Can also be placed in map script as either additional call or to replace entirely if plant script is disabled in map properties.

onInitAmbientPlants

void onProjectileSpawn(int gameProjectileID, vector2 pos, float angle)

Server and clients

Called after an projectile is spawned.

void onProjectileSpawn(int gameProjectileID, vector2 pos, float angle)
{
print("spawned game projectile ID " + gameProjectileID);
}

onProjectileHit onProjectileDelete

void onProjectileHit(int gameProjectileID, vector2 pos, float angle, int hitObjectID)

Server and clients

Called after an projectile hits something.

void onProjectileHit(int gameProjectileID, vector2 pos, float angle, int hitObjectID)
{
    if(hitObjectID == -1)
        print("Projectile " + gameProjectileID + " hit terrain");
    else
        print("Projectile " + gameProjectileID + " hit object " + hitObjectID);
}

onProjectileSpawn onProjectileDelete

void onProjectileDelete(int gameProjectileID, vector2 pos, float angle)

Server and clients

Called just before a projectile is deleted.

void onProjectileDelete(int gameProjectileID, vector2 pos, float angle)
{
print("Projectile ID " + gameProjectileID + " deleted");
}

onProjectileSpawn onProjectileDelete

string onGetItemName(int objectID, GameItem gameItem)

Server and clients (local only)

Called to override name for item shown in inventory.

string onGetItemName(int objectID, GameItem gameItem)
{
return "Custom name";
}

Return an empty string to use the item's name.
GameItem has 3 properties:
- itemTypeNumber: The item's type number
- name: The item's name
- magAmmo: The amount of ammo in the mag (or 0 if not a mag)

onGetItemDescription onUseItem onNeedItemCheck

string onGetItemDescription(int objectID, GameItem gameItem)

Server and clients (local only)

Called to override description for item shown in inventory.

string onGetItemDescription(int objectID, GameItem gameItem)
{
return "Custom description";
}

Return an empty string to use the item's description.
GameItem has 3 properties:
- itemTypeNumber: The item's type number
- name: The item's name
- magAmmo: The amount of ammo in the mag (or 0 if not a mag)

onGetItemName onUseItem onNeedItemCheck

bool onUseItem(int objectID, GameItem gameItem)

Server and clients (local only)

Called when an item is used, either by being picked up, or double clicked in inventory (if enabled).

bool onUseItem(int objectID, GameItem gameItem)
{
// Don't allow any items to be used.
return false;
}

Return true if the item has been used, and it will be removed automatically.
GameItem has 3 properties:
- itemTypeNumber: The item's type number
- name: The item's name
- magAmmo: The amount of ammo in the mag (or 0 if not a mag)

onGetItemName onGetItemDescription onNeedItemCheck

bool onNeedItemCheck(int objectID, GameItem gameItem)

Server and clients (local only)

Called to determine whether to show the "Take item" action.

bool onNeedItemCheck(int objectID, GameItem gameItem)
{
// All items are needed.
return true;
}

Return true to show the "Take item" action.
This event is not called if there is no space to pick up the item.
GameItem has 3 properties:
- itemTypeNumber: The item's type number
- name: The item's name
- magAmmo: The amount of ammo in the mag (or 0 if not a mag)

onGetItemName onGetItemDescription onUseItem