Skip to content

Remove Annotations

Remove Annotations

Removes visual annotations from a specific actor or all entities.

Properties

System

Name Explanation Type
All Entities Whether to remove annotations from all entities on the map. Toggle
By Tag Whether to only remove annotations that match a specific tag. Toggle
Include Script-Page Annotations Whether to also remove annotations that were added by a script page. Toggle
Tag The tag to match when removing annotations by tag. Variable or Value
Target The actor to remove annotations from. Actor Reference

Examples

Remove All Annotations from an Entity

Removes all visual annotations from entity 0.

remove_annotations(entity(0));
{"Data":{"IsAllEntities":false,"IsByTag":false,"IncludeScriptAnnotations":false,"Tag":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"","VariableIndex":0,"Metadata":null},"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.RemoveAnnotationsCommand"}

Remove All Annotations from All Entities

Removes all visual annotations from every entity on the map.

remove_annotations(all);
{"Data":{"IsAllEntities":true,"IsByTag":false,"IncludeScriptAnnotations":false,"Tag":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"","VariableIndex":0,"Metadata":null},"Target":{"IsSelf":false,"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.RemoveAnnotationsCommand"}

Remove Annotations by Tag Including Script Annotations

Removes annotations matching a specific tag from all entities, including those added by script pages.

remove_annotations(all, tag: "my_tag", include_script);
{"Data":{"IsAllEntities":true,"IsByTag":true,"IncludeScriptAnnotations":true,"Tag":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"my_tag","VariableIndex":0,"Metadata":null},"Target":{"IsSelf":false,"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.RemoveAnnotationsCommand"}