getPropertyNamesRaw: Difference between revisions

Latest revision as of 21:07, 14 March 2023

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 token id of 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 mapname parameter 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().

@@ Line 1: / Line 1: @@
-{{stub|Everything !}}{{MacroFunction |name=getPropertyNamesRaw |version=1.3b64
+{{MacroFunction |name=getPropertyNamesRaw |version=1.3b64
-|description= This function returns all the defined properties defined on a token. Be it hidden or not.
+|description=
+Returns a [[String List]] or [[JSON Array]] containing the names of the [[Token Property|Token Properties]] on a [[Token]]. The type of the value returned depends on the delimiter parameter.
-|usage= To be done.  |example= None.  |also= [[getPropertyNames]]  }}[[Category:Token Function]]
+The difference between this function and [[getPropertyNames|getPropertyNames()]] is that [[getPropertyNames|getPropertyNames()]] returns all the property names in lower case (see [http://forums.rptools.net/viewtopic.php?f=1&t=12563&p=148937&hilit=getPropertyNamesRaw#p148937 this forum thread] to get the reason why it was created).
+|usage=
+<syntaxhighlight lang="mtmacro" line>
+getPropertyNamesRaw()
+getPropertyNamesRaw(delim)
+getPropertyNamesRaw(delim, id)
+getPropertyNamesRaw(delim, id, mapname)
+</syntaxhighlight>
+'''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|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=
+To display the names of all of the [[Token Property|properties]] on the current [[Token:token|token]] use.
+<syntaxhighlight lang="mtmacro" line>
+[h: names = getPropertyNamesRaw()]
+[foreach(name, names, "<br>"): name]
+</syntaxhighlight>
+|changes=
+{{change|1.5.4|Added {{code|mapname}} parameter 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|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]]