Library Token

Languages:  English  • 日本語

Introduced in MapTool version b46, the Library Token is a special token type that acts as a library of properties and trusted macros that may be accessed and called by other macros.

Library Token Naming

All library tokens must have a name in the format "Lib:name", to indicate that they are to serve as a Library Token and not a "normal" token. Example library token names might be:

• Lib:test
• Lib:combat
• Lib:gamemaster

Creating a Library Token

To create a Library Token, do the following:

1. Drag a new token on to one of the maps in your campaign.
2. Rename it with a name in the format Lib:name (e.g., Lib:DnD, Lib:GameRules, etc.).
3. Right click on the token and make sure that Visible to Players is checked.
4. Set the token type to NPC (upper right corner of the Token Configuration dialog).

After that, you have a Library Token. Note that you cannot have two library tokens with the same name in the same campaign (even if they're on different maps!).

Once again, the requirements are:

• The library token must be visible to players (make sure Visible to Players is set in the right-click context menu). The library token need not be on the "Token" layer (you can keep it on the "Hidden" layer to hide it from players, although "Visible to Players" must still be set to true).
• The library token must have a name in the format "Lib:name"
• The library token must be present on only one map in the campaign file.
• In order for trusted functions to work, the library token must either:
  • Not be owned by any players, or
  • The macros on the library token must not be player-editable.

Library Tokens and Trusted Macros

In addition to the above requirements if you want players to be able to run any macro that calls a function designated as a trusted function the following requirement must also be met.

1. The library token must not be owned by any players (in the Ownership tab of the Edit Token dialog, make sure that no boxes are checked)

Multiple library tokens may exist in the same campaign provided no two library tokens have the same token name.

Library Token Macros

Library token macros are created and edited like macros on any token. Macros on a library token may be called using the [MACRO(): ] roll option. Since Library token macros are trusted, they may perform operations not available to regular tokens.

Library Token Properties

Library token properties can be accessed by using the getLibProperty() function. Note that default property values do NOT work using that function.

Languages:  English  • 日本語