getAllPlayerNames: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Text replacement - "source>" to "syntaxhighlight>")
m (Text replacement - "<source" to "<syntaxhighlight")
Line 6: Line 6:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getAllPlayerNames()
getAllPlayerNames()
getAllPlayerNames(delim)
getAllPlayerNames(delim)
Line 15: Line 15:
|example=
|example=
You can use the following code to print the names of all of the players that are connected.
You can use the following code to print the names of all of the players that are connected.
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
Players Connected<br>
Players Connected<br>
[h: players = getAllPlayerNames()]
[h: players = getAllPlayerNames()]

Revision as of 19:36, 14 March 2023

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]