Token Property: Difference between revisions

Revision as of 21:30, 21 December 2008

A token property is a variable (string or numeric) that resides on a particular token within MapTool, and may be called upon or evaluated by macros.

Token properties are tailored to fit each individual campaign file and the macros contained in that campaign.

Default Token Properties

By default, MapTool provides the following set of campaign properties when a token is dropped onto the map display.

Strength (Str)
Dexterity (Dex)
Constitution (Con)
Intelligence (Int)
Wisdom (Wis)
Charisma (Char)
*@HP
*@AC
Defense (Def)
Movement (Mov)
*Elevation (Elv)
Description (Des)

Setting Campaign Properties

Campaign properties are edited using the Campaign Properties dialog, which is found under Edit -> Campaign Properties on the MapTool menu. They can be directly edited in the Campaign Properties dialog, or pasted in from a text editor of choice.

Token Property Format

The format for all token properties.

#*@PropertyName(ShortName):default value

Example Token Property

*@HealingSurges(Surges):9

Will display Surges: 9 in the statsheet.

Controlling Token Property Display

There are three "switches" (shown in the format string above) that control how campaign properties are displayed in the popup statsheet when the user mouses over a token:

* - Displays the property on the statsheet

@ - Property will be visible only to the owner of that token

# - Property will be visible only to the GM

Note that the * switch is essential for the property to be displayed on the statsheet; the @ and # are optional modifiers to that display. If no switch is set in the property string, the property will be present on the token and accessible to macros but will not be displayed in the popup statsheet.

@@ Line 1: / Line 1: @@
 A ''token property'' is a variable (string or numeric) that resides on a particular [[Token:token|token]] within MapTool, and may be called upon or evaluated by macros.
-Token properties are tailored to fit each individual campaign file and the macros contained in that campaign. By default, MapTool provides the following set of campaign properties when a token is dropped onto the map display.
+Token properties are tailored to fit each individual campaign file and the macros contained in that campaign.
 ==Default Token Properties==
+By default, MapTool provides the following set of campaign properties when a token is dropped onto the map display.
   Strength (Str)