Sprite - Meteor 2 Scripting Functions

int createSprite(string spriteTypeName, vector2 pos, uint8 side)

Create a map sprite (server only).

int spriteID = createSprite("objects\\arrow.spr", getPos(PLAYER_OBJECT), 0, 0);
print("Created sprite ID " + spriteID);

void deleteSprite(int spriteID)

Delete a map sprite (server only).

// create an arrow sprite
int sprite = createSprite("objects\\arrow.spr", getPos(PLAYER_OBJECT), 0, 0);

// immediately delete the sprite
deleteSprite(sprite);

createSprite

vector2 getSpritePos(int spriteID)

Get a map sprite position (in pixels).

print(getSpritePos(1));

setSpritePos

void setSpritePos(int spriteID, vector2 pos)

Set a map sprite position (server only).

setSpritePos(1, getPos(PLAYER_OBJECT));

getSpritePos

float getSpriteAngle(int spriteID)

Get a map sprite angle (in degrees).

print(getSpriteAngle(1));

setSpriteAngle

void setSpriteAngle(int spriteID, float angle)

Set a map sprite angle (server only).

setSpriteAngle(1, 45);

getSpriteAngle

bool getSpriteHidden(int spriteID)

Get sprite hidden status.

print(getSpriteHidden(1));

setSpriteHidden

void setSpriteHidden(int spriteID, bool hidden)

Show or hide a sprite.

// hide sprite ID 1
setSpriteHidden(1, true);

getSpriteHidden

float getSpriteLifetime(int spriteID)

Get a sprite's remaining lifetime (server only).

print(getSpriteLifetime(1));

lifetime is in seconds (0 for no lifetime specified).

setSpriteLifetime

void setSpriteLifetime(int spriteID, bool hidden)

Set a sprite's remaining lifetime in seconds (server only).

// create an arrow sprite
int sprite = createSprite("objects\\arrow.spr", getPos(PLAYER_OBJECT), 0, 0);

// Delete the sprite in 5.25 seconds
setSpriteLifetime(sprite, 5.25);

Set lifetime to 0 to not automatically delete.
Note that wrecks and corpses are deleted automatically once map limits are reached.

getSpriteLifetime

string getPaintColour(int spriteID)

Get the paint colour of a sprite.

print("Sprite ID 0 is " + getSpritePaintColour(0));

paintColour is specfified in HTML style ("#RRGGBB" hex values), colours may also contain 2 additional optional characters for alpha (e.g. "#FFFFFF80" is transparent white).

setSpritePaintColour

void setSpritePaintColour(int spriteID, string paintColour)

Set the paint colour of a sprite.

// Set paint colour of sprite ID 0 to red
setSpritePaintColour(0, "#FF0000");

paintColour is specfified in HTML style ("#RRGGBB" hex values), colours may also contain 2 additional optional characters for alpha (e.g. "#FFFFFF80" is transparent white).

getSpritePaintColour

bool spriteExists(int spriteID)

Check if a map sprite exists.

if (spriteExists(1))
{
print("Sprite 1 exists");
}
else
{
print("Sprite 1 does not exist");
}

int getSpriteTypeNumber(int spriteID)

Get a sprite type number from a map sprite ID.

int spriteTypeNumber = getSpriteTypeNumber(1);
print("Map sprite ID 1 is sprite type number " + spriteTypeNumber);

Sprite type numbers are the index of a loaded sprite asset. They are local and can differ for each game session.

getSpriteTypeName getSpriteTypeNameLowerHash

string getSpriteTypeName(int spriteID)

Get a sprite type name from a map sprite ID.

string spriteTypeName = getSpriteTypeName(1);
print("Sprite ID 1 type name is " + spriteTypeName);

getSpriteTypeNumber getSpriteTypeNameLowerHash

uint getSpriteTypeNameLowerHash(int spriteID)

Get a sprite type name lower case hash from a map sprite ID.

uint spriteTypeNameHash = getSpriteTypeNameLowerHash(1);
print("Sprite ID 1 type name hash is " + spriteTypeNameHash);

getSpriteTypeNumber getSpriteTypeName

string spriteTypeNumberToName(int spriteTypeNumber)

Resolve a sprite type number to a sprite type name.

string typeName = spriteTypeNumberToName(10);
print("Sprite type number 10 type name is " + typeName);

getSpriteTypeNameNumber

int spriteTypeNameToNumber(string spriteTypeName)

Get a sprite type number from a sprite type name.

int spriteTypeNumber = spriteTypeNameToNumber("objects\\arrow.spr");
print("Sprite type number " + spriteTypeNumber);

spriteTypeNumberToName