Revision as of 16:26, 30 November 2021

Attention: This page is community-maintained. For the official Roll20 version of this article, see the Help Center for assistance: Here .

The token features showed when a token is selected.

Tokens are the main thing you move around the tabletop, and they can be independent, or linked to a Character.

Only GMs can create & move new token to the tabletop or edit their deeper settings, while players can move around tokens assigned to them, and edit the name & bubbles of the token.

Basics

Creating a New Token

Any image that is placed on the b Objects and Tokens or E GM Info Overlay Layer automatically becomes a Token object. You can always scale the pawn field and its image to scale by right-clicking, advancing, assigning dimensions; if you use a grid that can influence other methods of varying the dimensions of the image and avoid inconvenience. You can rotate the image using the outgrowth that designates the front of the counter from above and the top in portrait use, but several token-specific elements have also been added. Note that generally the image requires a horizontal and then a vertical reversal to respect the direction provided in the programming of Roll20.

Note that all of these instructions also apply to Rollable Table Tokens(aka. Multi-sided tokens).

Move, Rotate & Scale

See Manipulating Tokens.

Every token is accompanied by image handles on each of the corners of the token and in the middle of each side. You can use these image handles in order to change the size of the token. Additionally, each token has a rotation handle that juts out from the token itself. The rotation handle represents the "front" of the token and can be used to orient the token to face any desired direction.

If you are using a grid for your play area, typically when resizing a token, it will snap to the grid. However, by holding the Alt key while using the image handles to resize you can temporarily disable this functionality. This can be very useful when aligning tokens that do not have identical dimensions.

Tokens can also be moved using Waypoints

Token Features

Radial Menu Bubbles (1)

The token features showed when a token is selected.

These three input bubbles can be used by the players or the GM as a counter to keep track of health, turns, money, fuel or whatever else proves useful for your game. Click on a bubble to change the value. You can enter a new value (e.g. "20" or "ABC"), and for numerical values you can also enter relative values (e.g. "+5" will add 5 to the current value, or "-10" will subtract 10.) You can change the colored rims of the bubbles by going to "Token Bar Colors + Display Settings" section on the My Settings tab on the Sidebar and selecting different palette colors.

Bar Overlay (2)

If set to be visible, these are passive bars that fill or empty depending on what's entered in its corresponding colored Value Bubble.

Nameplate (3)

If set to be visible, this will display the name of the Token.

Edit (4)

Full section: Token Settings

Clicking on the 'Edit/Settings button brings up a new window where you can name the Token, set permissions on who can control the Token, set what bars/auras are visible to/editable by the players and keep storage of GM notes. Note: This button is only visible to the GM You can also double-click on the token to open the same settings dialog.

Token Markers (5)

Main Article: Token Markers

This button rolls out a menu that gives you a series of colored dots, a red X and over 40 different markers that overlay over the Token image. You can use these to show status, ailments, or to differentiate multiples of the same Token type. You can have multiple Token Markers displaying simultaneously.

You can also add a numeral to individual Token Markers by mousing over the desired Token Marker in the rollout menu and tapping "0" through to "9" on the keyboard or numpad. A red numeral will appear on the Token Marker. Tapping "0" will clear the numeral from the Token Marker (but the Token Marker remains until it is clicked again in the menu).

The default position for the Token Markers is across the top of the token, but you can choose to have them run along the bottom, right or left side by going to the "Token Bar Colors + Display Settings" section on the y My Settings tab on the Sidebar and selecting the layout from the "Marker Position:" drop-down menu.

You can also add Custom Token Markers, which will appear in this menu as well.

Animation Pause (6)

On animated tokens, click the pause/play button to start or stop the animation. Note that animations will not start on the VTT if the "Enable Animated Graphics" checkbox is disabled in the y My Settings tab.

Token Actions

Main Article: Token Actions

Token Actions are specially-designated macros and character abilities which appear whenever a token is selected on the screen. They appear in a bar along the top of your screen, and the contents of the bar are context-sensitive.

Token Settings

Token Settings are split into Basic, Advanced and Updated Dynamic Lighting-tabs, that you can seamlessly switch between while editing your token information. All changes update in real-time.

Clicking the Edit button or double clicking on a Token brings up the Edit Token window:

Basic tab

Represents Character (2)

Tokens that represent a Character use the Can Be Edited & Controlled By settings of that Character.

