Triggers

There are 35 triggers, and each one can start an event. Scripts hear many of them through ctx.on(...), and patches through their event nodes. Key reaches them as on-keydown and on-keyup, and Press on the object as on-mousedown, on-mouseup and on-click. See The ctx API.

Some triggers have branches, one for each outcome. Each branch has its own list of steps, so one event can handle every outcome. See Events.

In the editor	Category	Branches	Id (for scripts and patches)
Game controls	`control`	`idle`, `move`, `jump`, `run`	`on-game-control`
UI action	`external`	—	`on-divkit-action`
Signal	`external`	—	`on-signal`
Variable change	`external`	—	`on-variable-change`
Hover out	`input`	—	`on-blur`
Click	`input`	—	`on-click`
Double click	`input`	—	`on-double-click`
Drag	`input`	—	`on-drag`
Hover	`input`	`enter`, `exit`	`on-hover`
Key	`input`	`down`, `up`	`on-key`
Long press	`input`	—	`on-long-press`
Press on the object	`input`	`click`, `down`, `up`	`on-mouse`
Pinch	`input`	—	`on-pinch`
Pointer lock	`input`	—	`on-pointer-lock`
Cursor move	`input`	—	`on-pointer-move`
Rotate	`input`	—	`on-rotate`
Scroll	`input`	—	`on-scroll`
Launch	`lifecycle`	—	`on-launch`
Pause	`lifecycle`	—	`on-pause`
Resize	`lifecycle`	—	`on-resize`
Resume	`lifecycle`	—	`on-resume`
Visibility	`lifecycle`	`show`, `hide`	`on-visibility`
Collision	`physics`	—	`on-collide`
Distance	`proximity`	`enter`, `exit`	`on-distance`
State active	`state`	—	`on-state-active`
State inactive	`state`	—	`on-state-inactive`
Every N seconds	`time`	—	`on-interval`
Delay	`time`	—	`on-timeout`
Detect	`tracking`	—	`on-detect`
Tracking lost	`tracking`	—	`on-lost`
Placed	`tracking`	—	`on-placed`
VPS error	`tracking`	—	`on-vps-error`
VPS localized	`tracking`	—	`on-vps-localized`
VPS localization failed	`tracking`	—	`on-vps-not-localized`
VPS ready	`tracking`	—	`on-vps-ready`

Settings

Game controls

Id: on-game-control

Category control · branches idle, move, jump, run

Setting	Type	Default	Options or label
`mode`	`select`	`"walk"`	`walk`, `fly`, `top_down`
`turnToMove`	`boolean`	`true`	Auto-orient
`towards`	`select`	`"camera"`	`camera`, `axis`
`cameraRelative`	`boolean`	`true`	Camera relative
`speed`	`number`	`3`	Pos. Speed
`runMultiplier`	`number`	`2`	Run Factor
`turnSpeed`	`number`	`720`	Rot. Speed
`posDelayIn`	`number`	`0`	Pos. Delay
`posDelayOut`	`number`	`0`
`rotDelayIn`	`number`	`0`	Rot. Delay
`rotDelayOut`	`number`	`0`
`scheme`	`select`	`"both"`	`wasd`, `arrows`, `both`
`rotateBy`	`select`	`"mouse"`	`mouse`, `keys`, `both`
`touch`	`boolean`	`true`	Touch controls
`touchRotateBy`	`select`	`"drag"`	`drag`, `joystick`
`stickCorner`	`select`	`"bottom_left"`	`top_left`, `top_center`, `top_right`, `middle_left`, `middle_center`, `middle_right`, `bottom_left`, `bottom_center`, `bottom_right`
`jumpCorner`	`select`	`"bottom_right"`	`top_left`, `top_center`, `top_right`, `middle_left`, `middle_center`, `middle_right`, `bottom_left`, `bottom_center`, `bottom_right`
`touchOffsetX`	`number`	`30`	Offset
`touchOffsetY`	`number`	`30`
`buttonSize`	`number`	`120`	Button Size
`touchVisibility`	`select`	`"show"`	`show`, `hide`
`colliderShape`	`select`	`"capsule"`	`capsule`, `sphere`
`colliderRadius`	`number`	`0.5`	Size
`colliderHeight`	`number`	`1.8`
`colliderX`	`number`	`0`	Position
`colliderY`	`number`	`0.9`
`colliderZ`	`number`	`0`
`mass`	`number`	`1`	Mass
`colliderHelper`	`select`	`"hide"`	`show`, `hide`
`jumpHeight`	`number`	`0`	Jump
`airControl`	`number`	`0.3`	Air Control
`resetY`	`number`	`0`	Rst Y-offset
`clickToMove`	`boolean`	`false`	Click To Move
`followCamera`	`entity`	`null`	Camera
`orientTo`	`select`	`"normal"`	`normal`, `angle`
`camPosDelay`	`number`	`0.12`	Pos. Delay
`camRotDelay`	`number`	`0.08`	Rot. Delay
`upDown`	`select`	`"yes"`	`yes`, `no`, `limit`
`upDownMin`	`number`	`0`	Limit
`upDownMax`	`number`	`89`
`leftRight`	`select`	`"yes"`	`yes`, `no`, `limit`
`leftRightMin`	`number`	`-90`	Limit
`leftRightMax`	`number`	`90`

