You can attach tags to various entities in order to modify their behavior. Tags have three main uses:
- For snap points, tags can define what objects can snap to a particular snap point.
- For containers, tags can define what objects can be inserted into the container.
- In the container explorer, stack explorer, and object library, the search will find objects where a tag matches the search term in addition to objects where the name matches.
There are a couple of places where you can edit tags:
- In the in-game object properties, you can set which tags an object has.
- In the in-game object properties for a container, you can also set the container tags: they determine what objects can be inserted into the container. If the container tags are not empty, only object that have at least one matching tag can be inserted.
- In the editor object properties pane, you can set the default tags for objects of this type. A newly created object will have these tags, but they can be modified in the in-game object properties.
- In the editor snap points pane, you can set tags for each snap point. If tags for a snap point are not empty, only objects that have at least one matching tag can snap to the snap point.
- In the editor for card objects and similar types like tiles or tokens, you can set tags for each image index in the deck. Card tags are used in the card stack explorer window to quickly find cards with a tag that matches the search term. If an object is a single card (and not a stack of cards), the tags used for snapping and containers will be combined from both the object tags and the card tags for this card.
When you use tags from scripting,
myCard.getTags()returns only the object tags, and the card tags are accessible using
CardDetails.tags, for example
myCard.getCardDetails().tagsfor a single card.
The tag editor always shows all tags that are in use for the current game (when used in-game or in preview mode) or the current package (when used in the editor). This allows you to quickly find and activate tags that are already used elsewhere. To create a new tag, enter the name in the search field and press enter or the “Plus” button.