|
Functions Provided by M2L Interval Drops
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 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 SetDirection(int dir)
|
Sets the direction of the effect. Valid values are DIR_UP, DIR_DOWN, DIR_LEFT and DIR_RIGHT.
|
int GetDirection()
|
Returns the current direction.
|
void SetLength(int len)
|
Sets the length of the drops. Valid values range from 1 to 100.
|
int GetLength()
|
Returns the current length of drops.
|
void SetPixelWidth(int w)
|
Sets the width of the drops in pixels. Valid values range from 1 to 9999.
|
int GetPixelWidth()
|
Returns the width of the drops in pixels.
|
void SetVectorWidth(float w)
|
Sets the width of the drops using relative coordinates between 0 and 1 according to the current matrix size and direction. See below for further details.
|
float GetVectorWidth()
|
Returns the width of the drops relative to the current matrix size and direction. See below for further details.
|
void SetUseBass(int enable)
|
Disables "use bass" if enable is set to false. Otherwise, it will be enabled.
|
int GetUseBass()
|
Returns true if "use bass" is enabled, otherwise false.
|
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.
|
Using a Relative Width of Drops
The width of the drops may be given in pixels or using relative values between 0 and 1. Please see the functions SetPixelWidth or SetVectorWidth A ralative value of 0 represents the minimum size and will be increased to 1 pixel. And 1 represents the full size of the matrix.
Furthermore, these values depends on the current direction of the effect. If a horizontal movement is active (a movement to the left or right), the value is used in relation to the matrix height. If a vertical movement is active (up or down), the value is used in relation to the width of the matrix.
|