getSightType: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Unifying Current Token red link.)
No edit summary
Line 8: Line 8:
<source lang="mtmacro" line>
<source lang="mtmacro" line>
getSightType()
getSightType()
getSightType(id)
getSightType(mapname)
</source>
</source>
'''Parameters'''
{{param|id|The {{code|id}} of the token to have the [[State]] set.  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.5.4|Added {{code|id}} and {{code|mapname}} parameter options.}}
}}
}}
[[Category:Sight Function]]
[[Category:Sight Function]]
[[Category:Token Function]]
[[Category:Token Function]]

Revision as of 08:36, 18 August 2019

getSightType() Function

Introduced in version 1.3b48
Returns the type of sight that the Current Token has.

Usage

getSightType()
getSightType(id)
getSightType(mapname)

Parameters

  • id - The id of the token to have the State set. 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.5.4 - Added id and mapname parameter options.