hasProperty: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(New page: ==Function hasProperty== {{ProposedChange}} Returns 1 if the Token:token property with the specified name exits on the current Token:token. ===Usage=== <source lang="mtmacro" li...)
 
No edit summary
(12 intermediate revisions by 7 users not shown)
Line 1: Line 1:
==Function hasProperty==
{{stub|Examples of usage.}}
{{ProposedChange}}
{{MacroFunction
Returns 1 if the [[Token:token property|token property]] with the specified name exits on the current [[Token:token|token]].
|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.  


===Usage===
|usage=
<source lang="mtmacro" line>
<syntaxhighlight  lang="mtmacro" line>
[h: propExsits = hasProperty(name)
hasProperty(name)
</source>
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:Property Function]]

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 token id 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

  • mapname - The name of the map to find the token. Defaults to the current map.


Version Changes

  • 1.3b51 - Added id parameter option.
  • 1.5.4 - Added mapname parameter option.