getSightType: Difference between revisions

Latest revision as of 18:26, 25 April 2023

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

@@ 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
-<source lang="mtmacro" line>
+|description=
-[h: macros = getSightType()]
+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.
-</source>
+|usage=
+<syntaxhighlight lang="mtmacro" line>
+getSightType()
+getSightType(id)
+getSightType(id, mapname)
+</syntaxhighlight>
+'''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.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]]