Skip to content

Play Animation

Play Animation

Plays a database animation on the screen or on a specific actor.

Properties

System

Name Explanation Type
Animation The index of the animation to play from the database. Variable or Value
Result The variable to store the animation unique ID in. Variable or Value
Store ID Whether to store the resulting animation unique ID in a variable. Toggle
Target The actor to play the animation on. Actor Reference
Use as Screen Animation Whether to play the animation on the screen instead of targeting an actor. Toggle

Examples

Play Animation on the Screen

Plays database animation 3 as a screen animation.

$gv[0] = play_animation(3, screen);

{"Data":{"AnimationIndex":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"3","VariableIndex":0,"Metadata":null},"IsScreenAnimation":true,"Result":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":0,"Metadata":null},"StoreID":true,"Target":{"IsSelf":false,"IsPartyMember":false,"IsEntity":true,"IsUniqueID":false,"Identifier":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null}},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Animation.PlayAnimationCommand"}

Play Animation on a Specific Entity

Plays database animation 3 on entity 0.

play_animation(3, entity(0));

{"Data":{"AnimationIndex":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"3","VariableIndex":0,"Metadata":null},"IsScreenAnimation":false,"Result":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":0,"Metadata":null},"StoreID":false,"Target":{"IsSelf":false,"IsPartyMember":false,"IsEntity":true,"IsUniqueID":false,"Identifier":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null}},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Animation.PlayAnimationCommand"}

Play Animation on Self and Store the Unique Identifier

Plays database animation from global variable 1 on self and stores the unique ID in global variable 0.

$gv[0] = play_animation($gv[1], self);

{"Data":{"AnimationIndex":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":1,"Metadata":null},"IsScreenAnimation":false,"Result":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":0,"Metadata":null},"StoreID":true,"Target":{"IsSelf":true,"IsPartyMember":false,"IsEntity":false,"IsUniqueID":false,"Identifier":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null}},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Animation.PlayAnimationCommand"}