getSightType: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Text replacement - "source>" to "syntaxhighlight>")
No edit summary
 
(2 intermediate revisions by the same user 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(tokenRef)
getSightType(id, mapname)
getSightType(tokenRef, mapname)
</syntaxhighlight>
</syntaxhighlight>


'''Parameters'''
'''Parameters'''
{{param|id|The {{code|id}} of the token to have the [[State]] set.  Defaults to the [[Current Token]]. {{TrustedParameter}} }}
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token to have the Sight type listed.  Defaults to the [[Current Token]]. {{TrustedParameter}} }}
{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
{{Note|Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.}}


|changes=
|changes=

Latest revision as of 20:56, 13 May 2024

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(tokenRef)
getSightType(tokenRef, mapname)

Parameters

  • tokenRef - Either the token id or Token Name of the token to have the Sight type listed. 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.
Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.


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.