Interface IPlayerService

Define PlayerService interface.

interface IPlayerService {
    localPlayer: null | ILocalPlayer;
    playerCount: number;
    remotePlayers: IRemotePlayer[];
    checkIsLocalPlayerEntity(entity: Entity, recursive?: boolean): boolean;
    checkIsRemotePlayerEntity(entity: Entity, recursive?: boolean): boolean;
    fire<T>(event: T, ...args?: any[]): EventHandler;
    getPlayerByEntity(entity: Entity, recursive?: boolean): null | ILocalPlayer | IRemotePlayer;
    getPlayerById(id: string): null | ILocalPlayer | IRemotePlayer;
    off<T>(event: T, listener: IPlayerServiceEvents[T]): EventHandler;
    on<T>(event: T, listener: IPlayerServiceEvents[T]): EventHandle;
}

Hierarchy

EventHandlerMethods
- IPlayerService

Implemented by

PlayerService

Index

Properties

localPlayer playerCount remotePlayers

Methods

checkIsLocalPlayerEntity checkIsRemotePlayerEntity fire getPlayerByEntity getPlayerById off on

Properties

`Readonly`localPlayer

localPlayer: null | ILocalPlayer

Get local player information.

`Readonly`playerCount

playerCount: number

Get the number of players currently connected in the room.

`Readonly`remotePlayers

remotePlayers: IRemotePlayer[]

Get the information of all remote players in the room.

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
- Defined in services/player/interface/IPlayerService.ts:48

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
- Defined in services/player/interface/IPlayerService.ts:56

fire

fire<T>(event, ...args?): EventHandler
Send a specific event.
Type Parameters
- T extends keyof IPlayerServiceEvents
Parameters
- event: T
  Event name
- Optional Rest...args: any[]
  Event parameters
Returns EventHandler
Overrides EventHandlerMethods.fire
- Defined in services/player/interface/IPlayerService.ts:83

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
- Defined in services/player/interface/IPlayerService.ts:37

getPlayerById

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

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
Overrides EventHandlerMethods.off
- Defined in services/player/interface/IPlayerService.ts:73

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
Overrides EventHandlerMethods.on
- Defined in services/player/interface/IPlayerService.ts:63