Patch node reference

203 nodes across 24 categories. Nodes marked * still work in existing graphs but are no longer offered in the palette.

A node is one of four kinds: an event node starts the graph, a control node shapes the flow (branch, loop, gate), an effect node does something and passes the pulse on, and a data node is just a value. See Patches.

animation

Node	What it does	Kind	Inputs	Outputs
animate	Runs a built-in animation step.	effect	target:object, params:any, exec:pulse	then:pulse

appearance

Node	What it does	Kind	Inputs	Outputs
set_color	Sets the colour on every material slot at once.	effect	object:object, color:color, exec:pulse	then:pulse

audio

Node	What it does	Kind	Inputs	Outputs
play_sound	Plays a one-shot sound. Each call is independent, so effects never cut each other off.	effect	object:object, volume:number, exec:pulse	then:pulse

code

Node	What it does	Kind	Inputs	Outputs
action	JavaScript statements, run in the flow.	effect	a:any, b:any, c:any, d:any, exec:pulse	then:pulse
expression	A JavaScript expression, for the one thing no node covers.	data	a:any, b:any, c:any, d:any	result:any

components

Node	What it does	Kind	Inputs	Outputs
get_anchor	Reads a scene’s trigger settings.	data	object:object	isMain:boolean, imageId:string, physicalWidth:number, physicalHeight:number, showHints:boolean, text:string, physicalSize:number, latitude:number, longitude:number, anchorPoint:string, faceGrid:boolean, faceTextureId:string, fillEyes:boolean, fillMouth:boolean, flipTexture:boolean, bindingType:string, recognitionAlgorithm:string, providerIos:string, providerAndroid:string, vps:boolean, locationIds:any, cameraId:string
get_audio	Reads a sound’s settings.	data	object:object	audio:string, volume:number, play:boolean, loop:boolean, muted:boolean, positional:boolean, position:number
get_collider	Reads the collision shape.	data	object:object	halfExtents:vector, radius:number, radiusTop:number, radiusBottom:number, height:number, segments:number
get_geometry	Reads the shape and its dimensions.	data	object:object	width:number, height:number, depth:number, widthSegments:number, heightSegments:number, depthSegments:number, cornerRadius:number, cornerSegments:number, radius:number, phiStart:number, phiLength:number, thetaStart:number, thetaLength:number, radiusTop:number, radiusBottom:number, radialSegments:number, openEnded:boolean, capSegments:number, segments:number, detail:number, innerRadius:number, outerRadius:number, thetaSegments:number, phiSegments:number, tube:number, tubularSegments:number, arc:number, points:any, bevelEnabled:boolean, bevelThickness:number, bevelSize:number, bevelSegments:number, referal:string
get_initial_velocity	Reads the starting push.	data	object:object	velocity:vector, angularVelocity:vector
get_instancer	Reads how copies are arranged.	data	object:object	maxCount:number, seed:number, scaleMin:number, scaleMax:number, rotationJitter:vector, colorA:color, colorB:color, countX:number, countY:number, countZ:number, spacing:vector, jitter:number, count:number, shape:string, extents:vector
get_light	Reads a light’s colour and intensity.	data	object:object	color:color, intensity:number, castShadow:boolean, visible:boolean, distance:number, decay:number, angle:number, penumbra:number, groundColor:color
get_look_at	Reads the look-at target.	data	object:object	target:vector, offset:vector
get_material	Reads the first material slot.	data	object:object	materials:any
get_meta	Reads the name, and whether the object is enabled and visible.	data	object:object	name:string, type:string, sort:number, enabled:boolean, visible:boolean, isMain:boolean
get_model_ref	Reads which model and clip are playing.	data	object:object	referal:string, clip:string, speed:number, repeatMode:string, repeatCount:number, startFrame:number, stopWhenPressed:boolean, playing:boolean
get_parent	Reads which object this one is inside.	data	object:object	parent:string, order:number, lock:boolean
get_particle_emitter	Reads emitter settings.	data	object:object	emitting:boolean, count:number, lifetime:number, shape:string, radius:number, extents:vector, angle:number, speedMin:number, speedMax:number, gravity:vector, drag:number, turbulence:number, sizeStart:number, sizeEnd:number, sizeJitter:number, spin:number, colorStart:color, colorEnd:color, opacityStart:number, opacityEnd:number, sprite:string, blending:string, seed:number
get_physics_state	Reads live speed and whether the body is asleep. Read-only.	data	object:object	velocity:vector, angularVelocity:vector, speed:number, sleeping:boolean
get_rigid_body	Reads the physics body settings.	data	object:object	type:string, mass:number, linearDamping:number, angularDamping:number, fixedRotation:boolean, friction:number, restitution:number, network:string
get_script	Reads a script component’s settings.	data	object:object	referal:string, enabled:boolean, props:any
get_shadow	Reads the shadow flags.	data	object:object	castShadow:boolean, receiveShadow:boolean
get_states	Reads which state is active.	data	object:object	states:any, activeStateId:string
get_temporal_state	Reads the animation preset.	data	object:object	presets:any, activePresetId:string
get_text	Reads the text and its look.	data	object:object	font:string, fontStyle:string, text:string, fontWeight:string, fontSize:number, width:number, height:number, textAlign:string, verticalAlign:string, color:any
get_transform	Reads position, rotation and scale. Rotation is in degrees.	data	object:object	position:vector, rotation:vector, scale:vector, lock:boolean
get_video	Reads a video’s settings.	data	object:object	video:string, volume:number, play:boolean, loop:boolean, muted:boolean, positional:boolean, position:number
set_anchor	Changes them.	effect	object:object, isMain:boolean, imageId:string, physicalWidth:number, physicalHeight:number, showHints:boolean, text:string, physicalSize:number, latitude:number, longitude:number, anchorPoint:string, faceGrid:boolean, faceTextureId:string, fillEyes:boolean, fillMouth:boolean, flipTexture:boolean, bindingType:string, recognitionAlgorithm:string, providerIos:string, providerAndroid:string, vps:boolean, locationIds:any, cameraId:string, exec:pulse	then:pulse
set_audio	Plays, pauses, or changes volume.	effect	object:object, audio:string, volume:number, play:boolean, loop:boolean, muted:boolean, positional:boolean, position:number, exec:pulse	then:pulse
set_collider	Changes it.	effect	object:object, halfExtents:vector, radius:number, radiusTop:number, radiusBottom:number, height:number, segments:number, exec:pulse	then:pulse
set_geometry	Changes them.	effect	object:object, width:number, height:number, depth:number, widthSegments:number, heightSegments:number, depthSegments:number, cornerRadius:number, cornerSegments:number, radius:number, phiStart:number, phiLength:number, thetaStart:number, thetaLength:number, radiusTop:number, radiusBottom:number, radialSegments:number, openEnded:boolean, capSegments:number, segments:number, detail:number, innerRadius:number, outerRadius:number, thetaSegments:number, phiSegments:number, tube:number, tubularSegments:number, arc:number, points:any, bevelEnabled:boolean, bevelThickness:number, bevelSize:number, bevelSegments:number, referal:string, exec:pulse	then:pulse
set_initial_velocity	Changes it.	effect	object:object, velocity:vector, angularVelocity:vector, exec:pulse	then:pulse
set_instancer	Changes the count, spacing or spread.	effect	object:object, maxCount:number, seed:number, scaleMin:number, scaleMax:number, rotationJitter:vector, colorA:color, colorB:color, countX:number, countY:number, countZ:number, spacing:vector, jitter:number, count:number, shape:string, extents:vector, exec:pulse	then:pulse
set_light	Changes them — dimming and colour shifts.	effect	object:object, color:color, intensity:number, castShadow:boolean, visible:boolean, distance:number, decay:number, angle:number, penumbra:number, groundColor:color, exec:pulse	then:pulse
set_look_at	Points an object at something.	effect	object:object, target:vector, offset:vector, exec:pulse	then:pulse
set_material	Writes to it — colour, opacity, roughness and the rest.	effect	object:object, materials:any, exec:pulse	then:pulse
set_meta	Shows, hides, enables or disables an object.	effect	object:object, name:string, type:string, sort:number, enabled:boolean, visible:boolean, isMain:boolean, exec:pulse	then:pulse
set_model_ref	Switches model, clip, speed or looping.	effect	object:object, referal:string, clip:string, speed:number, repeatMode:string, repeatCount:number, startFrame:number, stopWhenPressed:boolean, playing:boolean, exec:pulse	then:pulse
set_parent	Moves it into another object.	effect	object:object, parent:string, order:number, lock:boolean, exec:pulse	then:pulse
set_particle_emitter	Changes them — start and stop an effect, or retune it live.	effect	object:object, emitting:boolean, count:number, lifetime:number, shape:string, radius:number, extents:vector, angle:number, speedMin:number, speedMax:number, gravity:vector, drag:number, turbulence:number, sizeStart:number, sizeEnd:number, sizeJitter:number, spin:number, colorStart:color, colorEnd:color, opacityStart:number, opacityEnd:number, sprite:string, blending:string, seed:number, exec:pulse	then:pulse
set_rigid_body	Changes mass, damping or body type.	effect	object:object, type:string, mass:number, linearDamping:number, angularDamping:number, fixedRotation:boolean, friction:number, restitution:number, network:string, exec:pulse	then:pulse
set_script	Enables, disables or reconfigures it.	effect	object:object, referal:string, enabled:boolean, props:any, exec:pulse	then:pulse
set_shadow	Turns casting and receiving on or off.	effect	object:object, castShadow:boolean, receiveShadow:boolean, exec:pulse	then:pulse
set_states	Switches state.	effect	object:object, states:any, activeStateId:string, exec:pulse	then:pulse
set_temporal_state	Switches preset.	effect	object:object, presets:any, activePresetId:string, exec:pulse	then:pulse
set_text	Changes what a text object says.	effect	object:object, font:string, fontStyle:string, text:string, fontWeight:string, fontSize:number, width:number, height:number, textAlign:string, verticalAlign:string, color:any, exec:pulse	then:pulse
set_transform	Writes them — only the ones you wire up.	effect	object:object, position:vector, rotation:vector, scale:vector, lock:boolean, exec:pulse	then:pulse
set_video	Plays, pauses, or seeks.	effect	object:object, video:string, volume:number, play:boolean, loop:boolean, muted:boolean, positional:boolean, position:number, exec:pulse	then:pulse

