Interface IPlayer

Define Player interface.

interface IPlayer {
    avatar?: IAvatar;
    collision: null | CollisionComponent;
    isDisposed: boolean;
    isVisible: boolean;
    nameTag?: INameTag;
    network?: INetwork;
    profile?: IPlayerProfile;
    fire<T>(event: T, ...args?: any[]): EventHandler;
    off<T>(event: T, listener: IPlayerEvents[T]): EventHandler;
    on<T>(event: T, listener: IPlayerEvents[T]): EventHandle;
}

Hierarchy (view full)

Properties

avatar? collision isDisposed isVisible nameTag? network? profile?

Methods

fire off on

Properties

Optional Readonlyavatar

avatar?: IAvatar

Get the player's avatar information.

Readonly Plannedcollision

collision: null | CollisionComponent

Player's collision, default collision type is capsule.

Readonly PlannedisDisposed

isDisposed: boolean

Get the status that whether the Player has disconnected from the server.

PlannedisVisible

isVisible: boolean

Whether the player is visible on the local client.

Optional ReadonlynameTag

nameTag?: INameTag

Get the player's name tag.

Optional Readonlynetwork

network?: INetwork

Get the player's server connection information.

Optional Readonlyprofile

profile?: IPlayerProfile

Get the player's profile information.

Methods

fire

  • fire<T>(event, ...args?): EventHandler

  • Send a specific event.

    Type Parameters

    Parameters

    • event: T

      Event name

    • Optional Rest...args: any[]

      Event parameters

    Returns EventHandler

off

  • off<T>(event, listener): EventHandler

  • Unsubscribe from a specific event.

    Type Parameters

    Parameters

    Returns EventHandler

on

  • on<T>(event, listener): EventHandle

  • Subscribe to a specific event.

    Type Parameters

    Parameters

    Returns EventHandle

Settings

Member Visibility

On This Page

Properties
Methods