Setting a Token to represent a Character allows Character Attributes to Token Bars (see the Useful Tip below).

If a Token represents a Character, you can open that Character to its Bio & Info Tab by holding down Shift and double-clicking on that Token or by holding down Shift and single-clicking on its Token Settings icon. Holding down Alt instead of Shift will open that Character to its Attributes & Abilities Tab.

Name (3)

Here you can set the name of the Token. If you choose to use the t Turn Tracker in your game, the Token's name will appear next to its thumbnail picture in the turn list.

Tooltip

This text box will allow you to add tooltips that can be read by a screen reader to a token. After entering the text for the tooltip make sure there is a checkmark in the box labeled “Show”. Tooltip text will appear below the token when the mouse is held over that token. There is a 150 character limit for text entered into the tooltip text field.

Controlled By (4)

This is where you assign who in your game has permission to control the Token. If the Token represents None/Generic then clicking on the "Controlled By" field will bring up a list of all the players in the current game as well as being able to select the option "All Players". You can assign multiple players to a single Token. If the Token represents a specific Character, then the Token is controlled by the player that has control of the Character which is set in the N Journal. GM always has control over the Tokens in their Game.

Note: If you are creating a brand new Game and your players have yet to join, their names will not yet be available for Token assignment. If you're setting your Pages up in advance of your first gaming session, it's recommended to set your PC Tokens to "All Players" and later fine-tune the permissions when your players have visited your Game.

Tint Color (5)

Here you can add a color filter to the Token. The default tint color is transparent.

Bars and Auras (6)

Bars

This is where you can set whether any of the three bar elements are either visible and/or editable to the players. The green heart, blue bolt and red cardiograph icons for the bars are there for identifying purposes only. They do not have to represent anything in particular in your game.

You can also input numerical values for the Bar Bubbles directly from the Edit Token window. There are two input fields available for each Bar. The first field is for the Bar's current value and is what's featured in the Token's corresponding Bar Value Bubble. The second field is for the Bar's total value. If it's supplied, Roll20 will use the comparison between the two numbers to render how full or empty that corresponding Bar appears on the Tabletop. The fill will reflect whatever the Player plugs into their Bar Value Bubble while in-game.

Also note that if the Token Represents a Character (as chosen in the field above), you can choose to link each bar to a specific Character Attribute. If you change the value in the bar (via the Token settings, radial bubbles, or in the Character settings) the value will update automatically.

Auras

An Aura is a translucently filled circle or square that radiates from the center of a Token. You can have up to two Auras active at once on any given Token. To turn one on, make sure it's toggled on to See first and then enter a radius value for the Aura. Next to the Aura's radius input field is a palette button where you can choose the color for the Aura. You can set the Aura to a square instead of a circle by checking off the "Square" checkbox next to the color palette button.

Note: To completely remove an Aura from view, do not change the radius value to zero. Clear the field instead. At zero, the Aura still draws to encircle the outer edge of the Token.

GM Notes (7)

This is a field where a GM can keep private notes on any given Token.

Advanced Tab

Player Permissions (1)

There are possible permissions for each setting: See or Edit. You can toggle the flag for each type by checking or unchecking the corresponding box.

Setting the See flag will allow all players in the game to view the current value of the bar, or see the aura drawn on the tabletop, regardless of whether or not they can control the Token.

Setting the Edit flag will allow all players who can control the Token (based on the "Controlled By" field, above) to see and edit the values of the bar, or change the radius of the aura drawn on the tabletop.

So if you have a Token that you want all players to see the bars for (like a PC), set the See flag. If you also want to allow some players to keep track of their own health, set the Edit flag. If you only want players who can control the Token to see and edit the bars, set only the Edit flag. And of course if you set none of the flags then only the GM will be able to see or edit the bars and auras.

Text Overlay (2)

Token bars can display text with the current value and maximum value of the bar.

As before, you can set the values of the bars to have a current and max value, or to pull those values from a character sheet. You can set the current value to more than the maximum, and you can set the current value to a negative value. When you do this, a "+" or "-" icon will display in the bar.

You can also include information in parentheses or text, and can include decimal points.

The current and max values for your bars will display as text on the bar

In the Advanced tab on the Edit Token options, you can select a value for the Text Overlay:

