S2L Level Color

   Print  Previous  Next

Functions Provided By S2L Level Color

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(color col)

Sets the color of the effect. Please note that the alpha channel is not used by this effect.

color GetColor()

Returns the currently set color. Please note that the alpha channel is not used and should be ignored.

void SetFade(int fade)

Sets the "fade" value. Valid values range from 1 to 3000.

int GetFade()

Returns the current "fade".

void SetDirection(int dir)

Sets the direction of the effect. Valid values for dir are DIR_LEFT, DIR_RIGHT, DIR_UP and DIR_DOWN.

int GetDirection()

Returns the current direction.

void SetMono(int enable)

Disables "mono" if enable is set to false. Otherwise, it will be enabled.

int GetMono()

Returns true if "mono" is enabled, otherwise false is returned.

 

This Effect uses the Color Picker. 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.