@tmrw-realityos/world • Docs

---

@tmrw-realityos/world / Components / WalkableArea

Class: WalkableArea

Walkable area component.

Extends

• BaseComponent

Constructors

new WalkableArea()

new WalkableArea(): WalkableArea

Returns

WalkableArea

Overrides

BaseComponent.constructor

Defined in

world/components/walkableArea.ts:141

Properties

areas

areas: wArea[] = []

Defined in

world/components/walkableArea.ts:139

---

enabled

enabled: boolean = true

Inherited from

BaseComponent.enabled

Defined in

world/components.ts:7

---

last_area_id

last_area_id: number = 1

Defined in

world/components/walkableArea.ts:138

---

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

---

uid

uid: string = ""

Inherited from

BaseComponent.uid

Defined in

world/components.ts:9

---

compName

static compName: string = "WalkableArea"

Overrides

BaseComponent.compName

Defined in

world/components/walkableArea.ts:136

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

addArea()

addArea(area?): number

Parameters

• area?: wArea

Returns

number

Defined in

world/components/walkableArea.ts:145

---

adjustCamera()

adjustCamera(camera, height): void

Parameters

• camera: Camera

• height: number

Returns

void

Defined in

world/components/walkableArea.ts:288

---

adjustNode()

adjustNode(node, height): void

Parameters

• node: Node

• height: number

Returns

void

Defined in

world/components/walkableArea.ts:275

---

adjustPosition()

adjustPosition(pos, height, removeHeight): undefined | vec3

Parameters

• pos: vec3

• height: number = 0

• removeHeight: number = 0

Returns

undefined | vec3

Defined in

world/components/walkableArea.ts:204

---

configure()

configure(o): void

Parameters

• o: WalkableAreaDescriptor

Returns

void

Overrides

BaseComponent.configure

Defined in

world/components/walkableArea.ts:297

---

findArea()

findArea(pos): undefined | wArea

Parameters

• pos: vec3

Returns

undefined | wArea

Defined in

world/components/walkableArea.ts:183

---

getCompName()

getCompName(): string

Returns

string

Inherited from

BaseComponent.getCompName

Defined in

world/components.ts:11

---

onAdded()?

optional onAdded(): void

Returns

void

Inherited from

BaseComponent.onAdded

Defined in

world/components.ts:21

---

onClick()?

optional onClick(): void

Returns

void

Inherited from

BaseComponent.onClick

Defined in

world/components.ts:19

---

onRemoved()?

optional onRemoved(): void

Returns

void

Inherited from

BaseComponent.onRemoved

Defined in

world/components.ts:22

---

onUpdate()?

optional onUpdate(dt): void

Parameters

• dt: number

Returns

void

Inherited from

BaseComponent.onUpdate

Defined in

world/components.ts:20

---

removeArea()

removeArea(index): void

Parameters

• index: number

Returns

void

Defined in

world/components/walkableArea.ts:172

---

serialize()

serialize(): void

Returns

void

Inherited from

BaseComponent.serialize

Defined in

world/components.ts:17