getAllPropertyNames: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Macros:Functions:getAllPropertyNames moved to getAllPropertyNames) |
Verisimilar (talk | contribs) m (Added version.) |
||
| Line 1: | Line 1: | ||
{{MacroFunction | {{MacroFunction | ||
|name=getAllPropertyNames | |name=getAllPropertyNames | ||
|version=1.3b48 | |||
|description=Gets a list containing the the [[Token:token property|token property]] names that are defined in the [[Campaign:campaign properties|campaign properties]]. The type of the value returned depends on the delimiter parameter. | |description=Gets a list containing the the [[Token:token property|token property]] names that are defined in the [[Campaign:campaign properties|campaign properties]]. The type of the value returned depends on the delimiter parameter. | ||
* If the delimiter is not specified then a [[Macros:string list|string list]] is returned with the default value of ',' is used. | * If the delimiter is not specified then a [[Macros:string list|string list]] is returned with the default value of ',' is used. | ||
| Line 8: | Line 9: | ||
|usage= | |usage= | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
getAllPropertyNames() | |||
</source> | |||
<source lang="mtmacro" line> | |||
getAllPropertyNames(type) | |||
</source> | |||
<source lang="mtmacro" line> | |||
getAllPropertyNames(type, delim) | |||
</source> | </source> | ||
Revision as of 11:58, 10 March 2009
getAllPropertyNames() Function
• Introduced in version 1.3b48
Gets a list containing the the token property names that are defined in the campaign properties. The type of the value returned depends on the delimiter parameter.
- If the delimiter is not specified then a string list is returned with the default value of ',' is used.
- If the delimiter "json" then a json array is returned. (as of MapTool 1.3b49)
- Otherwise a string list is returned with the delimiter passed in.
Usage
getAllPropertyNames()getAllPropertyNames(type)getAllPropertyNames(type, delim)If type is specified then the string list contains the property names for that token property type, otherwise it will contain the token property names for all token property types. If delim is specified then it is used to separate the values in the string list, if it is not specified then it defaults to ','.
Examples
You can use the following code to print out all of the properties in the campaign properties list..
Campaign Properties<br>
[h: props = getAllPropertyNames()]
[foreach(name, props, "<br>"): name]If you have two token property sets, for instance "PC" and "NPC", you could print out all of the properties for the "PC" property set like so:
PC Properties<br>
[h: props=getAllPropertyNames("PC")]
[foreach(name, props, "<br>"): name]