Interface: Behaviour

Defined in: behaviours/behaviour.ts:51

Properties

Property	Modifier	Type	Description	Defined in
grabbable	readonly	boolean	True when this behaviour makes the interactable a grab target.	behaviours/behaviour.ts:59
kind	readonly	string	-	behaviours/behaviour.ts:52
ownership	readonly	TransformOwnership	-	behaviours/behaviour.ts:53
requires	readonly	readonly ( | "gaze" | "pointer2d" | "rays" | "pokes" | "grabs" | "grabsNative" | "handJoints" | "pinch" | "buttonsAxes" | "headPose" | "haptics" | "presence")[]	ALL of these must be satisfied.	behaviours/behaviour.ts:55
requiresAnyOf?	readonly	readonly readonly ( | "gaze" | "pointer2d" | "rays" | "pokes" | "grabs" | "grabsNative" | "handJoints" | "pinch" | "buttonsAxes" | "headPose" | "haptics" | "presence")[][]	For each group, AT LEAST ONE must be satisfied.	behaviours/behaviour.ts:57

Methods

getValue()

getValue(): number;

Defined in: behaviours/behaviour.ts:73

Current logical 0..1 value (state snapshots, HUDs).

Returns

number

---

onGrabEnd()?

optional onGrabEnd(ctx: BehaviourContext, interactor: InteractorInfo): void;

Defined in: behaviours/behaviour.ts:64

Parameters

Parameter	Type
ctx	BehaviourContext
interactor	InteractorInfo

Returns

void

---

onGrabStart()?

optional onGrabStart(ctx: BehaviourContext, interactor: InteractorInfo): void;

Defined in: behaviours/behaviour.ts:63

Parameters

Parameter	Type
ctx	BehaviourContext
interactor	InteractorInfo

Returns

void

---

onPressEnd()?

optional onPressEnd(ctx: BehaviourContext, interactor: InteractorInfo): void;

Defined in: behaviours/behaviour.ts:62

Parameters

Parameter	Type
ctx	BehaviourContext
interactor	InteractorInfo

Returns

void

---

onPressStart()?

optional onPressStart(ctx: BehaviourContext, interactor: InteractorInfo): void;

Defined in: behaviours/behaviour.ts:61

Parameters

Parameter	Type
ctx	BehaviourContext
interactor	InteractorInfo

Returns

void

---

update()

update(ctx: BehaviourContext, holder?: InteractorInfo): void;

Defined in: behaviours/behaviour.ts:70

Per-frame tick. holder is set while a grab interactor holds this interactable (grab-family behaviours consume it; others ignore it).

Parameters

Parameter	Type
ctx	BehaviourContext
holder?	InteractorInfo

Returns

void