data

Node	What it does	Kind	Inputs	Outputs
boolean	True or false.	data	—	value:boolean
color	A colour.	data	—	value:color
number	A number you type in.	data	—	value:number
pi	π, for angle maths.	data	—	value:number
text	A piece of text.	data	—	value:string
vector	An x, y, z triple.	data	x:number, y:number, z:number	value:vector

entities

Node	What it does	Kind	Inputs	Outputs
find_by_name *	Finds an object by name.	data	name:string	object:object
get_by_id *	Finds an object by id.	data	id:string	object:object
get_entity	Refers to an object: this one, the scene, or one found by name or id.	data	query:string	object:object
scene *	The scene this graph belongs to.	data	—	object:object
self *	This object.	data	—	object:object

events

Node	What it does	Kind	Inputs	Outputs
on_blur	The cursor left it.	event (on-blur)	—	pulse:pulse
on_click	This object was tapped or clicked.	event (on-click)	—	pulse:pulse
on_collide	Something touched this object; other is what hit it.	event (on-collide)	—	pulse:pulse, other:object
on_detect	The marker or surface was found.	event (on-detect)	—	pulse:pulse
on_divkit_action	A button on an interface card was pressed.	event (on-divkit-action)	—	pulse:pulse, id:string
on_drag	Placed AR content is being dragged.	event (on-drag)	—	pulse:pulse, dx:number, dy:number
on_frame	Every frame, with the time since the last one — for anything continuous.	event (frame)	—	pulse:pulse, dt:number, time:number
on_game_control	The character controller changed state — idle, moving, running, jumping.	event (on-game-control)	—	pulse:pulse, state:string
on_hover	The cursor moved onto this object.	event (on-hover)	—	pulse:pulse
on_key_down	A key went down; key tells you which, so you can filter.	event (on-keydown)	—	pulse:pulse, key:string
on_key_up	A key was released.	event (on-keyup)	—	pulse:pulse, key:string
on_launch	The scene started. Your usual entry point.	event (launch)	—	pulse:pulse
on_lost	Tracking was lost.	event (on-lost)	—	pulse:pulse
on_mouse_down	A pointer button went down on this object.	event (on-mousedown)	—	pulse:pulse
on_mouse_up	It was released.	event (on-mouseup)	—	pulse:pulse
on_pause	The app or tab went to the background.	event (on-pause)	—	pulse:pulse
on_pinch	Placed AR content is being pinched.	event (on-pinch)	—	pulse:pulse, scale:number
on_placed	The visitor placed the content on a surface.	event (on-placed)	—	pulse:pulse
on_pointer_lock	The pointer was captured or released.	event (on-pointer-lock)	—	pulse:pulse, locked:boolean
on_pointer_move	The pointer moved, with how far — for look controls.	event (on-pointer-move)	—	pulse:pulse, dx:number, dy:number, deltaYaw:number, deltaPitch:number
on_resize	The viewport changed size.	event (on-resize)	—	pulse:pulse
on_resume	It came back.	event (on-resume)	—	pulse:pulse
on_rotate	Placed AR content is being twisted.	event (on-rotate)	—	pulse:pulse, angle:number
on_scroll	The wheel turned.	event (on-scroll)	—	pulse:pulse
on_state_active	This object entered a state.	event (on-state-active)	—	pulse:pulse
on_state_inactive	It left one.	event (on-state-inactive)	—	pulse:pulse
on_vps_error	Positioning could not run at all.	event (on-vps-error)	—	pulse:pulse
on_vps_localized	The visitor’s real position was found.	event (on-vps-localized)	—	pulse:pulse
on_vps_not_localized	It was not — this is routine while they look around, not an error.	event (on-vps-not-localized)	—	pulse:pulse
on_vps_ready	Positioning against a real-world map started up.	event (on-vps-ready)	—	pulse:pulse

