getMatchingProperties: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
m (Adding to Property Function category)
Line 49: Line 49:


}}
}}
[[Category:Property Function]]

Revision as of 18:29, 12 August 2011

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, id)

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.
  • id - The token id 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

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:.*")): {
    <!-- Do something really exciting here -->
}]

Or the following to loop through all the weapons

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

Or even all the armor and all the shields.

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

See Also