Note: This PRAction documentation is out-dated and is for an older (pre-GMS v2.3) version of PRAction. For the most up-to-date docs on the latest version of PRAction, please refer to this page as well as the documentation included in the PRAction package.

Documentation Topics
Function

PRActionCustomColorVarTo()

Creates an action object of type PRActionTypeCustomColorVarTo. When this action is played by an object, the instance variable in that object identified with the name varName, which must be a color-type variable, will animate from its current color value to the given color value using the easing equation identified by easeId over a duration of durationSecs seconds. This will result in a smooth color fade.

As this is an absolute animation, it is not recommended to alter the object's animating variable while the action is playing. Doing so will result in animation jerkiness as the action corrects the value at each frame (step) update.


Declaration

PRActionCustomColorVarTo(varName, toColor, easeId, durationSecs)

Parameters

varName

The name of the instance variable to animate. This must be a color type variable.

toColor

The absolute color value that the instance variable will be changed to by the end of the animation.

easeId

The ease ID identifying the easing equation to use when animating the object's variable.

durationSecs

The total length of time (in seconds) that the animation will take before completing. Specifying 0 here will result in an instant change to the final value in 1 frame (step).

Return Value

The created action object.