Players

These APIs allow you to interface with Players in the game.

Global Methods

Players.GetJoined(): PlayerClient[]

Returns an array of all players that are currently connected to the server.

Players.GetRandom(): PlayerClient

Returns a random player that is currently connected to the server.

Players.GetCount(): number

Returns the number of players that are currently connected to the server.

Players.LocalClient(): PlayerClient

Returns the local player client.

Players.LocalPlayer(): NetPlayer

Returns the local player.

Players.SetTagsEnabled(enabled: boolean)

Enables or disables nametags / health bars for all players.

Players.AreTagsEnabled(): boolean

Returns whether nametags / health bars are enabled for all players.