hasProperty: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (13 intermediate revisions by 8 users not shown) | |||
| Line 1: | Line 1: | ||
= | {{stub|Examples of usage.}} | ||
{{ | {{MacroFunction | ||
|name=hasProperty | |||
|version=1.3b48 | |||
|description= | |||
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. It will return {{false}} if the Property is defined in the in the token's current property type but is blank. | |||
|usage= | |||
< | <syntaxhighlight lang="mtmacro" line> | ||
hasProperty(name) | |||
</ | hasProperty(name, tokenRef) | ||
hasProperty(name, tokenRef, mapRef) | |||
</syntaxhighlight> | |||
'''Parameters''' | |||
{{param|name|The name of the [[Token Property]] which is checked for on the token.}} | |||
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token which is checked for the [[Token Property]], 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.}} | |||
|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, 16 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.
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. It will return false(0) if the Property is defined in the in the token's current property type but is blank.Usage
hasProperty(name)
hasProperty(name, tokenRef)
hasProperty(name, tokenRef, mapRef)Parameters
name- The name of the Token Property which is checked for on the token.tokenRef- Either the tokenidor Token Name of 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.
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.
Version Changes
- 1.3b51 - Added
idparameter option. - 1.5.4 - Added
mapnameparameter option.