getTablePicksLeft: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page GetTablePicksLeft to getTablePicksLeft: Converting page titles to lowercase)
m (Text replacement - "<source" to "<syntaxhighlight")
Line 6: Line 6:
Returns the number of ''picks'', i.e. entries, in a table that have not been chosen.  The individual entries in a ''Pick Once'' table can only be randomly chosen once until the table is reset.
Returns the number of ''picks'', i.e. entries, in a table that have not been chosen.  The individual entries in a ''Pick Once'' table can only be randomly chosen once until the table is reset.
|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getTablePicksLeft(tableName)
getTablePicksLeft(tableName)
</source>
</source>
Line 12: Line 12:
{{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:getTablePicksLeft("Poker Deck")]
[r:getTablePicksLeft("Poker Deck")]
</source>
</source>

Revision as of 19:01, 14 March 2023

getTablePicksLeft() Function

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

Introduced in version 1.6.0
Returns the number of picks, i.e. entries, in a table that have not been chosen. The individual entries in a Pick Once table can only be randomly chosen once until the table is reset.

Usage

<syntaxhighlight lang="mtmacro" line> getTablePicksLeft(tableName) </source> Parameters

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

Examples

<syntaxhighlight lang="mtmacro" line>

[r:getTablePicksLeft("Poker Deck")] </source>

Result: Returns the number of entries in the table that have not been chosen.

See Also