getSightType

From RPTools Wiki
Revision as of 20:56, 13 May 2024 by Taustin (talk | contribs)
Jump to navigation Jump to search

getSightType() Function

• Introduced in version 1.3b48
Returns the type of sight that the Current Token has. When no sight type is set, returns an empty string.

Usage

getSightType()
getSightType(tokenRef)
getSightType(tokenRef, mapname)

Parameters

  • tokenRef - Either the token id or Token Name of the token to have the Sight type listed. 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.
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.7.0 - Now returns an empty string when no sight type is set.
  • 1.5.4 - Added id and mapname parameter options.
Retrieved from "https://wiki.rptools.info/index.php?title=getSightType&oldid=17831"