Weapon - Meteor 2 Scripting Functions

int getPlayerWeapon(int playerID)

Get the specified player's current weapon slot index.

// show local player current weapon slot index
print(getPlayerWeapon(getLocalPlayer()));

If the player was not found -1 is returned.

setPlayerWeapon clampPlayerWeapon hasWeapon getWeaponSlotItemNumber getWeaponSlotItemName getWeaponSlotsCount

void setPlayerWeapon(int playerID, int slotIndex)

Set the specified player's current weapon slot index (local player or server only).

// select weapon slot 2 (PDW)
setPlayerWeapon(getLocalPlayer(), 2);

getPlayerWeapon clampPlayerWeapon hasWeapon getWeaponSlotItemNumber getWeaponSlotItemName getWeaponSlotsCount

void clampPlayerWeapon(int playerID)

Clamp a player's current weapon index to a valid (and owned) weapon slot (local player or server only).

// take away player PDW
giveItem(getLocalPlayer(), "PDW", -1);

// ensure player's current weapon is valid
clampPlayerWeapon(getLocalPlayer());

Use this function to ensure a player's current weapon is valid, especially after removing weapons.

getPlayerWeapon setPlayerWeapon hasWeapon getWeaponSlotItemNumber getWeaponSlotItemName getWeaponSlotsCount

bool hasWeapon(int objectID, string weaponItemName)

Determine if an object has a specific weapon.

// does player have a PDW?
print("Player has PDW: " + hasWeapon(PLAYER_OBJECT, "PDW"));

This function is normally used for player objects.

getPlayerWeapon setPlayerWeapon clampPlayerWeapon getWeaponSlotItemNumber getWeaponSlotItemName getWeaponSlotsCount

int getWeaponSlotItemNumber(int objectID, int slotIndex)

Get the item type index for an object weapon slot.

// print player slot 0 item number
print(getWeaponSlotItemNumber(PLAYER_OBJECT, 0));

Returns -1 if the object or slot is invalid.

getPlayerWeapon setPlayerWeapon clampPlayerWeapon hasWeapon getWeaponSlotItemName getWeaponSlotsCount

string getWeaponSlotItemName(int objectID, int slotIndex)

Get the item type name for a player weapon slot.

// print weapon item name for slot 0
print(getWeaponSlotItemName(PLAYER_OBJECT, 0));

Returns empty string if the object or slot is invalid.

getPlayerWeapon setPlayerWeapon clampPlayerWeapon hasWeapon getWeaponSlotItemNumber getWeaponSlotsCount

int getWeaponSlotsCount(int objectID)

Get the number of weapon slots an object has.

// show number of player weapon slots
print("Player has " + getWeaponSlotsCount(PLAYER_OBJECT) + " weapon slots");

// loop through weapon slots and display information
for(int i=0; i<getWeaponSlotsCount(PLAYER_OBJECT); i++)
{
print(i + ": " + getWeaponSlotItemName(PLAYER_OBJECT, i));
}

getPlayerWeapon setPlayerWeapon clampPlayerWeapon hasWeapon getWeaponSlotItemNumber getWeaponSlotItemName hasLinkedWeapons

bool hasLinkedWeapons(int objectID)

Determine if an object has linked weapons (all turrets fire at the same time).

// show player linked weapon mounts status
if(hasLinkedWeapons(PLAYER_VEHICLE))
print("Linked weapon mounts");
else
print("Selectable weapon mounts");

getWeaponSlotsCount

bool isUsingMissileWeapon(int objectID)

Determine if an object is currently using a missile weapon.

A missile weapon is defined as a weapon with "Trigger missile alarm" set to true in the Weapon Editor.

float getWeaponAimingAngle(int objectID, int slotIndex=-1)

Get the aiming angle of a specified turret.

// show aiming angle of player or player vehicle current weapon
print("Current slot angle: " + getWeaponAimingAngle(PLAYER_VEHICLE, getPlayerWeapon(getLocalPlayer())));

// show aiming angles of player vehicle first and second turrets
print("Slot 0: " + getWeaponAimingAngle(PLAYER_VEHICLE, 0));
print("Slot 1: " + getWeaponAimingAngle(PLAYER_VEHICLE, 1));

slotIndex is 0 based. If slotIndex is invalid the object angle is returned.
Result is in degrees (e.g. north = 0, east = 90, south = 180, west = 270).

getWeaponWorldPos getPlayerWeapon

vector2 getWeaponMountWorldPos(int objectID, int slotIndex=-1)

Get the world position of a specified turret mounting point.

// show world pos of player or player vehicle current weapon
print("Current slot pos: " + getWeaponMountWorldPos(PLAYER_VEHICLE, getPlayerWeapon(getLocalPlayer())));

// show world mounting positions of player vehicle first and second turrets
print("Slot 0: " + getWeaponMountWorldPos(PLAYER_VEHICLE, 0));
print("Slot 1: " + getWeaponMountWorldPos(PLAYER_VEHICLE, 1));

slotIndex is 0 based. If slotIndex is invalid the object position is returned.

getWeaponFireWorldPos getWeaponAimingAngle getPlayerWeapon

vector2 getWeaponFireWorldPos(int objectID, int slotIndex)

Get the world position of a specified turret firing point (end of barrel).

// show world pos of player or player vehicle current weapon
print("Current slot pos: " + getWeaponFireWorldPos(PLAYER_VEHICLE, getPlayerWeapon(getLocalPlayer())));

// show world firing positions of player vehicle first and second turrets
print("Slot 0: " + getWeaponFireWorldPos(PLAYER_VEHICLE, 0));
print("Slot 1: " + getWeaponFireWorldPos(PLAYER_VEHICLE, 1));

slotIndex is 0 based. If slotIndex is invalid the object position is returned.

getWeaponMountWorldPos getWeaponAimingAngle getPlayerWeapon

void throwGrenade(int objectID, string slotName, float strength)

Make an object throw a grenade.

// make object 1 drop a frag grenade at its feet
throwGrenade(1, "Frag Grenade", 0);

// make object 1 throw a blue smoke as far as possible
throwGrenade(1, "Blue Smoke", 1);

slotName corresponds to the name of a grenade slot in game.ini.
strength is a normalised value from 0 to 1.

vector2 getAimingPos(int objectID)

Get the position an object is aiming at.

print(getAimingPos(PLAYER_OBJECT));

bool getWeaponLaserOn(int objectID)

Determine if object's weapon laser is switched on.

print(getWeaponLaserOn(PLAYER_OBJECT));

getWeaponLaserEndPos getWeaponLaserDistance

float getWeaponLaserDistance(int objectID)

Get the length of a object's weapon laser.

print(getWeaponLaserDistance(PLAYER_OBJECT));

If distance is less than or equal to 0 then the laser pointer is not on.
distance is the current laser length in pixels (use pixelsToMetres() to convert to metres).
The laser stops at the first obstruction (target) in line of sight.

getWeaponLaserOn getWeaponLaserEndPos pixelsToMetres

vector2 getWeaponLaserEndPos(int objectID)

Get the length of a object's weapon laser.

print(getWeaponLaserEndPos(PLAYER_OBJECT));

If weapon laser is not switched on then object position is returned.

getWeaponLaserOn getWeaponLaserDistance