getPropertyType: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (13 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
= | {{stub|Examples of usage.}} | ||
{{MacroFunction | |||
|name=getPropertyType | |||
|version=1.3b48 | |||
|description= | |||
Returns the [[Introduction to Properties#The Token Properties Tab|Property Type]] of a [[Token]]. | |||
|usage= | |||
<syntaxhighlight lang="mtmacro" line> | |||
getPropertyType() | |||
getPropertyType(tokenRef) | |||
getPropertyType(tokenRef, mapRef) | |||
</syntaxhighlight> | |||
'''Parameter''' | |||
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token which has its [[Introduction to Tokens#Property Type|Property Type]] returned, defaults to the [[Current Token]]. {{TrustedParameter}} }} | |||
{{param|mapRef|The Name or ID of the map to find the token. Defaults to the current map.}} | |||
{{Note|Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.}} | |||
|also= | |||
[[setPropertyType|setPropertyType()]] | |||
[ | |||
|changes= | |||
{{change|1.3b51|Added {{code|id}} parameter option.}} | |||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
}} | |||
[[Category:Token Function]][[Category:Property Function]] | |||
Latest revision as of 23:59, 13 May 2024
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
This article needs: Examples of usage.
getPropertyType() Function
• Introduced in version 1.3b48
Returns the Property Type of a Token.
Usage
getPropertyType()
getPropertyType(tokenRef)
getPropertyType(tokenRef, mapRef)Parameter
tokenRef- Either the tokenidor Token Name of the token which has its Property Type returned, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
mapRef- The Name or ID of the map to find the token. Defaults to the current map.
Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.
See Also
Version Changes
- 1.3b51 - Added
idparameter option. - 1.5.4 - Added
mapnameparameter option.