hasProperty: Difference between revisions
Jump to navigation
Jump to search
m (Added MacroFunction template and Token Function category) |
No edit summary |
||
| (8 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{stub|Examples of usage.}} | |||
{{MacroFunction | {{MacroFunction | ||
|name=hasProperty | |name=hasProperty | ||
|version=1.3b48 | |||
|description= | |description= | ||
Returns | Returns {{true}} if the [[Token Property]] with the specified name exists on a [[Token]]. The function will return true if the token possesses the specified property, even if that property is not defined in the token's current property type. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
hasProperty(name) | |||
</ | hasProperty(name, id) | ||
hasProperty(name, id, mapname) | |||
</syntaxhighlight> | |||
'''Parameters''' | |||
{{param|name|The name of the [[Token Property]] which is checked for on the token.}} | |||
{{param|id|The token {{code|id}} of the token which is checked for the [[Token Property]], defaults to the [[Current Token]]. {{TrustedParameter}} }} | |||
{{param|mapname|The name of the map to find the token. Defaults to the current map.}} | |||
|changes= | |||
{{change|1.3b51|Added {{code|id}} parameter option.}} | |||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]][[Category:Property Function]] | ||
Latest revision as of 16:01, 15 March 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.
hasProperty() Function
• Introduced in version 1.3b48
Returns
true(1) if the Token Property with the specified name exists on a Token. The function will return true if the token possesses the specified property, even if that property is not defined in the token's current property type.Usage
hasProperty(name)
hasProperty(name, id)
hasProperty(name, id, mapname)Parameters
name- The name of the Token Property which is checked for on the token.id- The tokenidof the token which is checked for the Token Property, 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.
Version Changes
- 1.3b51 - Added
idparameter option. - 1.5.4 - Added
mapnameparameter option.