getTableNames: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Text replacement - "source>" to "syntaxhighlight>")
m (Text replacement - "<source" to "<syntaxhighlight")
 
(One intermediate revision by the same user not shown)
Line 5: Line 5:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getTableNames()
getTableNames()
getTableNames(delim)
getTableNames(delim)
Line 12: Line 12:
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]].
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=
|examples=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[r:getTableNames()]
[r:getTableNames()]
[r:getTableNames("<br>")]
[r:getTableNames("<br>")]

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")]

See Also