hasSight: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Macros:Functions:hasSight moved to hasSight: Moved out of Macros namespace)
No edit summary
(9 intermediate revisions by 6 users not shown)
Line 1: Line 1:
==Function hasSight==
{{stub}}
{{MacroFunction
|name=hasSight
|version=1.3b48
|description=
Returns 1 if the [[Current Token]] has [[Introduction to Tokens#Has Sight|sight]].


Returns 1 if the [[Token:Current Token|Current Token]] has [[Token:sight|sight]].
|usage=
<syntaxhighlight lang="mtmacro" line>
hasSight()
hasSight(id)
hasSight(id, mapname)
</syntaxhighlight>


===Usage===
'''Parameters'''
<source lang="mtmacro" line>
{{param|id|The {{code|id}} of the token to return the sight.  Defaults to the [[Current Token]]. {{TrustedParameter}} }}
[h: sight = hasSight()]
{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
</source>
 
|changes=
{{change|1.5.4|Added {{code|id}} and {{code|mapname}} parameter options.}}
 
}}
[[Category:Sight Function]]

Revision as of 16:02, 15 March 2023

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

hasSight() Function

Introduced in version 1.3b48
Returns 1 if the Current Token has sight.

Usage

hasSight()
hasSight(id)
hasSight(id, mapname)

Parameters

  • id - The id of the token to return the sight. 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.5.4 - Added id and mapname parameter options.