HealthComp

Defined in: packages/threeplay/src/plugins/gameplay/types.ts:8

Fields added by health(). Events are object events: "hurt" (amount), "heal" (amount) and "death", also reachable with k.on("death", tag, fn).

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

---

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

---

heal()

heal(amount?): void

Defined in: packages/threeplay/src/plugins/gameplay/types.ts:20

Adds hit points (default 1, clamped to maxHp) and emits "heal".

Parameters

amount?

number

Returns

void

---

hurt()

hurt(amount?): void

Defined in: packages/threeplay/src/plugins/gameplay/types.ts:18

Removes hit points (default 1), emits "hurt", then "death" if hp reached 0.

Parameters

amount?

number

Returns

void

---

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

---

onDeath()

onDeath(fn): EventController

Defined in: packages/threeplay/src/plugins/gameplay/types.ts:28

When hp reaches 0 (fires once until hp is above 0 again).

Parameters

fn

() => void

Returns

EventController

---

onHeal()

onHeal(fn): EventController

Defined in: packages/threeplay/src/plugins/gameplay/types.ts:26

Runs after every heal().

Parameters

fn

(amount) => void

Returns

EventController

---

onHurt()

onHurt(fn): EventController

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

Runs after every hurt().

Parameters

fn

(amount) => void

Returns

EventController

---

setHP()

setHP(hp): void

Defined in: packages/threeplay/src/plugins/gameplay/types.ts:22

Sets hp (clamped to 0…maxHp) without hurt/heal events; emits "death" at 0.

Parameters

hp

number

Returns

void

---

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

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

---

hp

hp: number

Defined in: packages/threeplay/src/plugins/gameplay/types.ts:14

Current hit points, always within 0…maxHp. Assigning to it (obj.hp -= 1) behaves like HealthComp.setHP.

---

id

id: "health"

Defined in: packages/threeplay/src/plugins/gameplay/types.ts:9

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

Overrides

Comp.id

---

maxHp

maxHp: number

Defined in: packages/threeplay/src/plugins/gameplay/types.ts:16

Upper limit of hp and of heal().

---

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