setSightType: Difference between revisions

Latest revision as of 23:59, 27 April 2023

This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.

• Introduced in version 1.3b48

Sets the type of sight that the Current Token has.

setSightType(type)
setSightType(type, id)
setSightType(type, id, mapRef)

Parameters

type - The type of sight to set.
id - The id of the token to set the sight. Defaults to the Current Token.
Note: This parameter can only be used in a Trusted Macro.
mapRef - The Name or ID of the map to find the token. Defaults to the current map.

@@ Line 1: / Line 1: @@
-==Function setSightType==
+{{stub}}
+{{MacroFunction
+|name=setSightType
+|version=1.3b48
+|description=
+Sets the type of [[Introduction to Tokens#Has Sight|sight]] that the [[Current Token]] has.
-Sets the type of [[Token:sight|sight]] that the [[Token:Current Token|Current Token]] has.
+|usage=
+<syntaxhighlight lang="mtmacro" line>
+setSightType(type)
+setSightType(type, id)
+setSightType(type, id, mapRef)
+</syntaxhighlight>
-===Usage===
+'''Parameters'''
-<source lang="mtmacro" line>
+{{param|type|The type of sight to set.}}
-[h: macros = setSightType()]
+{{param|id|The {{code|id}} of the token to set the [[Introduction to Lights and Sights#Sight Types|sight]].  Defaults to the [[Current Token]]. {{TrustedParameter}} }}
-</source>
+{{param|mapRef|The Name or ID of the map to find the token.  Defaults to the current map.}}
+|changes=
+{{change|1.5.4|Added {{code|id}} and {{code|mapname}} parameter options.}}
+}}
+[[Category:Sight Function]]
+[[Category:Token Function]]