flow

Node	What it does	Kind	Inputs	Outputs
branch	Take one path or the other depending on a condition.	control (branch)	exec:pulse, condition:boolean	true:pulse, false:pulse
delay	Wait, then continue.	control (delay)	exec:pulse, dt:number, seconds:number	then:pulse
emit_event	Raise a trigger from this object, which events and scripts can hear.	effect	event:string, exec:pulse	then:pulse
for_each	Run the body once per item in a list.	control (for_each)	exec:pulse, list:any	loop:pulse, item:any, index:number, then:pulse
gate	Let the pulse through only while a condition holds.	control (gate)	exec:pulse, open:boolean	then:pulse
once	Let the pulse through the first time only.	control (once)	exec:pulse	then:pulse
open_scene	Switch to another scene.	effect	scene:string, exec:pulse	then:pulse
open_space	Switch to another space.	effect	space:string, exec:pulse	then:pulse
repeat	Run the body a fixed number of times.	control (repeat)	exec:pulse, count:number	loop:pulse, index:number, then:pulse
sequence	Run several chains in a defined order.	effect	exec:pulse	first:pulse, second:pulse, third:pulse

functions

Node	What it does	Kind	Inputs	Outputs
call_patch	Runs another patch — how you reuse a graph.	data	—	—
call_script	Calls a function exported by a script.	data	value:number	result:number

