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

PRActionMoveBy()

Creates an action object of type PRActionTypeMoveBy. When this action is played by an object, that object’s x and y variables will animate from its current values by the amounts given in moveByX and moveByY 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 variables in mid-process. The object will adapt to whatever new values are set at each frame (step) update.


Declaration

PRActionMoveBy(moveByX, moveByY, easeId, durationSecs)

Parameters

moveByX

The relative amount that the object's x variable will be changed by the end of the animation.

moveByY

The relative amount that the object's y 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 variables.

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 values in 1 frame (step).

Return Value

The created action object.