M2L Color Scroll

The following table provides an overview over all functions the effect provides:

Function	Description
void SetColor(color col)	Sets the color of the effect color. 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 SetDirection(int dir)	Sets the direction of the effect. Allowed are all directions described in the general summary and some additional values which are described below.
int GetDirection()	Returns the current direction. There are some effect specific directions which are described below.
void SetCrossed(enable)	Enables cross-direction mode if enable is set to true. Otherwise, it is disabled.
int GetCrossed()	Returns true if the cross-direction mode is enabled, otherwise false.
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 SetStep(int step)	Sets the step width of the new colors. Valid values for step range from 1 to 9999.
int GetStep()	Returns the current step width.
void SetXOffset(int offset)	Sets the x-offset value, which ranges from 1 to 9999.
int GetXOffset()	Returns the current x-offset.
void SetFade(int enable)	Enables fading between the colors if enable is true. Otherwise it will be disabled.
int GetFade()	Returns true if fading is enabled, otherwise false.

In addition to the standard directions DIR_UP, DIR_DOWN, DIR_LEFT, and DIR_RIGHT, four more directions are effect-specific. These are vertical and horizontal scrolling lines, both inwards and outwards. It is possible to set them using the function SetDirection. The following values must be used as parameters:

Value	Description
DIR_OUTWARDS_V	Sets a vertical outward movement (Vertical Explode).
DIR_INWARDS_V	Sets a vertical inward movement (Vertical Implode).
DIR_OUTWARDS_H	Sets a horizontal outward movement (Horizontal Explode).
DIR_INWARDS_H	Sets a horizontal inward movement (Horizontal Implode).
DIR_OUTWARDS_RECT	Sets a rectangular outward movement (Rectangle Explode).
DIR_INWARDS_RECT	Sets a rectangular inward movement (Rectangle Implode).
DIR_OUTWARDS_SQUARE	Sets a quadratic outward movement (Square Explode).
DIR_INWARDS_SQUARE	Sets a quadratic inward movement (Square Implode).
DIR_OUTWARDS_CIRCLE	Sets a circled outward movement (Circle Explode).
DIR_INWARDS_CIRCLE	Sets a circled inward movement (Circle Implode).
DIR_OUTWARDS_ELLIPSE	Sets an elliptic outward movement (Ellipse Explode). This is different to a circle on rectangular matrices. On quadratic matrices the ellipse will also be a circle.
DIR_INWARDS_ELLIPSE	Sets an elliptic inward movement (Ellipse Implode). This is different to a circle on rectangular matrices. On quadratic matrices the ellipse will also be a circle.