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

PRActionCustomColorVar()

Creates an action object of type PRActionTypeCustomColorVar. When this action is played by an object, the color-type instance variable in that object identified with the name varName will animate from the color value given in fromValue to the value given in toValue using the easing equation identified by easeId over a duration of durationSecs seconds.

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

PRActionCustomColorVar(varName, fromColor, toColor, easeId, durationSecs)

Parameters

varName

The name of the color-type instance variable to animate.

fromValue

The value that the custom variable will start at when the animation begins.

toValue

The value that the custom variables will end up being when the animation is complete.

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.