setTableAccess: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created page with "{{MacroFunction |name=setTableAccess |version=1.4.0.1 |description= Sets whether or not the specified table is accessible to players. May only be used by GM or a trusted macro...")
 
No edit summary
 
(6 intermediate revisions by 3 users not shown)
Line 2: Line 2:
|name=setTableAccess
|name=setTableAccess
|version=1.4.0.1
|version=1.4.0.1
|trusted=true
|description=
|description=
Sets whether or not the specified table is accessible to players. May only be used by GM or a trusted macro.
Sets whether or not the specified table is accessible to players.
|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
setTableAccess(tableName, visible)
setTableAccess(tableName, accessible)
</source>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{param|tableName|A string containing the name of the Table.}}
{{param|tableName|A string containing the name of the Table.}}
{{param|visible|Whether or not the table can be accessed by players in the Table Window, {{true}} or {{false}}.}}
{{param|accessible|Whether or not the table can be accessed by players in the Table Window, {{true}} or {{false}}.}}
|examples=
|examples=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h:setTableAccess("randomMonsters", 0)]
[h:setTableAccess("randomMonsters", 0)]
</source>
</syntaxhighlight>
|also=
|also=
[[table (function)|table()]]
{{func|getTableAccess}} {{func|getTableVisible}} {{func|setTableVisible}}
}}
}}
[[Category:Table Function]]
[[Category:Table Function]]

Latest revision as of 23:59, 14 March 2023

setTableAccess() Function

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

Introduced in version 1.4.0.1
Sets whether or not the specified table is accessible to players.

Usage

setTableAccess(tableName, accessible)

Parameters

  • tableName - A string containing the name of the Table.
  • accessible - Whether or not the table can be accessed by players in the Table Window, true(1) or false(0).

Examples

[h:setTableAccess("randomMonsters", 0)]

See Also