player.getPlayers

From RPTools Wiki
Jump to navigationJump to search

 Note: This refers to a proposed change that has not been implemented in the main code base yet.

player.getPlayers() Function

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

Introduced in version 1.10.0
Last checked for compatibility with version 1.10.0
Returns information about all players in the Player Database as an array of JSON objects.

Usage

player.getPlayers() - Get info on all players.

Parameters

  • none - none

Example

Outputs all players in database.
<pre>[r: json.indent(player.getPlayers(),2)]</pre>

Returns:

[
    {
    "name": "George",
    "role": "PLAYER",
    "connected": false
  },
    {
    "name": "Player",
    "role": "PLAYER",
    "connected": true
  },
    {
    "name": "Ringo",
    "role": "PLAYER",
    "connected": false
  },
    {
    "name": "GM",
    "role": "GM",
    "connected": true
  },
    {
    "name": "John",
    "role": "PLAYER",
    "connected": false
  },
    {
    "name": "Paul",
    "role": "PLAYER",
    "connected": false
  }
]

See Also

Version Changes

  • 1.10.0 - First added.