getVisible: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Added version, cleaned up formatting.) |
No edit summary |
||
| (10 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{stub}} | {{stub|Examples of usage.}} | ||
{{MacroFunction | {{MacroFunction | ||
|name=getVisible | |name=getVisible | ||
|version=1.3b40 | |version=1.3b40 | ||
|description= | |description= | ||
Returns {{ | Returns {{true}} if the [[Introduction_to_Tokens#Visible_to_Players|visible to players]] flag is set on a [[Token]] otherwise returns {{false}}. The [[Introduction to Tokens#Visible to Players|visible to players]] flag has two meanings, on a normal [[Token]] players will only be able to see the [[Token]] if it is set (when all other things like [[Fog of War|Fog of War]] etc are taken into account). If it is a [[Library Token]] then it determines if players can call Macros using {{roll|macro}}. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getVisible() | getVisible() | ||
</ | </syntaxhighlight> | ||
<syntaxhighlight lang="mtmacro" line> | |||
getVisible(id) | |||
</syntaxhighlight> | |||
'''Parameter''' | |||
{{param|id|The token {{code|id}} of token that has its player visibility checked, defaults to the [[Current Token]]. {{TrustedParameter}} }} | |||
|also= | |||
[[setVisible|setVisible()]] | |||
|changes= | |||
{{change|1.3b51|No longer a trusted function, added {{code|id}} parameter option.}} | |||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Latest revision as of 18:44, 20 April 2023
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
This article needs: Examples of usage.
getVisible() Function
• Introduced in version 1.3b40
Returns
true(1) if the visible to players flag is set on a Token otherwise returns false(0). The visible to players flag has two meanings, on a normal Token players will only be able to see the Token if it is set (when all other things like Fog of War etc are taken into account). If it is a Library Token then it determines if players can call Macros using [macro():].Usage
getVisible()getVisible(id)Parameter
id- The tokenidof token that has its player visibility checked, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
See Also
Version Changes
- 1.3b51 - No longer a trusted function, added
idparameter option.