Skip to main content

Nodes

Break

Breaks loop execution when executed within the body of any loop based node. For example: For, Foreach, and While nodes. Execution will continue as if all loops have completed.

Call External Execution

This node allows you to start execution on another script. When used in combination with a ScriptReference node you can select an Execution Input node from the inspector. Otherwise you must type the name of the function to call.

Callback

Represents a section of code that can be executed later, similar to a JavaScript function. Automatically adds argument ports to match the signature of any callback port it's connected to.

Callback Input

Adds an input for a callback into the sub-graph.

Constant Number

Constant Number value.

Constant Number array

Constant Number array value.

Constant Reference

Constant reference to a resource.

Constant bool

Constant bool value.

Constant bool array

Constant bool array value.

Constant mat2

Constant mat2 value.

Constant mat2 array

Constant mat2 array value.

Constant mat3

Constant mat3 value.

Constant mat3 array

Constant mat3 array value.

Constant mat4

Constant mat4 value.

Constant mat4 array

Constant mat4 array value.

Constant string

Constant string value.

Constant string array

Constant string array value.

Constant vec2

Constant vec2 value.

Constant vec2 array

Constant vec2 array value.

Constant vec3

Constant vec3 value.

Constant vec3 array

Constant vec3 array value.

Constant vec4

Constant vec4 value.

Constant vec4 array

Constant vec4 array value.

Construct Array

Creates a new array with an option in the inspector to choose the type it holds.

Construct Map

Creates a new map with an option in the inspector to choose the types it holds.

Continue

Continues to the next loop when executed within the body of any loop based node. For example: For, Foreach, and While nodes. Execution will continue on the next loop as if the current loop had completed.

Custom Node

Custom node defined by a JavaScript file.

Execute Callback

Executes a Callback node.

ExecutionInput

Creates an execution input to the graph. If used at the top level, adds a function to the script's api object.

ExecutionOutput

Adds an execution output port to the sub-graph.

For

Executes the Body execution port loopCount times, increasing Number each time. Number returns 0 on the first iteration, and increases by 1 on each iteration until it reaches loopCount-1 on the final loop. After all loops are completed, the Then port is executed.

Foreach

Executes the Body execution port once for each element of the array, providing the current element in the Object port. After all items have been iterated through, the Then port is executed.

Get Arguments

Needed for executing Execution flows that contain arguments. The output ports dynamically change to provide whatever arguments are carried on the execution flow.

Get External Variable

Get a variable from another script graph. If this is connected to a ScriptReference node you can select which variable from a drop down in the inspector, otherwise you must provide the variable name as a string. Tip: This can retrieve variables from the api object of JavaScript based scripts as well.

Get Pass Property

Returns the property with name propertyName found on the Pass.

Get VFX Property

Gets a property from the VFXAsset. Tip: If connected to a Constant Asset Reference node created by dragging your VFXAsset into the graph you'll be able to select the property from a dropdown in the inspector.

Get Variable

Returns the current value of the variable. The variable can be changed in the node inspector panel.

If

Executes the True port if condition is true, and the False port if condition is false.

Iterator

Returns the next object in the array each time it's executed, looping back to the first object after reaching the end.

Number Array Input

Adds an input for a number array value into the graph or sub-graph.

Number Array Output

Outputs a number array from the sub-graph, creating an output port on it.

Number Input

Adds an input for a number value into the graph or sub-graph.

Number Output

Outputs a number from the sub-graph, creating an output port on it.

Object Array Input

Adds an input for an object array value into the graph or sub-graph.

Object Array Output

Outputs an object array from the sub-graph, creating an output port on it.

Object Input

Adds an input for an object value into the graph or sub-graph.

Object Output

Outputs an object from the sub-graph, creating an output port on it.

OnAwake

Initialization event. Executes once when the ScriptComponent hosting the script is initialized.

Passthrough

Small non-functional node used for organizing graphs. Can be created by clicking on any connection line.

Script Reference

This specialized node functions like a ScriptComponent input but allows you to specify a script graph which the ScriptComponent must be an instance of. This allows you to reference functions and variables from that script graph in this one. Tip: Try creating it by dragging a script graph asset into your graph.

Sequence

Executes each of the output ports in order. Useful for organizing a long sequence of nodes into more manageable sections.

Set External Variable

Set a variable on another script graph. If this is connected to a ScriptReference node you can select which variable from a drop down in the inspector, otherwise you must provide the variable name as a string. Tip: This can set variables on the api object of JavaScript based scripts as well.

Set Pass Property

Sets a property on the Pass to the given value.

Set VFX Property

Sets a property on the VFXAsset. Tip: If connected to a Constant Asset Reference node created by dragging your VFXAsset into the graph you'll be able to select the property from a dropdown in the inspector.

Set Variable

Sets the variable to a new value. The variable can be changed in the node inspector panel.

Sticky

Sub-Graph

Encapsulates a group of nodes into a single node with exposed imports and exports.

This Script

Returns the ScriptComponent hosting this script.

While

Continues to execute the Body port as long as condition is true. Once condition is false, the loop ends and the Then port is executed.

bool Array Input

Adds an input for a bool array value into the graph or sub-graph.

bool Array Output

Outputs a bool array from the sub-graph, creating an output port on it.

bool Input

Adds an input for a bool value into the graph or sub-graph.

bool Output

Outputs a bool value from the sub-graph, creating an output port on it.

mat2 Array Input

Adds an input for a mat2 array value into the graph or sub-graph.

mat2 Array Output

Outputs a mat2 array from the sub-graph, creating an output port on it.

mat2 Input

Adds an input for a mat2 value into the graph or sub-graph.

mat2 Output

Outputs a mat2 from the sub-graph, creating an output port on it.

mat3 Array Input

Adds an input for a mat3 array value into the graph or sub-graph.

mat3 Array Output

Outputs a mat3 array from the sub-graph, creating an output port on it.

mat3 Input

Adds an input for a mat3 value into the graph or sub-graph.

mat3 Output

Outputs a mat3 from the sub-graph, creating an output port on it.

mat4 Array Input

Adds an input for a mat4 array value into the graph or sub-graph.

mat4 Array Output

Outputs a mat4 array from the sub-graph, creating an output port on it.

mat4 Input

Adds an input for a mat4 value into the graph or sub-graph.

mat4 Output

Outputs a mat4 from the sub-graph, creating an output port on it.

string Array Input

Adds an input for a string array value into the graph or sub-graph.

string Array Output

Outputs a string array from the sub-graph, creating an output port on it.

string Input

Adds an input for a string value into the graph or sub-graph.

string Output

Outputs a string from the sub-graph, creating an output port on it.

vec2 Array Input

Adds an input for a vec2 array value into the graph or sub-graph.

vec2 Array Output

Outputs a vec2 array from the sub-graph, creating an output port on it.

vec2 Input

Adds an input for a vec2 value into the graph or sub-graph.

vec2 Output

Outputs a vec2 from the sub-graph, creating an output port on it.

vec3 Array Input

Adds an input for a vec3 array value into the graph or sub-graph.

vec3 Array Output

Outputs a vec3 array from the sub-graph, creating an output port on it.

vec3 Input

Adds an input for a vec3 value into the graph or sub-graph.

vec3 Output

Outputs a vec3 from the sub-graph, creating an output port on it.

vec4 Array Input

Adds an input for a vec4 array value into the graph or sub-graph.

vec4 Array Output

Outputs a vec4 array from the sub-graph, creating an output port on it.

vec4 Input

Adds an input for a vec4 value into the graph or sub-graph.

vec4 Output

Outputs a vec4 from the sub-graph, creating an output port on it.