Skip to content

Players

Players is the container class for all Player instances.

Inherits: Instance

Properties

  • LocalPlayer: Player
  • PlayerCollisionEnabled: boolean
  • PlayersCount: number

Methods

GetPlayers() → { Player }

Returns a table containing all the players currently in the game.

GetPlayer(username: string) → Player

Returns the player with the specified username.

GetPlayerByID(userID: number) → Player

Returns the player with the specified user ID.

Events

  • PlayerAdded: Fires when player has connected
  • PlayerRemoved: Fires when player has disconnected