getVisible: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Macros:Functions:getVisible moved to getVisible) |
Verisimilar (talk | contribs) m (Added version, cleaned up formatting.) |
||
| Line 1: | Line 1: | ||
{{stub}} | |||
{{MacroFunction | {{MacroFunction | ||
|name=getVisible | |name=getVisible | ||
|trusted=true | |trusted=true | ||
|version=1.3b40 | |||
|description= | |description= | ||
Returns {{code|1}} if the [[Token:visible to players|visible to players]] flag is set on the [[Token:Current Token|Current Token]] otherwise returns {{code|0}}. The [[Token:visible to players|visible to players]] flag has two meanings, on a normal [[Token:Token|Token]] players will only be able to see the [[Token:Token|Token]] if it is set (when all other things like [[Map:Fog of War|Fog of War]] etc are taken into account). If it is a [[Token:LibToken|LibToken]] then it determines if players can call [[Macro:Macros|Macros]] using [[Macro:Roll:macro | [macro(...): ...] ]]. | Returns {{code|1}} if the [[Token:visible to players|visible to players]] flag is set on the [[Token:Current Token|Current Token]] otherwise returns {{code|0}}. The [[Token:visible to players|visible to players]] flag has two meanings, on a normal [[Token:Token|Token]] players will only be able to see the [[Token:Token|Token]] if it is set (when all other things like [[Map:Fog of War|Fog of War]] etc are taken into account). If it is a [[Token:LibToken|LibToken]] then it determines if players can call [[Macro:Macros|Macros]] using [[Macro:Roll:macro | [macro(...): ...] ]]. | ||
| Line 7: | Line 9: | ||
|usage= | |usage= | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
getVisible() | |||
</source> | </source> | ||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Revision as of 09:44, 10 March 2009
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
getVisible() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.3b40
Returns
1 if the visible to players flag is set on the Current Token otherwise returns 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 LibToken then it determines if players can call Macros using [macro(...): ...] .Usage
getVisible()