Skip to content

Modify Tags

Modify Tags

Adds, changes, or removes Tags on an object identified by its Unique ID.

Properties

System

Name Explanation Type
Add Key The variable-based key for the tag to add or update. Variable or Value
Add Value The variable-based value for the tag to add or update. Variable or Value
Changed Tags The tags to add or update on the target object. Each tag is a key-value pair. Tags
Provider The type of object whose tags will be modified, such as battlers, items, or skill slots. Tag Context Provider
Remove Key The variable-based key for the tag to remove. Variable or Value
Removed Tags The tags to remove from the target object. Each entry specifies a tag key to delete. Tags
Unique ID The unique identifier of the object whose tags will be modified. Variable or Value
Use Variables When enabled, tag keys and values are read from variables instead of being specified as fixed values. Toggle

Examples

Add a Tag to a Battler

This adds the tag "state" with value "poisoned" to the battler identified by the Unique ID stored in Global Variable 0.

modify_tags(battlers, $gv[0], add: ["state": "poisoned"]);

{"Data":{"ChangedTags":{"state":"poisoned"},"ContextProvider":{"$":"BattlerTagContextProvider","Metadata":null},"IsVariableBased":false,"RemovedTags":{},"UniqueID":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":0,"Metadata":null},"VariableAddKey":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"","VariableIndex":0,"Metadata":null},"VariableAddValue":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"","VariableIndex":0,"Metadata":null},"VariableRemoveKey":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"","VariableIndex":0,"Metadata":null},"Index":0,"IndexEnd":null,"IsLocal":0,"IsOperandReference":0,"IsReference":0,"OperandGlobalIndex":null,"OperandLocalIndex":null,"Metadata":null},"TypeName":"MAR.Game.Shared.Models.Scripts.Commands.Data.ModifyTagsCommand"}

Add and Remove Tags Using Variables

This adds a tag with a key from Global Variable 1 and value from Global Variable 2, and removes a tag with a key from Global Variable 3, on an item identified by the Unique ID stored in Global Variable 0.

modify_tags(items, $gv[0], add_variable: { $gv[1], $gv[2] }, remove: $gv[3]);

{"Data":{"ChangedTags":{},"ContextProvider":{"$":"ItemBaseContextProvider","Metadata":null},"IsVariableBased":true,"RemovedTags":{},"UniqueID":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":0,"Metadata":null},"VariableAddKey":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":1,"Metadata":null},"VariableAddValue":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":2,"Metadata":null},"VariableRemoveKey":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":3,"Metadata":null},"Index":0,"IndexEnd":null,"IsLocal":0,"IsOperandReference":0,"IsReference":0,"OperandGlobalIndex":null,"OperandLocalIndex":null,"Metadata":null},"TypeName":"MAR.Game.Shared.Models.Scripts.Commands.Data.ModifyTagsCommand"}