SCE Explosions

Function

Description

void SetExplosionSize(int size)

Sets the Explosion Size of a single explosion.

int GetExplosionSize()

Returns the current Explosion Size of a single explosion.

void SetShapeSize(int size)

Sets the Shape Size of single objects.

int GetShapeSize()

Returns the current Shape Size of single objects.

void SetShapeCount(int count)

Sets the number of objects within an explosion.

int GetShapeCount()

Returns the currently set number of objects of an explosion.

void SetFadeOut(int fadeout)

Sets the size of a Fade Out tail.

int GetFadeOut()

Returns the currently set Fade Out value.

void SetGravity(float gravity)

Sets the Gravity value for the effect.

float GetGravity()

Returns the currently set Gravity.

void Detonate(int explPosX, int explPosY, int explPosZ, int ParticleCtn, int explSize, int explShape, int drawShape, color Col, color sparkleCol)

Manually creates an explosion. explPosX is the end-coordinate of the explosion in X, explPosY is the end-coordinate of the explosion in Y, explPosZ is the end-coordinate of the explosion in Z, ParticleCtn is the number of objects, explSize is the size of the explosion, explShape is the type of the explosion, drawShape is the shape of the objects, Col is the color of the effect, sparkleCol is the color of the sparkle part.

void FireRocket(int posX, int posY, int posZ, int explPosX, int explPosY, int explPosZ, int ParticleCtn, int explSize, int explShape, int drawShape, color Col, color sparkleCol)

Manually creates a firework. posX is the X-coordinate, posY is the Y-coordinate, posZ is the Z-coordinate, explPosX is the end-coordinate of the fireworks explosion in X, explPosY is the end-coordinate of the fireworks explosion in Y, explPosZ is the end-coordinate of the fireworks explosion in Z, ParticleCtn is the number of objects, explSize is the size of the fireworks explosion, explShape is the type of the fireworks explosion, drawShape is the shape of the objects, Col is the color of the effect, sparkleCol is the color of the sparkle part.

void SetSparkleColor(int index, color c)

Sets the color with the specified index in the Sparkle Color Table to the given color value. If the index is out of range, nothing happens.

color GetSparkleColor(int index)

Returns the color with the specified index in the Sparkle Color Table. If the index is out of range, black is returned.

int GetSparkleColorCount()

Returns the current number of colors in the Sparkle Color Table.

void AddSparkleColor(int index, color c)

Adds another color to the Sparkle Color Table at the specified index position. If the index is 0, the new color is added to the first position. If the index is equal to or greater than the current number of colors, the new color is added at the end.

void RemoveSparkleColor(int index)

Removes the color at the specified index from the Sparkle Color Table. If the given index is out of range, nothing happens.

void SetSparkleColorMode(int mode)

Sets the Color Mode for the Sparkle Color Table. See here for details.

int GetSparkleColorMode()

Returns the current Color Mode for the Sparkle Color Table.

void SparkleColorTableSetByGlobalId(int ID)

Selects a Global Color List as specified by its ID to be used in the Color Table responsible for the secondary colors.

int SparkleColorTableGetGlobalId()

Returns the ID of the Global Color List that is currently selected in the Color Table responsible for the secondary colors.

void SetOuterGlow(float value)

Sets the Outer Glow of objects. Valid values range from 0.00 to 100.

float GetOuterGlow()

Returns the currently set Outer Glow.

void SetPixelOuterGlow(int value)

Sets the Outer Glow of objects in pixels based on the object size.

int GetPixelOuterGlow()

Returns the currently set Outer Glow in pixels.

void SetInnerGlow(float value)

Sets the Inner Glow of objects. Valid values range from 0.00 to 100.

float GetInnerGlow()

Returns the currently set Inner Glow.

void SetPixelInnerGlow(int value)

Sets the Inner Glow of objects in pixels based on the object size.

int GetPixelInnerGlow()

Returns the currently set Inner Glow in pixels.

void SetRocketCount(int count)

Sets the number of rockets or explosions displayed by the effect at the same time in Fireworks mode and Explosion mode.

int GetRocketCount()

Returns the currently set number of rockets or explosions.

void SetExplosionMode(int mode)

Sets the Explosion Mode. See below for details.

int GetExplosionMode()

Returns which Explosion Mode is set.

void SetExplosionShape(int shape)

Sets the Explosion Shape. See below for details.

int GetExplosionShape()

Returns which Explosion Shape is set.

Constant

Description

int MODE_EXPLOSIONS

Sets the Explosion mode.

int MODE_FIREWORKS

Sets the Fireworks mode.

Constant

Description

int EXPLOSION_SHAPE_SPHERE

Sets the sphere type of explosion.

int EXPLOSION_SHAPE_SPHERE_GLOW

Sets the glowing sphere type of explosion.

int EXPLOSION_SHAPE_SPIRAL

Sets the spiral type of explosion.

int EXPLOSION_SHAPE_RADIAL

Sets the radial type of explosion.

int EXPLOSION_SHAPE_DIAMOND

Sets the diamond type of explosion.

int EXPLOSION_SHAPE_STAR

Sets the star type of explosion.

int EXPLOSION_SHAPE_RANDOM

Sets a random type of explosion.