getAllPlayerNames

From RPTools Wiki
Revision as of 23:59, 14 March 2023 by Taustin (talk | contribs) (Text replacement - "<source" to "<syntaxhighlight")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

getAllPlayerNames() Function

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

Introduced in version 1.3b48
Gets a string list containing the names of all the players that are connected.

Usage

getAllPlayerNames()
getAllPlayerNames(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.

Example

You can use the following code to print the names of all of the players that are connected.
Players Connected<br>
[h: players = getAllPlayerNames()]
[foreach(name, players, "<br>"): name]