setSightType: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(7 intermediate revisions by 3 users not shown)
Line 4: Line 4:
|version=1.3b48
|version=1.3b48
|description=
|description=
Sets the type of [[Token:sight|sight]] that the [[Current Token]] has.
Sets the type of [[Introduction to Tokens#Has Sight|sight]] that the [[Current Token]] has.


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


'''Parameters'''
'''Parameters'''
{{param|type|The type of sight to set.}}
{{param|type|The type of sight to set.}}
{{param|id|The {{code|id}} of the token to set the [[Token:sight|sight]].  Defaults to the [[Current Token]]. {{TrustedParameter}} }}
{{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}} }}
{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
{{param|mapRef|The Name or ID of the map to find the token.  Defaults to the current map.}}




Line 24: Line 24:
}}
}}
[[Category:Sight Function]]
[[Category:Sight Function]]
[[Category:Token Function]]

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.

setSightType() Function

Introduced in version 1.3b48
Sets the type of sight that the Current Token has.

Usage

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.


Version Changes

  • 1.5.4 - Added id and mapname parameter options.