getSightType: Difference between revisions

Latest revision as of 20:56, 13 May 2024

• 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.

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.

@@ Line 1: / Line 1: @@
-==Function getSightType==
+{{MacroFunction
-{{ProposedChange}}
+|name=getSightType
-Returns the type of [[Token:sight|sight]] that the current [[Token:token|token]] has.
+|version=1.3b48
+|description=
+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>
-[h: macros = getSightType()]
+getSightType()
-</source>
+getSightType(tokenRef)
+getSightType(tokenRef, mapname)
+</syntaxhighlight>
+'''Parameters'''
+{{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.}}
+{{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=
+{{change|1.7.0|Now returns an empty string when no sight type is set.}}
+{{change|1.5.4|Added {{code|id}} and {{code|mapname}} parameter options.}}
+}}
+[[Category:Sight Function]]
+[[Category:Token Function]]