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

PRActionCustomVarBy()

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

As this is a relative animation, it is possible to alter the object's animating variable in mid-process. The object will adapt to whatever new value is set at each frame (step) update.


Declaration

PRActionCustomVarBy(varName, byValue, easeId, durationSecs)

Parameters

varName

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

byValue

The relative amount that the object's instance variable will be changed 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.