getAllPlayerNames: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "<source" to "<syntaxhighlight") |
|||
| (7 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
== | {{MacroFunction | ||
|name=getAllPlayerNames | |||
|trusted=true | |||
|version=1.3b48 | |||
|description=Gets a [[Macros:string list|string list]] containing the names of all the players that are connected. | |||
|usage= | |||
<syntaxhighlight lang="mtmacro" line> | |||
getAllPlayerNames() | |||
getAllPlayerNames(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]]. | |||
[ | |||
|example= | |||
You can use the following code to print the names of all of the players that are connected. | |||
<syntaxhighlight lang="mtmacro" line> | |||
You can use the following code to print | |||
< | |||
Players Connected<br> | Players Connected<br> | ||
[h: players = getAllPlayerNames()] | [h: players = getAllPlayerNames()] | ||
[foreach(name, players, "<br>"): name] | [foreach(name, players, "<br>"): name] | ||
</ | </syntaxhighlight> | ||
}} | |||
[[Category:Miscellaneous Function]] | |||
Latest 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]