getTablePickOnce: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created page with "{{MacroFunction |name=getTablePickOnce |version=1.6.0 |trusted=true |description= Returns the {{code|1}} if the specified table is set as ''Pick Once'' and a {{code|0}} if it...")
 
m (Text replacement - "source>" to "syntaxhighlight>")
 
(5 intermediate revisions by 3 users not shown)
Line 4: Line 4:
|trusted=true
|trusted=true
|description=
|description=
Returns the {{code|1}} if the specified table is set as ''Pick Once'' and a {{code|0}} if it isn't.
Returns a {{code|1}} if the specified table has been set as ''Pick Once'' and a {{code|0}} if it hasn't.
|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getTablePickOnce(tableName)
getTablePickOnce(tableName)
</source>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{param|tableName|A string containing the name of the table.}}
{{param|tableName|A string containing the name of the table.}}
|examples=
|examples=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[r:getTableRoll("Poker Deck")]
[r:getTableRoll("Poker Deck")]
**Returns:** Either a {{code|1}} or {{code|0}} if the table is or isn't set as ''Pick Once''.
</syntaxhighlight>
</source>
'''Returns:''' Either a {{code|1}} or {{code|0}} if the table is or isn't set as ''Pick Once''.
|also=
|also=
{{func|setTablePickOnce}}
{{func|setTablePickOnce}}
}}
}}
[[Category:Table Function]]
[[Category:Table Function]]

Latest revision as of 23:59, 14 March 2023

getTablePickOnce() Function

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

Introduced in version 1.6.0
Returns a 1 if the specified table has been set as Pick Once and a 0 if it hasn't.

Usage

getTablePickOnce(tableName)

Parameters

  • tableName - A string containing the name of the table.

Examples

[r:getTableRoll("Poker Deck")]
Returns: Either a 1 or 0 if the table is or isn't set as Pick Once.

See Also