globals

Node	What it does	Kind	Inputs	Outputs
get_global	Reads one.	data	—	value:number
on_global_change	Fires when a shared value changes.	event (global)	—	pulse:pulse, value:number
set_global	Stores a value shared with every graph, script and event.	effect	value:number, exec:pulse	then:pulse

io

Node	What it does	Kind	Inputs	Outputs
patch_input	An input socket on this patch when it is used by another.	data	—	value:number
patch_output	An output socket.	data	value:number	—

lifecycle

Node	What it does	Kind	Inputs	Outputs
create_entity	Makes a new, empty object.	effect	name:string, parent:object, exec:pulse	then:pulse, object:object
destroy	Removes an object.	effect	object:object, exec:pulse	then:pulse
spawn	Makes an object from a resource — a model, an image, a sound.	effect	resource:string, parent:object, exec:pulse	then:pulse, object:object

list

Node	What it does	Kind	Inputs	Outputs
list	Builds a list from its inputs; drag the handle for more slots.	data	a:any, b:any, c:any, d:any	value:any
list_get	The item at an index.	data	list:any, index:number	item:any
list_length	How many items.	data	list:any	result:number
list_push	Adds an item to the end.	data	list:any, item:any	result:any

logic

Node	What it does	Kind	Inputs	Outputs
and	True when both inputs are true.	data	a:boolean, b:boolean	result:boolean
equals	True when the two inputs match.	data	a:number, b:number	result:boolean
greater_or_equal	Larger, or the same.	data	a:number, b:number	result:boolean
greater_than	True when the first is larger.	data	a:number, b:number	result:boolean
if_else	Pick one of two values by a condition — the data twin of branch.	data	condition:boolean, then:number, else:number	result:number
less_or_equal	Smaller, or the same.	data	a:number, b:number	result:boolean
less_than	True when the first is smaller.	data	a:number, b:number	result:boolean
not	Flips true and false.	data	value:boolean	result:boolean
not_equal	True when they differ.	data	a:number, b:number	result:boolean
or	True when either is.	data	a:boolean, b:boolean	result:boolean
same	True when two objects are the same object.	data	a:any, b:any	result:boolean
select	Pick a value from several by index.	data	condition:boolean, then:any, else:any	result:any