Hidden: Nobody sees it, including you.
Visible to Editors: Only players who can control the token (and GMs) see the text.
Visible to Everyone: All players can see the text overlay.

Bar Location (3)

The token bar placement is configurable on a token-by-token basis. In the Bar Position, you can select Above, Top Overlapping, Bottom Overlapping, and Below for the token bar position.

You can change the location of the token markers for your game if they're in the way of the token bars in the y My Settings tab.

Bar Style (4)

Token bars have two options: standard and compact.

The Standard option displays the bars stacked on top of each other, with the text overlay, if any, and the +/- overflow icons.

The Compact option displays the bars stacked on top of each other, but very narrow, with no overlay or overflow icons. When this option is selected, the text overlay will always be set to "Hidden" and cannot be changed.

Emits Light (6)

Here you can set how far light emits from the Token and if All Players can see the light emitted when Dynamic Lighting is enabled. This option allows you to enter a light radius amount and gives you a checkbox for All Players See Light. When the checkbox is left unchecked, the only player(s) who can see that token’s light emission are those who have assigned permission to that token. In addition to emitting light, you can now customize the “angle” of lights and the line of sight of tokens. So you can specify, for example, that a player should only have a 140-degree field of view instead of 360-degrees. The Multiplier feature allows you to adjust how effectively a token sees light. At a value of 1 the token sees light normally but at a value of 2 the token sees twice as far with the same light source.

Has Sight (7)

Tokens that have sight and are assigned to a player or GM will always be displayed to the player that controls the token, even if Fog of War or Advanced Fog of War would normally obscure them.

These tokens will also appear in front of other tokens on the tabletop to the controlling player.

Advanced Fog of War (8)

The Advanced Fog of War Reveal Distance sets how far your token will have Advanced Fog of War revealed to it. If the token does not have a light source, the greyed-out map will be revealed. If it does have a light source, it will see the lit-up map that is illuminated. Note that a token must have sight in order to see anything or have Advanced Fog of War revealed.

For performance reasons, tokens that are not owned by anyone do not reveal Advanced Fog of War. GMs can change this option in the Advanced Fog of War for an individual page.

Updated Dynamic Lighting

Main Page: Updated Dynamic Lighting

For the Updated Dynamic Lighting settings for tokens, check the UDL Token Settings page on the Roll20 Help Center.

API

main: Token APIs

There are plenty of API options for tokens

APIs that focus on interacting with tokens, or some aspect of them.

TokenMod -- An interface to adjusting properties of a token from a macro or the chat area. Very versatile and tons of options, and it can perform features of several other Token-related APIs.
Reporter^(Forum) -- A script to poll the game and return info on Token/Character pairs, along with customized action tools.
SelectManager - can patch and extend token selection between APIs
Supernotes^(Forum) -- script pulls the contents from a token's GM Notes field.
Clock Tokens
-- easy way to manage multi-sided tokens which are being used to represent progress clocks, or any other kind of incrementing timer or countdown.
Random Token Tinter -- will randomly assign (or remove) tints on tokens based on either a command-line list, a predefined Rollable Table, or a default rainbow (ROYGBV). See !!randtint --help for more.
TokenController^(Forum) - Automate Token Movement for Patrols, following, roaming, and more
WeaponArcs^(Forum) -- provides a means to add weapon arcs to tokens for visualization of range and targetable tokens
Faces^(Forum) -- This is a short script that is designed to provide a quick visual interface for swapping token images and names. Great for any changeling. by Keith

Movement, Rotation, and Size

Scripts which are triggered by or change the location of tokens should generally be placed in this category.

