setOwnerOnlyVisible: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(6 intermediate revisions by 4 users not shown)
Line 5: Line 5:
|version=1.3b74
|version=1.3b74
|description=
|description=
Sets the [[Visible to Owners Only]] flag on a [[Token]] if the value passed in is non-zero({{true}}), otherwise resets it to {{false}}.  
Sets the [[Introduction to Tokens#Visible to Owners Only|Visible to Owners Only]] flag on a [[Token]] if the value passed in is non-zero({{true}}), otherwise resets it to {{false}}.  


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
setOwnerOnlyVisible(visible)
setOwnerOnlyVisible(visible)
</source>
</syntaxhighlight>
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
setOwnerOnlyVisiblee(visible, id)
setOwnerOnlyVisible(visible, id)
</source>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{param|visible|The state of owner only visibility, {{true}} or {{false}}.}}
{{param|visible|The state of owner only visibility, {{true}} or {{false}}.}}
Line 19: Line 19:


|also=
|also=
[[getVisible|getVisible()]], [[getOwnerOnlyVisible|getOwnerOnlyVisible()]]
[[setVisible|setVisible()]], [[getOwnerOnlyVisible|getOwnerOnlyVisible()]]
 
|changes=
{{change|1.3b51|Added {{code|id}} parameter option.}}


}}
}}
[[Category:Token Function]]
[[Category:Token Function]]

Latest revision as of 23:59, 14 March 2023

 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.

setOwnerOnlyVisible() Function

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

Introduced in version 1.3b74
Sets the Visible to Owners Only flag on a Token if the value passed in is non-zero(true(1)), otherwise resets it to false(0).

Usage

setOwnerOnlyVisible(visible)
setOwnerOnlyVisible(visible, id)

Parameters

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


See Also