macros:Glossary

C

Campaign or Campaign file

A zipped XML file with the .cmpgn file extension containing tokens, maps, token macros, campaign macros, campaign properties, and token properties

Campaign Macro

A macro specific to a campaign file. These macros are available to players and the GM, and are displayed in the Campaign Macros window.

D

Dialog

A modeless (i.e., does not require user interaction) popup generated by the dialog roll option.

F

Frame

A dockable MapTool window that can be generated via the frame roll option.

G

Global Macro

Macros that are available regardless of the campaign file currently loaded in MapTool, and regardless of whether the instance of MapTool is a server or a client. Global macros are only available to the running instance.

I

Image token

A special token that contains an image that may be referenced by other macros.

Initiative Panel

A dockable panel in MapTool that provides simple initiative tracking functionality.

L

Library Token

A special token designed to hold a library of macros (similar to a function library) that can be called by token macros, campaign macros, and global macros. Often called "Lib:tokens."

M

Macro

A series of text instructions used to automate processes in MapTool. See Macro Introduction for more details.

Map

An image file displayed in the map display area in MapTool. This image is shared among all connected players and the GM.

P

Property

Generic term for a variable contained in a token; a more explicit term is token property.

R

Roll Option

One of several "switches" that alter how the macro code following the switch is executed. Roll options (also called roll formatting options) are always in the format [option(arguments): body of roll]. Simple options include [h: ] (hides output of roll) or [t: ] (creates a "tooltip roll"), while more complex options include [SWITCH(): ] and [IF(): ].

S

State

Also called a token state, a state is a binary condition that is set for a given token.

String List

A string containing a list of items in the format "item1, item2, item3,..."

String Property List

A string containing key-value pairs in the format "key1=value1; key2=value2; key3=value3;..."

T

Token

A visual marker that is dropped on a MapTool map. Tokens usually represent characters, monsters, or NPCs, and often including an image as well as a set of token properties which define the attributes of the creature or character.

Token Bar

One, two, or multi-image graphical elements displayed on a token that are typically used to visually indicate the status of consumable or expendable resource such as Hit Points or Ammunition.

Token State

A binary (i.e., it has two possible values, 1 or 0) variable that is set for a given token, frequently used for conditions or statuses that affect a particular character in a game (for example "Bloodied" or "Fatigued"). Token states often have images associated with them that appear as overlays on the token.

Trusted Macro

A macro run from a Library token or run by the GM.