UI action

Id: on-divkit-action

Category external

Setting	Type	Default	Options or label
`id`	`string`	—	Action id

Signal

Id: on-signal

Category external

Setting	Type	Default	Options or label
`signal`	`string`	`""`	Signal

Variable change

Id: on-variable-change

Category external

Setting	Type	Default	Options or label
`variable`	`string`	`""`	Variable

Hover out

Id: on-blur

Category input

No settings.

Click

Id: on-click

Category input

Setting	Type	Default	Options or label
`button`	`select`	`"any"`	`any`, `left`, `right`, `middle`

Double click

Id: on-double-click

Category input · scope entity

Setting	Type	Default	Options or label
`button`	`select`	`"any"`	`any`, `left`, `right`, `middle`

Drag

Id: on-drag

Category input · scope entity · only on anchors surface

No settings.

Hover

Id: on-hover

Category input · branches enter, exit · scope entity

No settings.

Key

Id: on-key

Category input · branches down, up

Setting	Type	Default	Options or label
`code`	`string`	—	Code
`codes`	`array`	`[]`	Keys
`ctrl`	`boolean`	`false`
`alt`	`boolean`	`false`
`shift`	`boolean`	`false`
`meta`	`boolean`	`false`
`double`	`boolean`	`false`	Double press
`bind`	`string`	`""`	Project bind
`alts`	`array`	`[]`	Alternatives
`ignoreRepeat`	`boolean`	`false`	Ignore auto-repeat

Long press

Id: on-long-press

Category input · scope entity

Setting	Type	Default	Options or label
`button`	`select`	`"any"`	`any`, `left`, `right`, `middle`

Press on the object

Id: on-mouse

Category input · branches click, down, up · scope entity

Setting	Type	Default	Options or label
`button`	`select`	`"any"`	`any`, `left`, `right`, `middle`
`ctrl`	`boolean`	`false`
`alt`	`boolean`	`false`
`shift`	`boolean`	`false`
`meta`	`boolean`	`false`
`double`	`boolean`	`false`	Double press
`bind`	`string`	`""`	Project bind
`alts`	`array`	`[]`	Alternatives

Pinch

Id: on-pinch

Category input · scope entity · only on anchors surface

No settings.

Pointer lock

Id: on-pointer-lock

Category input

No settings.

Cursor move

Id: on-pointer-move

Category input

No settings.

Rotate

Id: on-rotate

Category input · scope entity · only on anchors surface

No settings.

Scroll

Id: on-scroll

Category input

Setting	Type	Default	Options or label
`direction`	`select`	`"any"`	`any`, `up`, `down`

Launch

Id: on-launch

Category lifecycle

No settings.

Pause

Id: on-pause

Category lifecycle

No settings.

Resize

Id: on-resize

Category lifecycle

No settings.

Resume

Id: on-resume

Category lifecycle

No settings.

Visibility

Id: on-visibility

Category lifecycle · branches show, hide

No settings.

Collision

Id: on-collide

Category physics

No settings.

Distance

Id: on-distance

Category proximity · branches enter, exit

Setting	Type	Default	Options or label
`target`	`entity`	`null`	Other object
`distance`	`number`	`1`	Distance
`fireOnStart`	`boolean`	`false`	Check at start

State active

Id: on-state-active

Category state · fires for each state

No settings.

State inactive

Id: on-state-inactive

Category state · fires for each state

No settings.

Every N seconds

Id: on-interval

Category time

Setting	Type	Default	Options or label
`seconds`	`number`	`1`	Every
`repeat`	`number`	`0`	Repeat

Delay

Id: on-timeout

Category time

Setting	Type	Default	Options or label
`seconds`	`number`	`1`	After

Detect

Id: on-detect

Category tracking · only on anchors image, qr, face, body, surface

No settings.

Tracking lost

Id: on-lost

Category tracking · only on anchors image, qr, face, body, surface

No settings.