Step reference
29 steps. A step is what an event actually does when its trigger fires. A script can run any of them with ctx.step(name, params) instead of reimplementing the behaviour.
| In the editor | Category | Deprecated | Id (scripts, patches) |
|---|---|---|---|
| Contact download | action | — | contact_download_action |
| Compose email | action | — | email_action |
| Release pointer | action | — | exit_pointer_lock |
| File download | action | — | file_download_action |
| Follow object | action | — | follow |
| Look at object | action | — | look_at_target |
| Open messenger | action | — | messenger_action |
| Call phone number | action | — | phone_call_action |
| Lock pointer | action | — | request_pointer_lock |
| Scene transition | action | — | scene_transit_action |
| Show / hide object | action | — | set_visibility |
| Space transition | action | — | space_transit_action |
| Stop following | action | — | stop_follow |
| Open URL | action | — | url_transit_action |
| Fly along path | animation | — | follow_path |
| Built-in animation | animation | yes | launch_built_in_animation |
| Material | animation | yes | material_animation |
| Opacity | animation | yes | opacity_animation |
| Play animation | animation | — | play_animation |
| Bone transform | animation | yes | skeletal_transform |
| Stop animation | animation | — | stop_animation |
| Stop path flight | animation | — | stop_follow_path |
| Transformation | animation | yes | transformation_animation |
| Send signal | logic | — | emit_signal |
| If — otherwise | logic | — | if_action |
| Set variable | logic | — | set_variable |
| Wait, then | logic | — | wait_action |
| Override properties | state | — | override_state |
| Set state | state | — | set_state |
Parameters
Contact download
Id contact_download_action · category action
| Param | Type | Default | Options / label |
|---|---|---|---|
photo | resource | — | Photo |
fullName | string | — | Full name |
mobilePhone | string | — | Mobile phone |
workPhone | string | — | Work phone |
homePhone | string | — | Home phone |
company | string | — | Company |
email | string | — | |
position | string | — | Position |
address | string | — | Address |
website | string | — | Website |
Compose email
Id email_action · category action
| Param | Type | Default | Options / label |
|---|---|---|---|
email | string | — |
Release pointer
Id exit_pointer_lock · category action
No parameters.
File download
Id file_download_action · category action
| Param | Type | Default | Options / label |
|---|---|---|---|
resource | resource | — | File |
Follow object
Id follow · category action
| Param | Type | Default | Options / label |
|---|---|---|---|
target | entity | null | Follow |
distance | number | 0 | Keep distance |
offsetX | number | 0 | Offset X |
offsetY | number | 0 | Offset Y |
offsetZ | number | 0 | Offset Z |
smoothing | number | 0.2 | Smoothing |
maxSpeed | number | 0 | Max speed |
lockY | boolean | false | Keep own height |
faceTarget | boolean | true | Face target |
turnSpeed | number | 0 | Turn speed |
Look at object
Id look_at_target · category action
| Param | Type | Default | Options / label |
|---|---|---|---|
target | entity | null | Look at |
turnSpeed | number | 0 | Turn speed |
lockY | boolean | true | Keep upright |
Open messenger
Id messenger_action · category action
| Param | Type | Default | Options / label |
|---|---|---|---|
platform | select | — | facebook, vk, instagram, whatsapp, telegram, viber, ok |
value | string | — | Value |
Call phone number
Id phone_call_action · category action
| Param | Type | Default | Options / label |
|---|---|---|---|
phone | string | — | Phone |
Lock pointer
Id request_pointer_lock · category action
No parameters.
Scene transition
Id scene_transit_action · category action
| Param | Type | Default | Options / label |
|---|---|---|---|
sceneId | scene | — | Scene |
Show / hide object
Id set_visibility · category action
| Param | Type | Default | Options / label |
|---|---|---|---|
visible | boolean | true | Visible |
Space transition
Id space_transit_action · category action
| Param | Type | Default | Options / label |
|---|---|---|---|
spaceId | space | — | Space |
sceneId | scene | null | Scene |
Stop following
Id stop_follow · category action
No parameters.
Open URL
Id url_transit_action · category action
| Param | Type | Default | Options / label |
|---|---|---|---|
url | string | — | URL |
transitionType | select | "new_tab" | new_tab, same_tab |
Fly along path
Id follow_path · category animation
| Param | Type | Default | Options / label |
|---|---|---|---|
path | entity | null | Path |
duration | number | 3 | Duration |
loop | select | "once" | once, loop, ping_pong |
orient | boolean | true | Face along path |
reverse | boolean | false | Reverse |
Built-in animation
Id launch_built_in_animation · category animation · deprecated (still executes, no longer offered in palettes)
| Param | Type | Default | Options / label |
|---|---|---|---|
builtInAnimation | string | — | Animation |
startFrame | number | 0 | |
delay | number | 0 | |
repeatCount | number | 1 |
Material
Id material_animation · category animation · deprecated (still executes, no longer offered in palettes)
| Param | Type | Default | Options / label |
|---|---|---|---|
materialId | resource | — | Material |
duration | number | 1 | |
delay | number | 0 | |
repeatCount | number | 1 |
Opacity
Id opacity_animation · category animation · deprecated (still executes, no longer offered in palettes)
| Param | Type | Default | Options / label |
|---|---|---|---|
opacity | number | 100 | |
duration | number | 1 | |
delay | number | 0 | |
repeatCount | number | 1 |
Play animation
Id play_animation · category animation
| Param | Type | Default | Options / label |
|---|---|---|---|
animator | entity | null | |
presetId | string | "" | |
loopType | select | "once" | once, count, forever |
repeatCount | number | 1 | |
speed | number | 1 | |
delay | number | 0 |
Bone transform
Id skeletal_transform · category animation · deprecated (still executes, no longer offered in palettes)
| Param | Type | Default | Options / label |
|---|---|---|---|
positionX | number | 0 | |
positionY | number | 0 | |
positionZ | number | 0 | |
quatX | number | 0 | |
quatY | number | 0 | |
quatZ | number | 0 | |
quatW | number | 1 | |
scaleX | number | 1 | |
scaleY | number | 1 | |
scaleZ | number | 1 | |
duration | number | 1 | |
delay | number | 0 | |
loopType | select | "count" | once, count, forever |
repeatCount | number | 1 |
Stop animation
Id stop_animation · category animation
| Param | Type | Default | Options / label |
|---|---|---|---|
animator | entity | null | |
presetId | string | "" |
Stop path flight
Id stop_follow_path · category animation
No parameters.
Transformation
Id transformation_animation · category animation · deprecated (still executes, no longer offered in palettes)
| Param | Type | Default | Options / label |
|---|---|---|---|
rotationEnabled | boolean | true | |
rotationX | number | 0 | |
rotationY | number | 0 | |
rotationZ | number | 0 | |
positionEnabled | boolean | true | |
positionX | number | 0 | |
positionY | number | 0 | |
positionZ | number | 0 | |
scaleEnabled | boolean | true | |
scaleX | number | 1 | |
scaleY | number | 1 | |
scaleZ | number | 1 | |
duration | number | 1 | |
delay | number | 0 | |
loopType | select | "count" | once, count, forever |
repeatCount | number | 1 |
Send signal
Id emit_signal · category logic
| Param | Type | Default | Options / label |
|---|---|---|---|
signal | string | "" | Signal |
scope | select | "targets" | targets, broadcast |
If — otherwise
Id if_action · category logic
| Param | Type | Default | Options / label |
|---|---|---|---|
source | select | "always" | always, variable, distance, state, visible, random |
variable | string | "" | Variable |
target | entity | null | Object |
op | select | "==" | ==, !=, >, >=, <, <= |
value | string | "" | Value |
threshold | number | 1 | Threshold |
stateId | state | null | State |
flag | boolean | true | Expected |
Set variable
Id set_variable · category logic
| Param | Type | Default | Options / label |
|---|---|---|---|
variable | string | "" | Variable |
mode | select | "set" | set, add, toggle |
value | string | "" | Value |
Wait, then
Id wait_action · category logic
| Param | Type | Default | Options / label |
|---|---|---|---|
seconds | number | 1 | Delay |
Override properties
Id override_state · category state
| Param | Type | Default | Options / label |
|---|---|---|---|
patch | record | {} | |
durationMs | number | 0 | |
easing | select | "ease-in-out" | linear, ease-in, ease-out, ease-in-out |
Set state
Id set_state · category state
| Param | Type | Default | Options / label |
|---|---|---|---|
stateId | state | — | State |
durationMs | number | 0 | |
easing | select | "ease-in-out" | linear, ease-in, ease-out, ease-in-out |