RealityOS Docs and Examples

Appearance

@tmrw-realityos/world • Docs

@tmrw-realityos/world / Components / Avatar

Class: Avatar ​

Avatar component

Extends ​

Constructors ​

new Avatar() ​

new Avatar(): Avatar

Returns ​

Avatar

Overrides ​

BaseComponent.constructor

Defined in ​

world/components/avatar.ts:34

Properties ​

enabled ​

enabled: boolean = true

Overrides ​

BaseComponent.enabled

Defined in ​

world/components/avatar.ts:21

feedURL ​

feedURL: string = ""

Defined in ​

world/components/avatar.ts:28

height ​

height: number = 1

Defined in ​

world/components/avatar.ts:22

material ​

material: Material

Defined in ​

world/components/avatar.ts:26

mustSave ​

mustSave: boolean = true

Inherited from ​

BaseComponent.mustSave

Defined in ​

world/components.ts:8

parent? ​

optional parent: ComponentsContainer

Inherited from ​

BaseComponent.parent

Defined in ​

world/components.ts:14

plane ​

plane: Node

Defined in ​

world/components/avatar.ts:25

profileURL ​

profileURL: string = ""

Defined in ​

world/components/avatar.ts:29

size ​

size: number = 0.25

Defined in ​

world/components/avatar.ts:23

uid ​

uid: string = ""

Inherited from ​

BaseComponent.uid

Defined in ​

world/components.ts:9

user? ​

optional user: Entity = undefined

Defined in ​

world/components/avatar.ts:30

compName ​

static compName: string = "Avatar"

Overrides ​

BaseComponent.compName

Defined in ​

world/components/avatar.ts:19

emissiveFactor ​

static emissiveFactor: vec3

Defined in ​

world/components/avatar.ts:32

Accessors ​

entity ​

get entity(): undefined | Entity

set entity(_v): void

Parameters ​

• _v: Entity

Returns ​

undefined | Entity

Inherited from ​

BaseComponent.entity

Defined in ​

world/components.ts:24

Methods ​

configure() ​

configure(): void

Returns ​

void

Overrides ​

BaseComponent.configure

Defined in ​

world/components/avatar.ts:114

getCompName() ​

getCompName(): string

Returns ​

string

Inherited from ​

BaseComponent.getCompName

Defined in ​

world/components.ts:11

onAdded() ​

onAdded(): void

Returns ​

void

Overrides ​

BaseComponent.onAdded

Defined in ​

world/components/avatar.ts:49

onClick()? ​

optional onClick(): void

Returns ​

void

Inherited from ​

BaseComponent.onClick

Defined in ​

world/components.ts:19

onRemoved() ​

onRemoved(): void

Returns ​

void

Overrides ​

BaseComponent.onRemoved

Defined in ​

world/components/avatar.ts:53

onUpdate()? ​

optional onUpdate(dt): void

Parameters ​

• dt: number

Returns ​

void

Inherited from ​

BaseComponent.onUpdate

Defined in ​

world/components.ts:20

preRender() ​

preRender(cam): void

Parameters ​

• cam: Camera

Returns ​

void

Defined in ​

world/components/avatar.ts:57

serialize() ​

serialize(): void

Returns ​

void

Inherited from ​

BaseComponent.serialize

Defined in ​

world/components.ts:17

setEmissiveFactor() ​

static setEmissiveFactor(v): void

Parameters ​

• v: number | vec3

Returns ​

void

Defined in ​

world/components/avatar.ts:116