setVisible

From RPTools Wiki
(Redirected from SetVisible)
Jump to navigation Jump to search

 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.

setVisible() Function

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

Introduced in version 1.3b40
Sets the Visible to Players flag on a Token if the value passed in is non-zero(true(1)), otherwise resets it to 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 Category:Macros using the [macro(...): ...] roll option.

Usage

setVisible(visible)
setVisible(visible, id)

Parameters

  • visible - The state of visibility, true(1) or false(0).
  • id - The token id of the token which has its player visibility set, defaults to the Current Token.


See Also

Version Changes

  • 1.3b51 - Added id parameter option.