Trigger reference
35 triggers. The same names work in three places: an event's trigger, a patch's event node, and ctx.on(...) in a script.
A trigger with branches keeps one list of steps per outcome, so one event answers all of them — see Events.
| In the editor | Category | Branches | Id (scripts, 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 |
Parameters
Game controls
Id: on-game-control
Category control · branches idle, move, jump, run
| Param | Type | Default | Options / 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
| Param | Type | Default | Options / label |
|---|---|---|---|
id | string | — | Action id |
Signal
Id: on-signal
Category external
| Param | Type | Default | Options / label |
|---|---|---|---|
signal | string | "" | Signal |
Variable change
Id: on-variable-change
Category external
| Param | Type | Default | Options / label |
|---|---|---|---|
variable | string | "" | Variable |
Hover out
Id: on-blur
Category input
No parameters.
Click
Id: on-click
Category input
| Param | Type | Default | Options / label |
|---|---|---|---|
button | select | "any" | any, left, right, middle |
Double click
Id: on-double-click
Category input · scope entity
| Param | Type | Default | Options / label |
|---|---|---|---|
button | select | "any" | any, left, right, middle |
Drag
Id: on-drag
Category input · scope entity · only on anchors surface
No parameters.
Hover
Id: on-hover
Category input · branches enter, exit · scope entity
No parameters.
Key
Id: on-key
Category input · branches down, up
| Param | Type | Default | Options / 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
| Param | Type | Default | Options / label |
|---|---|---|---|
button | select | "any" | any, left, right, middle |
Press on the object
Id: on-mouse
Category input · branches click, down, up · scope entity
| Param | Type | Default | Options / 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 parameters.
Pointer lock
Id: on-pointer-lock
Category input
No parameters.
Cursor move
Id: on-pointer-move
Category input
No parameters.
Rotate
Id: on-rotate
Category input · scope entity · only on anchors surface
No parameters.
Scroll
Id: on-scroll
Category input
| Param | Type | Default | Options / label |
|---|---|---|---|
direction | select | "any" | any, up, down |
Launch
Id: on-launch
Category lifecycle
No parameters.
Pause
Id: on-pause
Category lifecycle
No parameters.
Resize
Id: on-resize
Category lifecycle
No parameters.
Resume
Id: on-resume
Category lifecycle
No parameters.
Visibility
Id: on-visibility
Category lifecycle · branches show, hide
No parameters.
Collision
Id: on-collide
Category physics
No parameters.
Distance
Id: on-distance
Category proximity · branches enter, exit
| Param | Type | Default | Options / 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 per state
No parameters.
State inactive
Id: on-state-inactive
Category state · fires per state
No parameters.
Every N seconds
Id: on-interval
Category time
| Param | Type | Default | Options / label |
|---|---|---|---|
seconds | number | 1 | Every |
repeat | number | 0 | Repeat |
Delay
Id: on-timeout
Category time
| Param | Type | Default | Options / label |
|---|---|---|---|
seconds | number | 1 | After |
Detect
Id: on-detect
Category tracking · only on anchors image, qr, face, surface
No parameters.
Tracking lost
Id: on-lost
Category tracking · only on anchors image, qr, face, surface
No parameters.
Placed
Id: on-placed
Category tracking · only on anchors surface
No parameters.
VPS error
Id: on-vps-error
Category tracking · only on anchors surface
No parameters.
VPS localized
Id: on-vps-localized
Category tracking · only on anchors surface
No parameters.
VPS localization failed
Id: on-vps-not-localized
Category tracking · only on anchors surface
No parameters.
VPS ready
Id: on-vps-ready
Category tracking · only on anchors surface
No parameters.