getTableNames: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{MacroFunction |name=getTableNames |version=1.4.0.1 |description=Returns a list containing the names of the tables in the campaign. The type of the value returned depends on...") |
m (Text replacement - "<source" to "<syntaxhighlight") |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 3: | Line 3: | ||
|version=1.4.0.1 | |version=1.4.0.1 | ||
|description=Returns a list containing the names of the tables in the campaign. The type of the value returned depends on the delimiter parameter. The function can be used by players or from a non-trusted macro, but it will only return player-visible tables. When used by a GM or a trusted macro it returns all tables. | |description=Returns a list containing the names of the tables in the campaign. The type of the value returned depends on the delimiter parameter. The function can be used by players or from a non-trusted macro, but it will only return player-visible tables. When used by a GM or a trusted macro it returns all tables. | ||
|usage= | |||
<syntaxhighlight lang="mtmacro" line> | |||
getTableNames() | |||
getTableNames(delim) | |||
</syntaxhighlight> | |||
If {{code|delim}} is specified then it is used to separate the values in the list; if it is not specified then it defaults to "{{code|,}}". When {{code|delim}} is the string "{{code|json}}" the return value will be in the form of a [[JSON Array]]. | |||
|examples= | |||
<syntaxhighlight lang="mtmacro" line> | |||
[r:getTableNames()] | |||
[r:getTableNames("<br>")] | |||
[r:getTableNames("json")] | |||
</syntaxhighlight> | |||
|also= | |also= | ||
[[Table|Table]], [[table (function)|table()]] | [[Table|Table]], [[table (function)|table()]] | ||
}} | }} | ||
[[Category:Table Function]] | [[Category:Table Function]] | ||
Latest revision as of 23:59, 14 March 2023
getTableNames() Function
• Introduced in version 1.4.0.1
Returns a list containing the names of the tables in the campaign. The type of the value returned depends on the delimiter parameter. The function can be used by players or from a non-trusted macro, but it will only return player-visible tables. When used by a GM or a trusted macro it returns all tables.
Usage
getTableNames()
getTableNames(delim)If delim is specified then it is used to separate the values in the list; if it is not specified then it defaults to ",". When delim is the string "json" the return value will be in the form of a JSON Array.
Examples
[r:getTableNames()]
[r:getTableNames("<br>")]
[r:getTableNames("json")]