getSightType: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) (Applied Template:MacroFunction) |
No edit summary |
||
(11 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
{{MacroFunction | {{MacroFunction | ||
|name=getSightType | |name=getSightType | ||
|version=1.3b48 | |||
|description= | |description= | ||
Returns the type of [[ | 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= | ||
< | <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:Sight Function]] | ||
[[Category:Token Function]] | [[Category:Token Function]] |
Revision as of 18:26, 25 April 2023
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(id)
getSightType(id, mapname)
Parameters
id
- Theid
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.
Version Changes
- 1.7.0 - Now returns an empty string when no sight type is set.
- 1.5.4 - Added
id
andmapname
parameter options.