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
Constants

PRAction Types

PRActionTypeAlphaBy

Specifies an alpha by action. This type of action causes an object's image_alpha property to animate by a given amount relative to its current value.

PRActionTypeAlphaTo

Specifies an alpha to action. This type of action causes an object's image_alpha property to animate to a given absolute amount.

PRActionTypeBlendBy

Specifies an image blend by action. This type of action causes an object's image_blend property to animate by a given amount relative to its current value.

PRActionTypeBlendTo

Specifies an image blend to action. This type of action causes an object's image_blend property to animate to a given absolute amount.

PRActionTypeChangeLayer

Specifies a change layer action. This type of action instantly causes an object’s layer property to change to the given value.

PRActionTypeCustomColorScript

Specifies a custom color script action. This type of action runs the given script at each frame (step), passing it a color-type argument that is updated each frame until the destination (to) value is reached.

PRActionTypeCustomColorVar

Specifies a custom color variable action. This type of action animates/updates the given color-type instance variable at each frame (step), until the destination (to) value is reached.

PRActionTypeCustomScript1

Specifies a 1-argument custom script action. This type of action runs the given script at each frame (step), passing it one numeric-type argument that is updated each frame until the destination (to) value is reached.

PRActionTypeCustomScript2

Specifies a 2-argument custom script action. This type of action runs the given script at each frame (step), passing it two numeric-type arguments that are updated each frame until the destination (to) values are reached.

PRActionTypeCustomColorVarBy

Specifies a custom color variable by action. This type of action causes the given color-type instance variable to change over time by the given delta color component amounts relative to their current values.

PRActionTypeCustomColorVarTo

Specifies a custom color variable to action. This type of action causes the given color-type instance variable to change over time until the destination (to) color is reached.

PRActionTypeCustomVarBy

Specifies a custom variable by action. This type of action causes the given numeric-type instance variable to change over time by a given amount relative to its current value.

PRActionTypeCustomVarTo

Specifies a custom variable to action. This type of action causes the given numeric-type instance variable to change over time until the destination (to) value is reached.

PRActionTypeDepthBy

Specifies a depth by action. This type of action causes an object's depth property to animate by a given amount relative to its current value.

PRActionTypeDepthTo

Specifies a depth to action. This type of action causes an object's depth property to animate to a given absolute amount.

PRActionTypeDestroyObject

Specifies a destroy object action. This type of action causes a given object to be destroyed instantly.

PRActionTypeGotoRoom

Specifies a go to room action. This type of action causes a given room to run.

PRActionTypeGroup

Specifies a group action. This type of action is a container that causes the actions within it to play simultaneously. The actions within can be other container actions.

PRActionTypeHide

Specifies a hide action. This type of action instantly causes an object’s visible property to change to false.

PRActionTypeImageSpeedBy

Specifies an image speed by action. This type of action causes an object's image_speed property to animate by a given amount relative to it's current value.

PRActionTypeImageSpeedTo

Specifies an image speed to action. This type of action causes an object's image_speed property to animate to a given absolute amount.

PRActionTypeMoveBy

Specifies a move by action. This type of action causes an object's x and y properties to animate by given amounts relative to its current values.

PRActionTypeMoveTo

Specifies a move to action. This type of action causes an object's x and y properties to animate to given absolute amounts.

PRActionTypeMoveXBy

Specifies a move X by action. This type of action causes an object's x property to animate by a given amount relative to its current value.

PRActionTypeMoveXTo

Specifies a move X to action. This type of action causes an object's x property to animate to a given absolute amount.

PRActionTypeMoveYBy

Specifies a move Y by action. This type of action causes an object's y property to animate by a given amount relative to its current value.

PRActionTypeMoveYTo

Specifies a move Y to action. This type of action causes an object’s y property to animate to a given absolute amount.

PRActionTypePlayAction

Specifies a play action action. This type of action instantly causes the given action to play.

PRActionTypePlaySound

Specifies a play sound action. This type of action instantly causes the given sound to play.

PRActionTypeRepeater

Specifies a repeat action. This type of action is a container that causes the action within it to play repeatedly. The action within can be another container action.

PRActionTypeRotateBy

Specifies a rotate by action. This type of action causes an object's image_angle property to animate by a given amount relative to its current value.

PRActionTypeRotateTo

Specifies a rotate to action. This type of action causes an object's image_angle property to animate to a given absolute amount.

PRActionTypeRunScript

Specifies a run script action. This type of action instantly runs the given script with up to 8 optional arguments.

PRActionTypeRunUserEvent

Specifies a run user event action. This type of action instantly runs the given user event.

PRActionTypeScaleBy

Specifies a scale by action. This type of action causes an object's image_xscale and image_yscale properties to animate by given amounts relative to its current values.

PRActionTypeScaleTo

Specifies a scale to action. This type of action causes an object's image_xscale and image_yscale properties to animate to given absolute amounts.

PRActionTypeScaleXBy

Specifies a scale X by action. This type of action causes an object's image_xscale property to animate by a given amount relative to its current value.

PRActionTypeScaleXTo

Specifies a scale X to action. This type of action causes an object's image_xscale property to animate to a given absolute amount.

PRActionTypeScaleYBy

Specifies a scale Y by action. This type of action causes an object's image_yscale property to animate by a given amount relative to its current value.

PRActionTypeScaleYTo

Specifies a scale Y to action. This type of action causes an object's image_yscale property to animate to a given absolute amount.

PRActionTypeSetVar

Specifies a set variable action. This type of action causes an object's instance variable to change to a given value instantly.

PRActionTypeSpriteIndex

Specifies a sprite index action. This type of action instantly causes an object’s sprite_index and/or image_index properties to change to the given value(s).

PRActionTypeStopAction

Specifies a stop action action. This type of action instantly causes the given action to stop playing.

PRActionTypeStopAllAction

Specifies a stop all actions action. This type of action instantly causes all of an object's actions to stop playing.

PRActionTypeStopSound

Specifies a stop sound action. This type of action instantly causes the given sound to stop playing.

PRActionTypeStopAllSounds

Specifies a stop sound all sounds action. This type of action instantly causes all currently playing sounds to stop playing.

PRActionTypeUnhide

Specifies an unhide action. This type of action instantly causes an object’s visible property to change to true.

PRActionTypeWait

Specifies a wait action. This type of action does nothing (waits) for the given length of time.