getAllPropertyNames

From RPTools Wiki
Revision as of 06:48, 1 December 2008 by Craig (talk | contribs) (New page: ==Function getAllPropertyNames== {{ProposedChange}} Gets a Macros:string list containing the the property names that are defined in the campaign properties. ===Usage=== <source ...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Function getAllPropertyNames

 Note: This refers to a proposed change that has not been implemented in the main code base yet.

Gets a string list containing the the 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 type, otherwise it will contain the property names for all property types. If delim is specified then it is used to separate the values in the 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 property list..

Campaign Properties<br>
[h: props = getAllPropertyNames()]
[foreach(name, props, "<br>"): name]