SCE Plasma

   Print  Previous  Next

Functions Provided By SCE Plasma

The following table provides an overview of all functions the effect can use:

 

Function

Description

void SetBpm(int bpm)

Sets the speed of the effect in BPM. Valid values range from 0 to 9999 BPM.

int GetBpm()

Returns the current effect speed in BPM.

void SetColor(int idx, color c)

Sets the color at the specified index in the Color Ramp. If idx is out of range, nothing happens.

color GetColor(int idx)

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

int GetColorCount()

Returns the amount of colors currently used by the Color Ramp.

void AddColor(color c, float position, int fade)

Adds another color c to the Color Ramp at the specified position. Valid values for position range from 0.01 to 0.99. If the index is lower or equal to 0, the new color is added to the first position. If index is greater than the current number of colors, the new color is added at the end. Valid values for fade are 1 (On).

void RemoveColor(int index)

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

int SetColorPosition(int index, float position)

Sets the color of the given index to a new position and returns the new index. Valid values for position range from 0.01 to 0.99. The first and last color are not allowed to be moved!

float GetColorPosition(int index)

Returns the color position of the given index.

void SetUniformDistances()

Sets uniform distances between each color in the Color Ramp.

void InvertColorPositions()

Inverts the positions of the colors in the Color Ramp.

void InvertColors()

Inverts every single color in the Color Ramp.

 

This Effect uses the Color Ramp. Learn more about Using Colors.

 

 

Deprecated Functions
Deprecated functions are outdated functions and should not be used anymore.

Function

Description

void SetSpeed(int speed)

Sets the speed of the effect in FPS. Valid values range from 0 to 166. Please note: This function is deprecated and may be removed in one of the next releases. Use SetBpm instead.

float GetSpeed()

Returns the current effect speed in FPS. Please note: This function is deprecated and may be removed in one of the next releases. Use GetBpm instead.