getVisible: Difference between revisions

Revision as of 04:16, 8 March 2009

Note: This function can only be used in a Trusted Macro

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(...): ...] .

[h: isVis2Players = getVisible()]

@@ Line 1: / Line 1: @@
-==Function getVisible==
+{{MacroFunction
-{{TrustedOnlyFunction}}
+|name=getVisible
-Returns 1 if the [[Token:visible to players|visible to players]] flag is set on the [[Token:Current Token|Current Token]] otherwise returns 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(...): ...] ]].
+|trusted=true
+|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(...): ...] ]].
-===Usage===
+|usage=
 <source lang="mtmacro" line>
 [h: isVis2Players = getVisible()]
 </source>
+}}
+[[Category:Token Function]]