setVisible: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
m (Applied Template:MacroFunction)
Line 1: Line 1:
==Function setVisible==
{{MacroFunction
{{TrustedOnlyFunction}}
|name=setVisible
|trusted=true
|description=
Sets the [[Token:visible to players|visible to players]] flag is set on the [[Token:Current Token|Current Token]] if the value passed in is non zero, otherwise resets it. 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(...): ...] ]].
Sets the [[Token:visible to players|visible to players]] flag is set on the [[Token:Current Token|Current Token]] if the value passed in is non zero, otherwise resets it. 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>
<source lang="mtmacro" line>
[h: getVisible(vis)]
[h: getVisible(vis)]
</source>
</source>
}}
[[Category:Token Function]]

Revision as of 04:43, 9 March 2009

setVisible() Function

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

Sets the visible to players flag is set on the Current Token if the value passed in is non zero, otherwise resets it. 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

[h: getVisible(vis)]