getSightType: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page getSightType to GetSightType without leaving a redirect: Converting page title to first-letter uppercase)
No edit summary
(3 intermediate revisions by 2 users not shown)
Line 3: Line 3:
|version=1.3b48
|version=1.3b48
|description=
|description=
Returns the type of [[Token:sight|sight]] that the [[Current Token]] has. When no sight type is set, returns an empty string.
Returns the type of [[Introduction to Tokens#Has Sight|sight]] that the [[Current Token]] has. When no sight type is set, returns an empty string.


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


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

Revision as of 18:26, 25 April 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

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