Tagger

A module made by Fantasy Computerworks.

Other works by us:

Fantasy Calendar - The best calendar creator and management app on the internet
Sequencer - Wow your players by playing visual effects on the canvas
Item Piles - Drag & drop items into the scene to drop item piles that you can then easily pick up
Token Ease - Make your tokens feel good to move around on the board
Rest Recovery - Automate most D&D 5e long and short rest mechanics

Like what we've done? Buy us a coffee!

What is Tagger?

This module allows you to put unique tags on objects in scenes and use Tagger's powerful API to quickly retrieve them.

Supported Modules

Token Attacher - If you have tag rules (like {#}) on attached objects, they will get applied when the prefab is first created, even on nested attached objects
Monks Active Tile Triggers - This module also integrates Tagger to be able to select objects in the scene in its actions, and similarly to above, tag rules are evaluated when an active tile is created, either manually or through Token Attacher!

Download

https://github.com/fantasycalendar/FoundryVTT-Tagger/releases/latest/download/module.json

Or if you want to try experimental features:

https://raw.githubusercontent.com/fantasycalendar/FoundryVTT-Tagger/next/module.json

Dialogs

All major PlaceableObjects' configuration dialogues (such as actor prototype tokens, tokens, tiles, walls, lights, etc), now has a "Tags" field.

Each tag is separated by a comma.

Documentation

Functions

Tagger.getByTag(inTags, inOptions) ⇒ Array: Gets PlaceableObjects with matching tags provided to the method
Tagger.hasTags(inObject, inTags, inOptions) ⇒ Boolean: Verifies whether a given PlaceableObject or Document has the tags given
Tagger.getTags(inObject) ⇒ Array: Gets all tags from a given PlaceableObject or Document
Tagger.setTags(inObjects, inTags) ⇒ Promise: Set the tags on an PlaceableObject or Document, completely overwriting existing tags on the object
Tagger.toggleTags(inObjects, inTags) ⇒ Promise: Toggles the tags on an PlaceableObject or Document. If a tag is present, it will be removed. If it not present, it will be added.
Tagger.addTags(inObjects, inTags) ⇒ Promise: Adds tags to an object
Tagger.removeTags(inObjects, inTags) ⇒ Promise: Removes tags from an object
Tagger.clearAllTags(inObjects) ⇒ Promise: Removes all tags from PlaceableObjects
Tagger.applyTagRules(inObjects) ⇒ Promise: Applies all tag rules to every tag found on the given PlaceableObjects
Tag Rules: Tag rules that are applied on object creation.

Tagger.getByTag(inTags, inOptions) ⇒ `Array`

Examples:

// Find objects whose tags contain "tag_to_find"
const objects = Tagger.getByTag("tag_to_find");

// Find objects with JUST and ONLY the tag "tag_to_find"
const objects = Tagger.getByTag("tag_to_find", { matchExactly: true });

Gets PlaceableObjects with matching tags provided to the method

Returns: Array - Returns an array of filtered Documents based on the tags

Param	Type	Description
inTags	`String/RegExp/Array.<String/RegExp>`	An array of tags or a string of tags (separated by commas) that will be searched for
inOptions	`Object`	An optional object that can contain any of the following: - matchAny {Boolean} - whether the PlaceableObjects can contain any of the provided tags - matchExactly {Boolean} - whether the tags on the PlaceableObjects must contain ONLY the tags provided - caseInsensitive {Boolean} - whether the search is case insensitive (capitals vs lowercase is not considered) - allScenes {Boolean} - whether to search in all scenes, this will return an object with the key as the scene ID, and an array for objects found within that scene - objects {Array} - an array of PlaceableObjects to test - ignore {Array} - an array of PlaceableObjects to ignore - sceneId {String} - a string ID for the scene to search in

Tagger.hasTags(inObject, inTags, inOptions) ⇒ `Boolean`

Examples:

// Whether the selected token has the tag "tag_to_find"
const objects = Tagger.hasTags(token, "tag_to_find");

// Whether the token has a tag that resembles "tag_to_find" or "TAG_TO_FIND" or "tAg_To_FiNd"
const objects = Tagger.hasTags(token, "TAG_to_FIND", { caseInsensitive: true });

Verifies whether a given PlaceableObject or Document has the tags given

Returns: Boolean - Returns a boolean whether the object has the given tags

Param	Type	Description
inObject	`PlaceableObject`	A PlaceableObject, or an array of PlaceableObjects to check for tags on
inTags	`String/Array`	An array of tags or a string of tags (separated by commas) that will be searched for
inOptions	`Object`	An optional object that can contain any of the following: - matchAny {Boolean} - whether the PlaceableObjects can contain any of the provided tags - matchExactly {Boolean} - whether the tags on the PlaceableObjects must contain ONLY the tags provided - caseInsensitive {Boolean} - whether the search is case insensitive (capitals vs lowercase is not considered)

Tagger.getTags(inObject) ⇒ `Array`

Examples:

// If the token has several tags, this method will return all of those tags as an array
const tags = Tagger.getTags(token);

Gets all tags from a given PlaceableObject or Document

Returns: Array - An array of tags from the Document

Param	Type	Description
inObject	`PlaceableObject`	The PlaceableObject or Document get tags from

Tagger.setTags(inObjects, inTags) ⇒ `Promise`

Examples:

// Sets the tags on the token to be ONLY "tag_to_set"
await Tagger.setTags(token, "tag_to_set");

// You can also set multiple tags with an array
await Tagger.setTags(token, ["tag_to_set", "tag_to_also_set"]);

// Or as a string with each tag separated with a comma
await Tagger.setTags(token, "tag_to_set, tag_to_also_set");

Set the tags on an PlaceableObject or Document, completely overwriting existing tags on the object