Effects - Meteor 2 Scripting Functions

void createExplosion(vector2 pos, float height, float radius, float damage, float armourPenetration, int ownerID)

Create an in-game explosion.

// create exlosion at ground level height
createExplosion(getPos(PLAYER_OBJECT), 0, 20, 100, 50, PLAYER_OBJECT);

// create exlosion at in the air.
createExplosion(getPos(PLAYER_OBJECT), getAirHeight(), 20, 100, 50, PLAYER_OBJECT);

armourPenetration is 0 to 100.
Can be called from server or client.

void fade(string text, float fadeOutSeconds, float fadedSeconds, float fadeInSeconds)

Fades out the screen, displays a message and fades back in.

// fade out over 1 seconds, show text for 3 seconds, fade in over 1 second
fade("Later that day...", 1, 3, 1);

// instantly turn screen black, wait 2 seconds, fade in over 2 seconds
fade("", 0, 2, 2);

Only affects the local computer.
Player controls are disabled while fading and while faded.

getCinematicBarsEnabled setCinematicBarsEnabled

void flash(float lifetime, string colour)

Light up the world for a short time.

// light up night sky for 1 second
flash(1, "#FFFFFF");

Only affects the local computer.
colour is specfified in HTML style ("#RRGGBB" hex values), colours may also contain 2 additional optional characters for alpha (e.g. "#FFFFFF80" is transparent white).
Lifetime is in seconds.

bool getCinematicBarsEnabled()

Gets whether the cinematic bars are enabled.

if(getCinematicBarsEnabled())
{
print("Cinematic bars are enabled.");
}
else
{
print("Cinematic bars are disabled.");
}

setCinematicBarsEnabled fade

void setCinematicBarsEnabled(bool enabled)

Sets whether the cinematic bars are enabled.

// enable cinematic bars
setCinematicBarsEnabled(true);

Only affects the local player.
Player controls are disabled while cinematic bars are enabled.

getCinematicBarsEnabled fade

bool getMaxWildlifeDistance()

Get the maximum wildlife particle distance.

print(getMaxWildlifeDistance());

Wildlife particles further than this distance from the game window centre will be culled automatically.

addWildlifeParticle

void addWildlifeParticle(vector2 spawnPos, uint filenameHash)

Spawn a wildlife particle (e.g. insect or bird).

unsigned birdHash = createStringHashLowerCase("Wildlife_Bird01.ini");
vector2 playerPos = getPos(PLAYER_OBJECT);
for(int i=0; i<10; i++)
{
addWildlifeParticle(playerPos, birdHash);
}

The particle filename is required as a hash for better performance. Use createStringHashLowerCase() to generate a filename hash once before any loops.

getMaxWildlifeDistance createStringHashLowerCase getWildlifeParticleInstanceCount

int getWildlifeParticleInstanceCount(uint filenameHash)

Get the current particles instance count of a willife particle type.

unsigned birdHash = createStringHashLowerCase("Wildlife_Bird01.ini");
int birdsCount = getWildlifeParticleInstanceCount(birdHash);
print("Birds count: " + birdsCount);

addWildlifeParticle createStringHashLowerCase

void addPlantParticle(vector2 spawnPos, uint filenameHash)

Spawn a plant particle (e.g. grass or flower).

unsigned grassHash = createStringHashLowerCase("Plant_Grass01.ini");
vector2 playerPos = getPos(PLAYER_OBJECT);
for(int i=0; i<10; i++)
{
addPlantParticle(playerPos, grassHash);
}

The particle filename is required as a hash for better performance. Use createStringHashLowerCase() to generate a filename hash once before any loops.

createStringHashLowerCase getPlantParticleInstanceCount

int getPlantParticleInstanceCount(uint filenameHash)

Get the current particles instance count of a plant particle type.

unsigned grassHash = createStringHashLowerCase("Plant_Grass01.ini");
int grassHash = getPlantParticleInstanceCount(grassHash);
print("Grass count: " + birdsCount);

addWildlifeParticle createStringHashLowerCase

bool isAddFireFrame()

Determine if fire particles should be added this frame.

Fire particles can be added during any frame but this function provides a convenient way of timing them consistently.

addFireParticle

void addFireParticle(vector2 pos, float maxSize, float height=0)

Add a fire particle.

void onUpdate(float deltaTime)
{
    if(isAddFireFrame())
    {
        addFireParticle(getPos(PLAYER_OBJECT), 10);
    }
}

isAddFireFrame addSmokeParticle

bool isAddSmokeFrame()

Determine if smoke particles should be added this frame.

Smoke particles can be added during any frame but this function provides a convenient way of timing them consistently.

addSmokeParticle

void addSmokeParticle(vector2 pos, float size, string smokeColour, float growRate=0.95, float decayRate=0.5)

Add a fire particle.

void onUpdate(float deltaTime)
{
    if(isAddSmokeFrame())
    {
        addSmokeParticle(getPos(PLAYER_OBJECT), 10, "#A0A0A0");
    }
}

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

isAddSmokeFrame addFireParticle