math

Node	What it does	Kind	Inputs	Outputs
abs	Drops the sign.	data	value:number	result:number
acos	Inverse cosine.	data	value:number	result:number
add	Adds.	data	a:number, b:number	result:number
asin	Inverse sine.	data	value:number	result:number
atan	Inverse tangent.	data	value:number	result:number
atan2	The angle to a point, handling every quadrant — how you aim at something.	data	a:number, b:number	result:number
ceil	Rounds up.	data	value:number	result:number
clamp	Keeps a value inside a range.	data	value:number, min:number, max:number	result:number
cos	Cosine.	data	value:number	result:number
deg_to_rad	Degrees to radians.	data	value:number	result:number
divide	Divides.	data	a:number, b:number	result:number
exp	e to the power of the input.	data	value:number	result:number
floor	Rounds down.	data	value:number	result:number
lerp	Blends between two values — 0 gives the first, 1 the second.	data	a:number, b:number, t:number	result:number
log	Natural logarithm.	data	value:number	result:number
max	The larger of two.	data	a:number, b:number	result:number
min	The smaller of two.	data	a:number, b:number	result:number
modulo	The remainder — the usual way to wrap a value round.	data	a:number, b:number	result:number
multiply	Multiplies.	data	a:number, b:number	result:number
power	Raises to a power.	data	a:number, b:number	result:number
rad_to_deg	Radians to degrees.	data	value:number	result:number
random	A random number in a range.	data	min:number, max:number	value:number
remap	Rescales a value from one range to another. Extremely useful; reach for it often.	data	value:number, inMin:number, inMax:number, outMin:number, outMax:number	result:number
round	Rounds to nearest.	data	value:number	result:number
sign	Gives −1, 0 or 1.	data	value:number	result:number
sin	Sine — the building block of anything that oscillates.	data	value:number	result:number
sqrt	Square root.	data	value:number	result:number
subtract	Subtracts.	data	a:number, b:number	result:number
tan	Tangent.	data	value:number	result:number

messaging

Node	What it does	Kind	Inputs	Outputs
on_message	Receives one.	event (message)	—	pulse:pulse, payload:object
post_message	Sends a named message to anything listening.	effect	payload:object, exec:pulse	then:pulse

net

