setHasSight

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

setHasSight() Function

Introduced in version 1.3b48
Enables/disables sight for the Current Token. If the argument is 0 (false) sight will be disabled on the Current Token. If it is non-zero (true) sight is enabled.

Usage

setHasSight(state)
setHasSight(state, id)
setHasSight(state, id, mapRef)

Parameters

  • state - Boolean - true to enable sight, false to disable
  • id - The id of the token to set the sight of. 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.

Example

Enables sight for Current Token
[h: setHasSight(1)]
Returns: Empty String.


Version Changes

  • 1.5.4 - Added id and mapname parameter options.