getPropertyNamesRaw: Difference between revisions
Jump to navigation
Jump to search
m (Adding to Property Function category) |
No edit summary |
||
| Line 8: | Line 8: | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
getPropertyNamesRaw() | getPropertyNamesRaw() | ||
getPropertyNamesRaw(delim) | getPropertyNamesRaw(delim) | ||
getPropertyNamesRaw(delim, id) | getPropertyNamesRaw(delim, id) | ||
getPropertyNamesRaw(delim, id, mapname) | |||
</source> | </source> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|delim|The delimiter used to separate the values in the [[String List]], defaults to {{code|","}}. Returns a [[JSON Array]] if set to {{code|"json"}}. }} | {{param|delim|The delimiter used to separate the values in the [[String List]], defaults to {{code|","}}. Returns a [[JSON Array]] if set to {{code|"json"}}. }} | ||
{{param|id|The token {{code|id}} of the token which has its property names returned, defaults to the [[Current Token]]. {{TrustedParameter}} }} | {{param|id|The token {{code|id}} of the token which has its property names returned, defaults to the [[Current Token]]. {{TrustedParameter}} }} | ||
{{param|mapname|The name of the map to find the token. Defaults to the current map.}} | |||
|example= | |example= | ||
| Line 26: | Line 24: | ||
</source> | </source> | ||
|changes= | |changes= | ||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
}} | |||
===Notes=== | ===Notes=== | ||
When token properties are created during campaign, they are persistent in the MapTool campaign, regardless of whether they are editable in the ''Edit Token'' window. In other words, even though a property is removed from the campaign properties, it remains available in the MapTool code. [[getPropertyNamesRaw|getPropertyNamesRaw()]] will return ''all'' token properties that exist or have ever existed in the particular campaign, even if users cannot directly edit those properties (''i.e.'', they do not appear in the token's properties when you double click on a token). To get only properties that are currently visible and editable, use [[getAllPropertyNames|getAllPropertyNames()]]. | When token properties are created during campaign, they are persistent in the MapTool campaign, regardless of whether they are editable in the ''Edit Token'' window. In other words, even though a property is removed from the campaign properties, it remains available in the MapTool code. [[getPropertyNamesRaw|getPropertyNamesRaw()]] will return ''all'' token properties that exist or have ever existed in the particular campaign, even if users cannot directly edit those properties (''i.e.'', they do not appear in the token's properties when you double click on a token). To get only properties that are currently visible and editable, use [[getAllPropertyNames|getAllPropertyNames()]]. | ||
[[Category:Token Function]][[Category:Property Function]] | [[Category:Token Function]][[Category:Property Function]] | ||
Revision as of 19:31, 15 August 2019
getPropertyNamesRaw() Function
• Introduced in version 1.3b64
Returns a String List or JSON Array containing the names of the Token Properties on a Token. The type of the value returned depends on the delimiter parameter.
The difference between this function and getPropertyNames() is that getPropertyNames() returns all the property names in lower case (see this forum thread to get the reason why it was created).
Usage
getPropertyNamesRaw()
getPropertyNamesRaw(delim)
getPropertyNamesRaw(delim, id)
getPropertyNamesRaw(delim, id, mapname)Parameters
delim- The delimiter used to separate the values in the String List, defaults to",". Returns a JSON Array if set to"json".id- The tokenidof the token which has its property names returned, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
mapname- The name of the map to find the token. Defaults to the current map.
Example
To display the names of all of the properties on the current token use.
[h: names = getPropertyNamesRaw()]
[foreach(name, names, "<br>"): name]
Version Changes
- 1.5.4 - Added
mapnameparameter option.
Notes
When token properties are created during campaign, they are persistent in the MapTool campaign, regardless of whether they are editable in the Edit Token window. In other words, even though a property is removed from the campaign properties, it remains available in the MapTool code. getPropertyNamesRaw() will return all token properties that exist or have ever existed in the particular campaign, even if users cannot directly edit those properties (i.e., they do not appear in the token's properties when you double click on a token). To get only properties that are currently visible and editable, use getAllPropertyNames().