Skip to content

Stop Animation

Stop Animation

Stops and removes a running animation from the screen or an actor by its unique ID.

Properties

System

Name Explanation Type
Animation Unique ID The unique ID of the animation to stop. Variable or Value
Is Screen Animation Whether the animation to stop is a screen animation instead of an actor animation. Toggle
Target The actor to stop the animation on. Actor Reference

Examples

Stop a Screen Animation by Unique Identifier

Stops the screen animation whose unique ID is stored in global variable 0.

stop_animation($gv[0], screen);

{"Data":{"ID":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":0,"Metadata":null},"IsScreenAnimation":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.StopAnimationCommand"}

Stop an Animation on an Entity

Stops the animation on entity 0 whose unique ID is stored in global variable 0.

stop_animation($gv[0], entity(0));

{"Data":{"ID":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":0,"Metadata":null},"IsScreenAnimation":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.StopAnimationCommand"}