getPropertyNamesRaw: Difference between revisions

Revision as of 19:32, 9 September 2011

This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
This article needs: Everything !

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 getAllPropertyNames() is not clear to me. The only noticeable difference is that getAllPropertyNames() returns all the property names in lower case.

Usage

getPropertyNamesRaw()

getPropertyNamesRaw(delim)

getPropertyNamesRas(delim, id)

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.

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

None.

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
 |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. The difference between this function and getPropertyNames() is that this function returns only the defined properties, where getPropertyNames returns also the names of the properties of the Property Type, even if these are not defined or set to their default value.
+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. The difference between this function and [[getAllPropertyNames|getAllPropertyNames()]] is not clear to me. The only noticeable difference is that [[getAllPropertyNames|getAllPropertyNames()]] returns all the property names in lower case.
 |usage=
@@ Line 25: / Line 25: @@
 |changes=None.}}
+===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|getAllPropertyNames()]].
 [[Category:Token Function]]