getMatchingProperties

getMatchingProperties() Function

• Introduced in version 1.3b54

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

Usage

getMatchingProperties(pattern)
getMatchingProperties(pattern, delim)
getMatchingProperties(pattern, delim, tokenRef)
getMatchingProperties(pattern, delim, tokenRef, mapRef)

Parameters

• pattern - A regular expression(regex) that represents the pattern the properties should match.
• delim - The delimiter used in the String List that is returned, defaults to ",". Returns a JSON Array if "json" is specified.
• tokenRef - Either the token id or Token Name of the token that is checked for properties that match the given pattern, defaults to the Current Token.

   Note: This parameter can only be used in a Trusted Macro. 

• mapRef - The Name or ID of the map to find the token. Defaults to the current map.

Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.

Examples

Say you wanted to keep an inventory list for the Token you could prefix all of your inventory properties with Inv:Category:. For example Inv:Weapon:Longsword.

Then to loop through all of the inventory properties you could use

[foreach(item, getMatchingProperties("Inv:.*")), code: {
    <!-- Do something really exciting here -->
}]

Or the following to loop through all the weapons

[foreach(item, getMatchingProperties("Inv:Weapon:.*")), code: {
    <!-- Do something really exciting here -->
}]

Or even all the armor and all the shields.

[foreach(item, getMatchingProperties("Inv:(Armor|Shield):.*")), code: {
    <!-- Do something really exciting here -->
}]

See Also

getMatchingLibProperties() getPropertyNames()

Version Changes

• 1.5.4 - Added mapname parameter option.