Node	What it does	Kind	Inputs	Outputs
net_connected	True when a room is actually open.	data	—	value:boolean
net_despawn	Removes one everywhere.	effect	id:string, exec:pulse	then:pulse
net_id	This participant’s id — the usual key for their own state.	data	—	value:string
net_peer_count	How many.	data	—	value:number
net_peers	Everyone currently in the room.	data	—	value:any
net_send	Sends a message to everyone else in the room.	effect	data:any, exec:pulse	then:pulse
net_spawn	Creates an object on every participant’s screen.	effect	resource:string, position:vector, rotation:vector, exec:pulse	then:pulse, id:string
net_state_get	Reads it.	data	—	value:any
net_state_set	Writes to the shared state everyone can read.	effect	value:any, exec:pulse	then:pulse
on_net_join	Someone joined.	event (net-join)	—	pulse:pulse, peer:string
on_net_leave	Someone left.	event (net-leave)	—	pulse:pulse, peer:string
on_net_message	Receives one.	event (net)	—	pulse:pulse, data:any, from:string
on_net_state	Fires when a shared value changes.	event (net-state)	—	pulse:pulse, value:any

physics

Node	What it does	Kind	Inputs	Outputs
apply_force	A continuous push while it runs — for thrust and wind.	effect	object:object, force:vector, exec:pulse	then:pulse
apply_impulse	A single push — for jumps, hits and launches.	effect	object:object, force:vector, exec:pulse	then:pulse
apply_torque	A twisting push.	effect	object:object, torque:vector, exec:pulse	then:pulse
get_angular_velocity	How fast it is spinning.	data	object:object	value:vector
get_speed	How fast, ignoring direction.	data	object:object	value:number
get_velocity	How fast and which way something is moving.	data	object:object	value:vector
is_sleeping	True when a body has settled and stopped simulating.	data	object:object	value:boolean
raycast	Fires a ray and reports what it hit.	control (await)	from:vector, to:vector, ignore:object, exec:pulse	then:pulse, hit:boolean, object:object, point:vector, normal:vector, distance:number
set_angular_velocity	Sets spin outright.	effect	object:object, velocity:vector, exec:pulse	then:pulse
set_gravity	Changes gravity for the whole scene.	effect	gravity:vector, exec:pulse	then:pulse
set_velocity	Sets speed and direction outright.	effect	object:object, velocity:vector, exec:pulse	then:pulse
sleep_body	Puts one to sleep.	effect	object:object, exec:pulse	then:pulse
wake_body	Wakes a settled body.	effect	object:object, exec:pulse	then:pulse

state

Node	What it does	Kind	Inputs	Outputs
counter	Counts pulses. Survives between frames.	effect	inc:pulse	then:pulse, count:number
smooth	Eases a value toward a target each frame — the cheap way to make anything feel less rigid.	effect	tick:pulse, target:number, rate:number	then:pulse, value:number
timer	Counts seconds while it runs.	effect	tick:pulse, add:number	then:pulse, time:number
toggle	Flips between true and false each pulse.	effect	exec:pulse	then:pulse, value:boolean

string

Node	What it does	Kind	Inputs	Outputs
concat	Joins text together.	data	a:string, b:string	result:string
string_length	How many characters.	data	value:string	result:number
to_number	Reads a number out of text.	data	value:string	result:number
to_string	Turns a value into text — for labels and score displays.	data	value:number	result:string

ui

Node	What it does	Kind	Inputs	Outputs
get_divkit	Reads a variable from an interface card.	data	object:object	value:any
set_divkit	Writes one — how a graph updates a score or a label.	effect	object:object, value:any, exec:pulse	then:pulse

variables

Node	What it does	Kind	Inputs	Outputs
get_variable	Reads it back.	data	—	value:any
set_variable	Stores a value for this graph.	effect	value:any, exec:pulse	then:pulse

vector

Node	What it does	Kind	Inputs	Outputs
vector_add	Adds two vectors.	data	a:vector, b:vector	result:vector
vector_cross	Cross product — a direction perpendicular to both.	data	a:vector, b:vector	result:vector
vector_distance	Distance between two points.	data	a:vector, b:vector	result:number
vector_dot	Dot product — how much two directions agree. Use it to tell "in front" from "behind".	data	a:vector, b:vector	result:number
vector_length	How long the vector is.	data	v:vector	result:number
vector_lerp	Blends between two positions.	data	a:vector, b:vector, t:number	result:vector
vector_normalize	Same direction, length 1.	data	v:vector	result:vector
vector_scale	Multiplies a vector by a number.	data	v:vector, s:number	result:vector
vector_subtract	Subtracts one from the other — the direction from B to A.	data	a:vector, b:vector	result:vector