hasProperty

From RPTools Wiki
Revision as of 23:59, 16 May 2024 by Taustin (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

 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 token id or 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 id parameter option.
  • 1.5.4 - Added mapname parameter option.