GameplayTagsToolset.GameplayTagsToolset

Provides tools for reading and managing gameplay tags in the project's GameplayTagsManager.

6 tool(s).

GameplayTagsToolset.GameplayTagsToolset.AddTag

Adds a new gameplay tag to the project. This should ONLY be called after getting explicit direction or permission from the user.

Input schema

{
  "properties": {
    "comment": {
      "default": "/**\n\t * Adds a new gameplay tag to the project.\n\t * This should ONLY be called after getting explicit direction or permission from the user.\n\t * @param TagName The fully-qualified name of the tag to add, e.g. \"Character.State.Dead\".\n\t * @param Comment An optional developer comment describing the tag's purpose.\n\t * @param TagSource The INI source to add the tag to. Uses the default source if empty.\n\t */",
      "description": "An optional developer comment describing the tag's purpose.",
      "type": "string"
    },
    "tagName": {
      "description": "The fully-qualified name of the tag to add, e.g. \"Character.State.Dead\".",
      "type": "string"
    },
    "tagSource": {
      "description": "The INI source to add the tag to. Uses the default source if empty.",
      "type": "string"
    }
  },
  "required": [
    "tagName",
    "tagSource"
  ],
  "type": "object"
}

GameplayTagsToolset.GameplayTagsToolset.FindReferencersByTag

Returns assets that reference a gameplay tag.

Input schema

{
  "properties": {
    "tagName": {
      "description": "The fully-qualified gameplay tag to search for, e.g. \"Character.State.Dead\".",
      "type": "string"
    }
  },
  "required": [
    "tagName"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "A list of package paths that reference the tag.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

GameplayTagsToolset.GameplayTagsToolset.GetTagInfo

Returns detailed information about a specific gameplay tag.

Input schema

{
  "properties": {
    "tagName": {
      "description": "The fully-qualified name of the tag, e.g. \"Character.State.Dead\".",
      "type": "string"
    }
  },
  "required": [
    "tagName"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "The tag's developer comment, source INI file, and immediate children. Raises a script error if the tag does not exist.",
      "properties": {
        "children": {
          "description": "The fully-qualified names of this tag's immediate children.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "comment": {
          "description": "The developer comment describing the tag's purpose.",
          "type": "string"
        },
        "source": {
          "description": "The name of the INI source file that defines this tag (e.g. \"DefaultGameplayTags.ini\").",
          "type": "string"
        }
      },
      "required": [
        "comment",
        "source",
        "children"
      ],
      "title": "GameplayTagInfo",
      "type": "object"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

GameplayTagsToolset.GameplayTagsToolset.ListTags

Returns gameplay tags registered in the project.

Input schema

{
  "properties": {
    "parentTag": {
      "description": "If non-empty, only tags that are descendants of this tag are returned. For example, passing \"Character.State\" returns \"Character.State.Dead\", \"Character.State.Stunned\", etc. Pass an empty string to return all tags.",
      "type": "string"
    }
  },
  "required": [
    "parentTag"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "A sorted list of fully-qualified tag names.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

GameplayTagsToolset.GameplayTagsToolset.RemoveTag

Removes a gameplay tag from the project. This should ONLY be called after getting explicit direction or permission from the user.

Input schema

{
  "properties": {
    "tagName": {
      "description": "The fully-qualified name of the tag to remove, e.g. \"Character.State.Dead\".",
      "type": "string"
    }
  },
  "required": [
    "tagName"
  ],
  "type": "object"
}

GameplayTagsToolset.GameplayTagsToolset.RenameTag

Renames a gameplay tag, updating all references in the project. This should ONLY be called after getting explicit direction or permission from the user.

Input schema

{
  "properties": {
    "newTagName": {
      "description": "The new fully-qualified name for the tag.",
      "type": "string"
    },
    "oldTagName": {
      "description": "The fully-qualified name of the tag to rename.",
      "type": "string"
    }
  },
  "required": [
    "oldTagName",
    "newTagName"
  ],
  "type": "object"
}