getSightType: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Unifying Current Token red link.) |
No edit summary |
||
| (10 intermediate revisions by 4 users not shown) | |||
| Line 3: | Line 3: | ||
|version=1.3b48 | |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() | ||
</ | getSightType(tokenRef) | ||
getSightType(tokenRef, mapRef) | |||
</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|mapRef|The Name or ID 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:Sight Function]] | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Latest revision as of 23:59, 13 May 2024
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(tokenRef)
getSightType(tokenRef, mapRef)Parameters
tokenRef- Either the tokenidor 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.
mapRef- The Name or ID 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.
Version Changes
- 1.7.0 - Now returns an empty string when no sight type is set.
- 1.5.4 - Added
idandmapnameparameter options.