Skip to main content

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 editorCategoryDeprecatedId (scripts, patches)
Contact downloadactioncontact_download_action
Compose emailactionemail_action
Release pointeractionexit_pointer_lock
File downloadactionfile_download_action
Follow objectactionfollow
Look at objectactionlook_at_target
Open messengeractionmessenger_action
Call phone numberactionphone_call_action
Lock pointeractionrequest_pointer_lock
Scene transitionactionscene_transit_action
Show / hide objectactionset_visibility
Space transitionactionspace_transit_action
Stop followingactionstop_follow
Open URLactionurl_transit_action
Fly along pathanimationfollow_path
Built-in animationanimationyeslaunch_built_in_animation
Materialanimationyesmaterial_animation
Opacityanimationyesopacity_animation
Play animationanimationplay_animation
Bone transformanimationyesskeletal_transform
Stop animationanimationstop_animation
Stop path flightanimationstop_follow_path
Transformationanimationyestransformation_animation
Send signallogicemit_signal
If — otherwiselogicif_action
Set variablelogicset_variable
Wait, thenlogicwait_action
Override propertiesstateoverride_state
Set statestateset_state

Parameters

Contact download

Id contact_download_action · category action

ParamTypeDefaultOptions / label
photoresourcePhoto
fullNamestringFull name
mobilePhonestringMobile phone
workPhonestringWork phone
homePhonestringHome phone
companystringCompany
emailstringEmail
positionstringPosition
addressstringAddress
websitestringWebsite

Compose email

Id email_action · category action

ParamTypeDefaultOptions / label
emailstringEmail

Release pointer

Id exit_pointer_lock · category action

No parameters.

File download

Id file_download_action · category action

ParamTypeDefaultOptions / label
resourceresourceFile

Follow object

Id follow · category action

ParamTypeDefaultOptions / label
targetentitynullFollow
distancenumber0Keep distance
offsetXnumber0Offset X
offsetYnumber0Offset Y
offsetZnumber0Offset Z
smoothingnumber0.2Smoothing
maxSpeednumber0Max speed
lockYbooleanfalseKeep own height
faceTargetbooleantrueFace target
turnSpeednumber0Turn speed

Look at object

Id look_at_target · category action

ParamTypeDefaultOptions / label
targetentitynullLook at
turnSpeednumber0Turn speed
lockYbooleantrueKeep upright

Open messenger

Id messenger_action · category action

ParamTypeDefaultOptions / label
platformselectfacebook, vk, instagram, whatsapp, telegram, viber, ok
valuestringValue

Call phone number

Id phone_call_action · category action

ParamTypeDefaultOptions / label
phonestringPhone

Lock pointer

Id request_pointer_lock · category action

No parameters.

Scene transition

Id scene_transit_action · category action

ParamTypeDefaultOptions / label
sceneIdsceneScene

Show / hide object

Id set_visibility · category action

ParamTypeDefaultOptions / label
visiblebooleantrueVisible

Space transition

Id space_transit_action · category action

ParamTypeDefaultOptions / label
spaceIdspaceSpace
sceneIdscenenullScene

Stop following

Id stop_follow · category action

No parameters.

Open URL

Id url_transit_action · category action

ParamTypeDefaultOptions / label
urlstringURL
transitionTypeselect"new_tab"new_tab, same_tab

Fly along path

Id follow_path · category animation

ParamTypeDefaultOptions / label
pathentitynullPath
durationnumber3Duration
loopselect"once"once, loop, ping_pong
orientbooleantrueFace along path
reversebooleanfalseReverse

Built-in animation

Id launch_built_in_animation · category animation · deprecated (still executes, no longer offered in palettes)

ParamTypeDefaultOptions / label
builtInAnimationstringAnimation
startFramenumber0
delaynumber0
repeatCountnumber1

Material

Id material_animation · category animation · deprecated (still executes, no longer offered in palettes)

ParamTypeDefaultOptions / label
materialIdresourceMaterial
durationnumber1
delaynumber0
repeatCountnumber1

Opacity

Id opacity_animation · category animation · deprecated (still executes, no longer offered in palettes)

ParamTypeDefaultOptions / label
opacitynumber100
durationnumber1
delaynumber0
repeatCountnumber1

Play animation

Id play_animation · category animation

ParamTypeDefaultOptions / label
animatorentitynull
presetIdstring""
loopTypeselect"once"once, count, forever
repeatCountnumber1
speednumber1
delaynumber0

Bone transform

Id skeletal_transform · category animation · deprecated (still executes, no longer offered in palettes)

ParamTypeDefaultOptions / label
positionXnumber0
positionYnumber0
positionZnumber0
quatXnumber0
quatYnumber0
quatZnumber0
quatWnumber1
scaleXnumber1
scaleYnumber1
scaleZnumber1
durationnumber1
delaynumber0
loopTypeselect"count"once, count, forever
repeatCountnumber1

Stop animation

Id stop_animation · category animation

ParamTypeDefaultOptions / label
animatorentitynull
presetIdstring""

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)

ParamTypeDefaultOptions / label
rotationEnabledbooleantrue
rotationXnumber0
rotationYnumber0
rotationZnumber0
positionEnabledbooleantrue
positionXnumber0
positionYnumber0
positionZnumber0
scaleEnabledbooleantrue
scaleXnumber1
scaleYnumber1
scaleZnumber1
durationnumber1
delaynumber0
loopTypeselect"count"once, count, forever
repeatCountnumber1

Send signal

Id emit_signal · category logic

ParamTypeDefaultOptions / label
signalstring""Signal
scopeselect"targets"targets, broadcast

If — otherwise

Id if_action · category logic

ParamTypeDefaultOptions / label
sourceselect"always"always, variable, distance, state, visible, random
variablestring""Variable
targetentitynullObject
opselect"=="==, !=, >, >=, <, <=
valuestring""Value
thresholdnumber1Threshold
stateIdstatenullState
flagbooleantrueExpected

Set variable

Id set_variable · category logic

ParamTypeDefaultOptions / label
variablestring""Variable
modeselect"set"set, add, toggle
valuestring""Value

Wait, then

Id wait_action · category logic

ParamTypeDefaultOptions / label
secondsnumber1Delay

Override properties

Id override_state · category state

ParamTypeDefaultOptions / label
patchrecord{}
durationMsnumber0
easingselect"ease-in-out"linear, ease-in, ease-out, ease-in-out

Set state

Id set_state · category state

ParamTypeDefaultOptions / label
stateIdstateState
durationMsnumber0
easingselect"ease-in-out"linear, ease-in, ease-out, ease-in-out