Bump^(Forum) - provides a way to invisibly manipulate tokens on the GM Layer from the Objects Layer, and vice versa.
TokenLock -- Allows GMs to selectively lock the movement of Player Tokens.
Carry Tokens^(Forum) -- Allows tokens to "carry" and move other tokens, like dragging other characters or moving items.
Collision Detection -- Handles collisions between player-controlled tokens and a subset of path objects on the page
DupCharToken -- Duplicate a Character and Token, and add identifying number to Character and Token.
It's a Trap! -- Script for setting traps and detecting collisions with them at any point during movement. Has separate versions customised for specific games/sheets
KABOOM -- Creates explosion effects that move tokens away from or towards a point.
Marching Order -- Makes tokens follow each other in some specified order.
Measure -- Measure distances between multiple tokens, both from the corners and the center.
Random Rotate -- Allows the GM to easily rotate all selected tokens to a random angle.
Teleport -- Teleports tokens within a page or between pages either by chat menu or token movement by using teleport tokens on the GM layer.
Spawn Default Token^(Forum) -- general idea is to automatically spawn the default token for a given "character" with various options for token qty, location/arrangement, and certain token properties such as size, side(for multi-sided tokens), light emission etc.
Token Fate -- Let fate decide! Randomly selects a token from the selected group.
Flip Tokens -- Flip graphics horizontally and/or vertically
SpinTokens -- Allows the GM to toggle spinning of selected tokens.
TokenController -- Allows GMs to quickly create patrol path shapes, assign tokens one or more paths, lock tokens in place, set tokens to follow each-other, and more. Uses complete menu system, no chat commands required.

Conditions, Status, Health

Tokens are used to represent player characters as well as non-player characters. Naturally, both occasionally get punched around a bit. Scripts in this category deal with the changing conditions of tokens, often but not necessarily as a result of combat.

Emojibubble^(Forum) -- System to easily display emojis in a bubble above Character Tokens, or on the map.
Flight -- Mark how high tokens are flying
Health Status
-- makes it possible for GM & players to see roughly how much health an enemy has.
Mark -- Places a numbered Marker under tokens, clears on turn change/close, and page change.
Marking Conditions -- Set status markers on targeted on individual tokens
TurnMarker1 -- provides a visual marker to show which token's turn it is & centers map on them.
TokenNameNumber -- Automatic numbering of tokens with special placeholder.
Monster Hit Dice -- Set Monster hit points from hit dice on add, usually via drag from journal.
Aura/Tint HealthColors^(Forum) --
code
-- Script to set health indicator on tokens via aura or tint, based on a bar's value.
- script variant by David M., uses only one aura1
RoundMaster -- Manages token statuses, Effect Macros, and Turn Order
[Token Patrol https://app.roll20.net/forum/post/11115799/script-token-patrol] by Patrick P.

@@ Line 8: / Line 8: @@
 Only [[GM|GMs]] can create & move new token to the [[Tabletop_Overview|tabletop]] or edit their deeper settings, while [[players]] can move around tokens assigned to them, and edit the name & bubbles of the token.
-== Creating a New Token ==
+==Basics==
+=== Creating a New Token ===
 Any image that is placed on the '''<span style="font-family:Pictos;">b</span> Objects and Tokens''' or '''<span style="font-family:Pictos;">E</span> GM Info Overlay''' [[Layer]] automatically becomes a '''Token''' object. You can always scale the pawn field and its image to scale by right-clicking, advancing, assigning dimensions; if you use a grid that can influence other methods of varying the dimensions of the image and avoid inconvenience. You can rotate the image using the outgrowth that designates the front of the counter from above and the top in portrait use, but several token-specific elements have also been added. Note that generally the image requires a horizontal and then a vertical reversal to respect the direction provided in the programming of Roll20.
@@ Line 15: / Line 16: @@
 See Also: [[Link Token|Link Token to Character Sheet]]
-==Move, Rotate & Scale==
+===Move, Rotate & Scale===
 See [[Manipulating Graphics|Manipulating Tokens]].
@@ Line 183: / Line 184: @@
 [[File:UDL-PageSettings.png|280px]]
+=API=
+{{pro only|section}}
+''main:'' '''[[API:Script_Index#Tokens|Token APIs]]'''
+There are plenty of API options for tokens
+{{:Token/API}}
 =See Also=
@@ Line 190: / Line 198: @@
 * [[Manipulating Tokens]] - move, rotate, scale, using waypoints
 * [[Invisible Tokens]]
-* <span style="font-family:Pictos;">y</span> [[My Settings]]-tab
+* {{My Settings}}-tab
 * [[Token Z-Ordering]] — ''How tokens layer on the VTT''
 * [[Token Markers]] - How to add custom token markers to your game
-* '''[[API:Script_Index#Tokens|Token APIs]]'''
-** [[TokenMod]] - A popular API for managing & editing your tokens with API commands
 <br />
 [[Category:Docs]]

Roll20 Wiki

Navigation

Personal tools

Toolbox

Difference between revisions of "Token Features"

From Roll20 Wiki