getVisible: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
==Function getVisible==
==Function getVisible==
{{TrustedOnlyFunction}}
{{TrustedOnlyFunction}}
Returns 1 if the [[Token:visible to players|visible to players]] flag is set on the [[Token:Current Token|Current Token]] otherwise returns 0.
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(...): ...] ]].


===Usage===
===Usage===

Revision as of 08:59, 14 December 2008

Function getVisible

This function can only be called from 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(...): ...] .

Usage

[h: isVis2Players = getVisible()]