setHasSight: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 7: | Line 7: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
setHasSight(state) | setHasSight(state) | ||
</ | setHasSight(state, id) | ||
setHasSight(state, id, mapRef) | |||
</syntaxhighlight> | |||
'''Parameters''' | '''Parameters''' | ||
{{param|state|Boolean - true to enable sight, false to disable }} | {{param|state|Boolean - true to enable sight, false to disable }} | ||
{{param|id|The {{code|id}} of the token to set the sight of. Defaults to the [[Current Token]]. {{TrustedParameter}} }} | |||
{{param|mapRef|The Name or ID of the map to find the token. Defaults to the current map.}} | |||
|example= | |example= | ||
Enables sight for [[Current Token]] | Enables sight for [[Current Token]] | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: setHasSight(1)] | [h: setHasSight(1)] | ||
</ | </syntaxhighlight> | ||
Returns: Empty String. | Returns: Empty String. | ||
|changes= | |||
{{change|1.5.4|Added {{code|id}} and {{code|mapname}} parameter options.}} | |||
}} | }} | ||
[[Category:Sight Function]] | [[Category:Sight Function]] | ||
Latest revision as of 23:59, 14 March 2023
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 disableid- Theidof 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
Returns: Empty String.
[h: setHasSight(1)]
Version Changes
- 1.5.4 - Added
idandmapnameparameter options.