Library Token

From RPTools Wiki
Jump to navigation Jump to search

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

Library Token Requirements

For library tokens to be usable by player and NPC tokens, as well as global or campaign macros, they must meet the following requirements:

  1. The library token must be visible to players (make sure Visible to Players is set in the right-click context menu)
  2. The library token must have a name in the format "Lib:name"
  3. The library token must be present on only one map in the campaign file.

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.