getAllPropertyNames: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
Line 11: Line 11:
</source>
</source>


If type is specified then the [[Macros:string list|string list]] contains the [[Token:token property|property] names for that [[Token:token property type|token property type]], otherwise it will contain the [[Token:token property|token property]] names for all [[Token:token property type|token property type]]s. If delim is specified then it is used to separate the values in the [[Macros:string list|string list]], if it is not specified then it defaults to ','.
If type is specified then the [[Macros:string list|string list]] contains the [[Token:token property|property]] names for that [[Token:token property type|token property type]], otherwise it will contain the [[Token:token property|token property]] names for all [[Token:token property type|token property type]]s. If delim is specified then it is used to separate the values in the [[Macros:string list|string list]], if it is not specified then it defaults to ','.


===Examples===
===Examples===

Revision as of 21:12, 21 December 2008

Function getAllPropertyNames

Gets a string list containing the the token property names that are defined in the campaign properties.

Usage

[h: player = getAllPropertyNames()]
[h: player = getAllPropertyNames(type)]
[h: player = 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]