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

PRActionCustomColorScript()

Creates an action object of type PRActionTypeCustomColorScript. When this action is played by an object, the script identified by scriptId will be called once per frame (step) and will be given 1 color-type argument that will animate from the value given in fromValue to the value given in toValue using the easing equation identified by easeId over a duration of durationSecs seconds. The script will run within the context of the object running the action.


Declaration

PRActionCustomColorScript(scriptId, fromColor, toColor, easeId, durationSecs)

Parameters

scriptId

The script resource id to call at each frame (step) throughout the animation.

fromColor

The color value to start the animation at.

toColor

The color value to end up at 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.