The Token is a placeable object which visually represents The Actor Entity on the game Canvas. The Token displays the Actor's position, appearance, rotation, vision configuration, status effects, and more. Each Token is specific to The Scene Entity in which it exists.

Token Configuration Modes

An important concept to understand when working with Tokens is the difference between a Prototype Token and a placed Token.

Prototype Token Configuration

A Prototype Token is the configuration of a Token for a particular Actor before that Token has been placed onto the game canvas. The prototype defines the default setup that a newly created Token starts with. To configure the Prototype Token for an Actor, open the Actor Sheet and click the Prototype Token button in the top bar.

Placed Token Configuration

Once a Token is placed, it becomes it's own independent copy of the prototype. For example - a Prototype Token for a player character could be configured to have a certain vision distance - but when that Token is placed into a Scene that has different lighting conditions, the placed copy of the Token could be changed to increase or decrease visibility. To configure a placed Token, right click on the Token to display the Token HUD and click the gear icon to open that Token's configuration sheet.

Token Configuration Options

The Token Configuration sheet features the following options which are shown in the above image and explained in the table below.

Token Name

Configure the name which is shown for the token, this can potentially be different from the name of the actual Actor.

Display Name

Configure the level of visibility for the token’s nameplate. The following options are supported:

• None - The nameplate will not be shown
• Control - Displayed when the Token is currently controlled
• Owner Hover - Displayed when the token is hovered over by a User who owns the token’s Actor
• Hover - Displayed when the token is hovered over by any User
• Owner - Always displayed to any User who owns the token’s Actor
• Always - Always displayed to every User

Represented Actor

Specify which Actor that is present within the World defines the Actor data which describes the Token.

Link Actor Data

When enabled, changes to the resource pools either on the base Actor or on the Token itself will reflect in the other location. As a general rule of thumb, Tokens should be linked if their Actor is a unique character, such that there would only be one instance of that Actor within any particular Scene. Alternatively, Tokens should not be linked when the Actor entry represents a generic creature or type of character. When data is not linked, each Token will have independent resources pools and turn order tracking.

Token Disposition

For non-player characters, setting a Token disposition allows for the colored border shown around a Token to be drawn in a different color which can differentiate enemies from allies during combat encounters.

Token Image Path

The file path to the artwork that is used for the Token. This file must either be served locally from within the public directory or from some publicly accessible web location.

Randomize Wildcard Images

If checked, the provided Token Image Path is treated as a wildcard pattern that is matched against multiple existing files. When a wildcard Token is configured, each time that Token is placed an image is randomly chosen from the matching set.

Width

The number of grid units in the horizontal dimension that this token occupies. A token which uses a single grid square would have a width of 1.

Height

The number of grid units in the vertical dimension that this token occupies. A token which uses a single grid square would have a height of 1.

Scale

A scaling ratio for the size of the Token’s artwork. The token base is unaffected by this value, but the visual size of the artwork will change with scale. Numbers greater than 1 result in larger token artwork while numbers less than 1 result in smaller token artwork.

Mirror Horizontally

If this option is checked, the token artwork is flipped horizontally to "mirror" the Token's appearance.

X-Coordinate

The current x-coordinate of the Token in a Scene. This is displayed for reference only but cannot be configured.

Y-Coordinate

The current y-coordinate of the Token in a Scene. This is displayed for reference only but cannot be configured.

Elevation

The Token's current elevation in grid units which is displayed visually above the Token. This is used to indicate whether certain Tokens are flying or burrowing at an altitude that differs from what is standard for the Scene.

Rotation

The Token's current direction of facing in degrees. Rotation of zero (the default) corresponds to a southward facing as this is the most commonly used convention for Token artwork.

Lock Rotation

If this setting is enabled the token cannot be rotated. This setting is typically ideal for portrait style tokens where the artwork orientation is more ideally fixed.

Has Vision

This checkbox denotes whether the Token should be treated as a source of vision. If this is enabled, when the Token is controlled dynamic vision will be computed from the perspective of the Token. If this is disabled, the Token will not be a source of vision and no vision computations will occur as a result of controlling it. This setting, and other settings in the vision section, will only be used within a Scene which has Token Vision enabled.

Dim Vision

The visible radius with which the Token can see as if in dim light conditions.

Bright Vision

The visible radius with which the Token can see as if in bright light conditions. Please note that both this setting and the Dim Vision setting are radii with respect to the token location as the origin, so typically the Bright Vision radius is a smaller number than the Dim Vision setting.

Sight Angle

An angle of vision between zero and 360 degrees (the default) which represents the allowed field of view for this token. The computed angle of vision aligns to the direction of facing controlled by the rotation attribute.

Emit Dim Light

A radius of dim light emitted by this token that is visible by all other tokens.

Emit Bright Light

A distance of bright light emitted by this token that is visible by all other tokens. As with the above settings, these distances are radii with respect to the token center, so typically Emit Bright Light is a smaller number than the Emit Dim Light setting.

Sight Angle

An angle of light emission between zero and 360 degrees (the default) which represents the field of light that is emitted by this Token. The computed angle of emission aligns to the direction of facing controlled by the rotation attribute.

Display Bars

Configure the level of visibility for the token’s resource bars. The following options are supported:

• None - Resource bars will not be shown

• Control - Displayed when the Token is currently controlled

• Owner Hover - Displayed when the token is hovered over by a User who owns the token’s Actor

• Hover - Displayed when the token is hovered over by any User

• Owner - Always displayed to any User who owns the token’s Actor

• Always - Always displayed to every User

Bar 1 Attribute

Select the attribute from the Actor’s available data fields which should be displayed using the Token’s primary resource bar.

Bar 1 Data

These fields are displayed for reference purposes only - you cannot configure the value of resource bars within the Token configuration as those are controlled by the Actor which the Token represents.

Bar 2 Attribute

Select the attribute from the Actor’s available data fields which should be displayed using the Token’s secondary resource bar.

Bar 2 Data

These fields are displayed for reference purposes only - you cannot configure the value of resource bars within the Token configuration as those are controlled by the Actor which the Token represents.

Wildcard Token Images

• Explain process of setting wildcard tokens.
• Check the box
• Case sensitive pattern match

Frequently Asked Questions

How can I allow players to have shared vision across multiple Tokens?

This can be accomplished by ensuring the player or players have Observer or Owner permission to each of the Actors.If a User has permission to more than one token with vision, when no Token is controlled, the vision displayed will be the union of vision across all Tokens. If a User has a single Token controlled, their vision will be only what is visible to that one Token.

If you select a single Token and want to go back to shared vision across all tokens just de-select it by one of the following methods:

• Select an empty rectangle on the map.
• Shift+click the token to remove it from the controlled set.
• Press ESCAPE.
• [Optionally] Use the "deselection" module which will release control of your token when you left-click anywhere else in the Scene.

API References

To interact with Tokens programmatically, consider using the following API concepts:

• The Token Object
• The TokensLayer Canvas Layer
• The TokenConfig Application
• The TokenHUD Interface