getTablePicksLeft

From RPTools Wiki
Revision as of 19:01, 14 March 2023 by Taustin (talk | contribs) (Text replacement - "<source" to "<syntaxhighlight")
Jump to navigation Jump to search

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