Class PlayerService

Define PlayerService interface.

Implements

IPlayerService

Index

Constructors

Accessors

localPlayer playerCount remotePlayers

Methods

checkIsLocalPlayerEntity checkIsRemotePlayerEntity fire getPlayerByEntity getPlayerById off on

Constructors

constructor

new PlayerService(): PlayerService
Returns PlayerService
- Defined in services/player/PlayerService.ts:8

Accessors

localPlayer

get localPlayer(): null | ILocalPlayer
Returns null | ILocalPlayer
Implementation of IPlayerService.localPlayer
- Defined in services/player/PlayerService.ts:16

playerCount

get playerCount(): number
Get the number of players currently connected in the room.

Returns number
Implementation of IPlayerService.playerCount
- Defined in services/player/PlayerService.ts:27

remotePlayers

get remotePlayers(): IRemotePlayer[]
Returns IRemotePlayer[]
Implementation of IPlayerService.remotePlayers
- Defined in services/player/PlayerService.ts:23

Methods

checkIsLocalPlayerEntity

checkIsLocalPlayerEntity(entity, recursive?): boolean
Check if the Entity is the LocalPlayer.
Parameters
- entity: Entity
  Entity
- Optionalrecursive: boolean
  Recursively check if the parent of the incoming entity is the player, default is false.
Returns boolean
Implementation of IPlayerService.checkIsLocalPlayerEntity
- Defined in services/player/PlayerService.ts:42

checkIsRemotePlayerEntity

checkIsRemotePlayerEntity(entity, recursive?): boolean
Check if the Entity is the RemotePlayer.
Parameters
- entity: Entity
  Entity
- Optionalrecursive: boolean
  Recursively check if the parent of the incoming entity is the player, default is false.
Returns boolean
Implementation of IPlayerService.checkIsRemotePlayerEntity
- Defined in services/player/PlayerService.ts:46

fire

fire<T>(event, ...args): EventHandler
Send a specific event.
Type Parameters
- T extends keyof IPlayerServiceEvents
Parameters
- event: T
  Event name
- Rest...args: any[]
  Event parameters
Returns EventHandler
Implementation of IPlayerService.fire
- Defined in services/player/PlayerService.ts:64

getPlayerByEntity

getPlayerByEntity(entity, recursive?): null | ILocalPlayer | IRemotePlayer
Retrieve player information using Entity.
Parameters
- entity: Entity
  Player's Entity.
- Optionalrecursive: boolean
  Whether to allow the incoming entity to be a child node of the player, default is false.
Returns null | ILocalPlayer | IRemotePlayer
Implementation of IPlayerService.getPlayerByEntity
- Defined in services/player/PlayerService.ts:35

getPlayerById

getPlayerById(id): null | ILocalPlayer | IRemotePlayer
Retrieve player information using Network ID.
Parameters
- id: string
  Player's Network ID.
Returns null | ILocalPlayer | IRemotePlayer
Implementation of IPlayerService.getPlayerById
- Defined in services/player/PlayerService.ts:31

off

off<T>(event, listener): EventHandler
Unsubscribe from a specific event.
Type Parameters
- T extends keyof IPlayerServiceEvents
Parameters
- event: T
  Event name.
- listener: IPlayerServiceEvents[T]
  Callback function.
Returns EventHandler
Implementation of IPlayerService.off
- Defined in services/player/PlayerService.ts:57

on

on<T>(event, listener): EventHandle
Subscribe to a specific event.
Type Parameters
- T extends keyof IPlayerServiceEvents
Parameters
- event: T
  Event name.
- listener: IPlayerServiceEvents[T]
  Callback function.
Returns EventHandle
Implementation of IPlayerService.on
- Defined in services/player/PlayerService.ts:50