LevelComp

Defined in: packages/threeplay/src/plugins/level/types.ts:24

Fields of the level object returned by addLevel(). Tiles are its children, laid on the XZ plane: column → +X, row → +Z.

Extends

• Comp

Methods

add()?

optional add(this): void

Defined in: packages/threeplay/src/core/types.ts:63

Called when the object enters the scene (or when used on a live object).

Parameters

this

GameObj

Returns

void

Inherited from

Comp.add

---

charAt()

charAt(col, row): string

Defined in: packages/threeplay/src/plugins/level/types.ts:39

The map character at a grid cell, as written in the map (" " outside).

Parameters

col

number

row

number

Returns

string

---

destroy()?

optional destroy(this): void

Defined in: packages/threeplay/src/core/types.ts:69

Called when the object is destroyed or the component removed.

Parameters

this

GameObj

Returns

void

Inherited from

Comp.destroy

---

fixedUpdate()?

optional fixedUpdate(this): void

Defined in: packages/threeplay/src/core/types.ts:67

Called at the fixed physics rate (50 Hz by default).

Parameters

this

GameObj

Returns

void

Inherited from

Comp.fixedUpdate

---

getAt()

getAt(col, row): GameObj[]

Defined in: packages/threeplay/src/plugins/level/types.ts:37

Tile objects spawned at a grid cell (destroyed ones drop out; moved ones stay in their spawn cell).

Parameters

col

number

row

number

Returns

GameObj[]

---

inspect()?

optional inspect(this): string | null | undefined

Defined in: packages/threeplay/src/core/types.ts:71

Short status line shown by the debug inspector.

Parameters

this

GameObj

Returns

string | null | undefined

Inherited from

Comp.inspect

---

spawn()

spawn(what, col, row): GameObj | null

Defined in: packages/threeplay/src/plugins/level/types.ts:44

Adds a tile at a grid cell, from a map character (built with tiles) or a component list. Returns null when the character builds nothing.

Parameters

what

string | CompList

col

number

row

number

Returns

GameObj | null

---

tileToWorld()

tileToWorld(col, row): Vector3

Defined in: packages/threeplay/src/plugins/level/types.ts:33

Center of a tile in world space (follows the level object if it moves).

Parameters

col

number

row

number

Returns

Vector3

---

update()?

optional update(this): void

Defined in: packages/threeplay/src/core/types.ts:65

Called once per frame.

Parameters

this

GameObj

Returns

void

Inherited from

Comp.update

---

worldToTile()

worldToTile(p): object

Defined in: packages/threeplay/src/plugins/level/types.ts:35

Tile under a world point (may be outside the map).

Parameters

p

x

number

z

number

Returns

object

col

col: number

row

row: number

Properties

conflicts?

optional conflicts?: string[]

Defined in: packages/threeplay/src/core/types.ts:61

Ids of components that can’t be on the same object (checked both ways).

Inherited from

Comp.conflicts

---

id

id: "level"

Defined in: packages/threeplay/src/plugins/level/types.ts:25

Unique name. Two components with the same id replace each other.

Overrides

Comp.id

---

numCols

readonly numCols: number

Defined in: packages/threeplay/src/plugins/level/types.ts:27

Width of the map in tiles (the longest row).

---

numRows

readonly numRows: number

Defined in: packages/threeplay/src/plugins/level/types.ts:29

Height of the map in tiles.

---

require?

optional require?: string[]

Defined in: packages/threeplay/src/core/types.ts:59

Ids of components that must be present on the object.

Inherited from

Comp.require

---

tileSize

readonly tileSize: number

Defined in: packages/threeplay/src/plugins/level/types.ts:31

Size of a tile on X and Z.