Interface IAvatar

Define Avatar interface.

interface IAvatar {
    avatarUrl: string;
    boundingBox: null | BoundingBox;
    dataType: DataTypes;
    gender: GenderTypes;
    transform?: IAvatarTransform;
    fire<T>(event: T, ...args?: any[]): EventHandler;
    getBone(boneName: string): null | Entity;
    off<T>(event: T, listener: IAvatarEvents[T]): EventHandler;
    on<T>(event: T, listener: IAvatarEvents[T]): EventHandle;
}

Hierarchy

  • EventHandlerMethods
    • IAvatar

Properties

avatarUrl boundingBox dataType gender transform?

Methods

fire getBone off on

Properties

Readonly PlannedavatarUrl

avatarUrl: string

Get player's avatar model link.

Readonly PlannedboundingBox

boundingBox: null | BoundingBox

Player avatar's BoundingBox.

Readonly PlanneddataType

dataType: DataTypes

Get player's avatar type.

Readonly Plannedgender

gender: GenderTypes

Get player's avatar gender, default: 0.

Optional Readonlytransform

transform?: IAvatarTransform

Get player's avatar position, rotation, and size information.

Methods

fire

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

  • Send a specific event.

    Type Parameters

    • T extends "avatarExistsChanged"

    Parameters

    • event: T

      Event name

    • Optional Rest...args: any[]

      Event parameters

    Returns EventHandler

getBone

  • getBone(boneName): null | Entity

  • Retrieve the Avatar's Bone Entity.

    Parameters

    Returns null | Entity

off

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

  • Unsubscribe from a specific event.

    Type Parameters

    • T extends "avatarExistsChanged"

    Parameters

    Returns EventHandler

on

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

  • Subscribe to a specific event.

    Type Parameters

    • T extends "avatarExistsChanged"

    Parameters

    Returns EventHandle

Settings

Member Visibility

On This Page

Properties
Methods