Description
PlayerService is a way you can get Player(s) in game or connect to Player related signals.
Properties
| Type | Key | Default Value |
|---|---|---|
| Player | LocalPlayer | Player |
Methods
| Return Type | Name |
|---|---|
| {Player} | GetPlayers () |
| Player? | GetPlayerByName (playerName: string) |
| Player? | GetPlayerByUserId (userId: number) |
Signals
OnPlayerConnected(player: Player) Fires when a player is connected.
OnPlayerDisconnected(player: Player) Fires when a player is disconnected.
Property Descriptions
Player LocalPlayer = Player
- This the same as
game.Players.LocalPlayer. Only returns player on client side.
Method Descriptions
- Get an array of all in-game players.
Player? GetPlayerByName(playerName: string)
- Find player by user name.
Player? GetPlayerByUserId(userId: number)
- Find player by user id.