getPropertyType: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (11 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(id) | |||
getPropertyType(id, mapname) | |||
</syntaxhighlight> | |||
'''Parameter''' | |||
{{param|id|The token {{code|id}} of the token which has its [[Introduction to Tokens#Property Type|Property Type]] returned, defaults to the [[Current Token]]. {{TrustedParameter}} }} | |||
{{param|mapname|The name of the map to find the token. Defaults to the current map.}} | |||
|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 18:13, 25 April 2023
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(id)
getPropertyType(id, mapname)Parameter
id- The tokenidof the token which has its Property Type 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.
See Also
Version Changes
- 1.3b51 - Added
idparameter option. - 1.5.4 - Added
mapnameparameter option.