getSightType: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page GetSightType to getSightType: Converting page titles to lowercase)
m (Text replacement - "source>" to "syntaxhighlight>")
Line 10: Line 10:
getSightType(id)
getSightType(id)
getSightType(id, mapname)
getSightType(id, mapname)
</source>
</syntaxhighlight>


'''Parameters'''
'''Parameters'''

Revision as of 18:47, 14 March 2023

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

<source lang="mtmacro" line> getSightType() getSightType(id) getSightType(id, mapname) </syntaxhighlight>

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.7.0 - Now returns an empty string when no sight type is set.
  • 1.5.4 - Added id and mapname parameter options.