getMatchingLibProperties

Contents 1 getMatchingLibProperties() Function 1.1 Usage 1.2 Examples 1.3 See Also

getMatchingLibProperties() Function

Returns a String List or JSON Array with names of the Token Properties on a specific Library Token that match the given pattern.

Usage

Parameters

• pattern - A regular expression(regex) that represents the pattern the properties should match.
• lib - The name of the Library Token that is checked for properties that match, defaults to the Library Token the macro is running on.
• delim - The delimiter used in the String List that is returned, defaults to ",". Returns a JSON Array if "json" is specified.

Examples

Assuming that you have a Library Token that contained a list of all the items and their detail in your campaign stored as Token properties names with the following format Type:Item Name (for example Weapon:Longsword), you could use the following code to loop through all the weapons.

Or the following to loop through all the armor

Or even all the armor and all the shields.

See Also

getMatchingProperties() getLibPropertyNames()

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."Token: A visual marker representing a character, monster, or NPCCampaign 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.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.Macro: A series of text instructions used to automate processes in MapTool.String List: A string containing a list of items in the format "item1, item2, item3,..."Campaign: A zipped XML file with the '''.cmpgn''' file extension containing tokens, maps, token macros, campaign macros, and token propertiesMap: An image file displayed in the map display area in MapTool. This image is shared among all connected players and the GM.