@tmrw-realityos/world

---

@tmrw-realityos/world / Components / WalkableArea

Class: WalkableArea

Defined in: world/components/walkableArea.ts:135

Walkable area component.

Extends

• BaseComponent

Constructors

Constructor

new WalkableArea(): WalkableArea

Defined in: world/components/walkableArea.ts:141

Returns

WalkableArea

Overrides

BaseComponent.constructor

Properties

areas

areas: wArea[] = []

Defined in: world/components/walkableArea.ts:139

---

enabled

enabled: boolean = true

Defined in: world/components.ts:7

Inherited from

BaseComponent.enabled

---

last_area_id

last_area_id: number = 1

Defined in: world/components/walkableArea.ts:138

---

mustSave

mustSave: boolean = true

Defined in: world/components.ts:8

Inherited from

BaseComponent.mustSave

---

parent?

optional parent: ComponentsContainer

Defined in: world/components.ts:14

Inherited from

BaseComponent.parent

---

uid

uid: string = ""

Defined in: world/components.ts:9

Inherited from

BaseComponent.uid

---

compName

static compName: string = "WalkableArea"

Defined in: world/components/walkableArea.ts:136

Overrides

BaseComponent.compName

Accessors

entity

Get Signature

get entity(): undefined | Entity

Defined in: world/components.ts:24

Returns

undefined | Entity

Set Signature

set entity(_v): void

Defined in: world/components.ts:27

Parameters

_v

Entity

Returns

void

Inherited from

BaseComponent.entity

Methods

addArea()

addArea(area?): number

Defined in: world/components/walkableArea.ts:145

Parameters

area?

wArea

Returns

number

---

adjustCamera()

adjustCamera(camera, height): void

Defined in: world/components/walkableArea.ts:288

Parameters

camera

Camera

height

number

Returns

void

---

adjustNode()

adjustNode(node, height): void

Defined in: world/components/walkableArea.ts:275

Parameters

node

Node

height

number

Returns

void

---

adjustPosition()

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

Defined in: world/components/walkableArea.ts:204

Parameters

pos

vec3

height

number = 0

removeHeight

number = 0

Returns

undefined | vec3

---

configure()

configure(o): void

Defined in: world/components/walkableArea.ts:297

Parameters

o

WalkableAreaDescriptor

Returns

void

Overrides

BaseComponent.configure

---

findArea()

findArea(pos): undefined | wArea

Defined in: world/components/walkableArea.ts:183

Parameters

pos

vec3

Returns

undefined | wArea

---

getCompName()

getCompName(): string

Defined in: world/components.ts:11

Returns

string

Inherited from

BaseComponent.getCompName

---

onAdded()?

optional onAdded(): void

Defined in: world/components.ts:21

Returns

void

Inherited from

BaseComponent.onAdded

---

onClick()?

optional onClick(): void

Defined in: world/components.ts:19

Returns

void

Inherited from

BaseComponent.onClick

---

onRemoved()?

optional onRemoved(): void

Defined in: world/components.ts:22

Returns

void

Inherited from

BaseComponent.onRemoved

---

onUpdate()?

optional onUpdate(dt): void

Defined in: world/components.ts:20

Parameters

dt

number

Returns

void

Inherited from

BaseComponent.onUpdate

---

removeArea()

removeArea(index): void

Defined in: world/components/walkableArea.ts:172

Parameters

index

number

Returns

void

---

serialize()

serialize(): void

Defined in: world/components.ts:17

Returns

void

Inherited from

BaseComponent.serialize