Rig VMController

Rig VMController

Choose your operating system:

Windows

macOS

Linux

On this page

Actions

Add Array Node

Adds a Array Node to the edited Graph. This causes a NodeAdded modified event.

Target is Rig VMController

Add Array Node from Object Path

Adds a Array Node to the edited Graph given a struct object path name. This causes a NodeAdded modified event.

Target is Rig VMController

Add Array Pin

Adds an array element pin to the end of an array pin. This causes a PinArraySizeChanged modified event.

Target is Rig VMController

Add Branch Node

Adds a branch node to the graph. Branch nodes can be used to split the execution of into multiple branches, allowing to drive behavior by logic.

Target is Rig VMController

Add Comment Node

Adds a Comment Node to the edited Graph. Comments can be used to annotate the Graph. This causes a NodeAdded modified event.

Target is Rig VMController

Add Enum Node

Adds an enum node to the graph Enum nodes can be used to represent constant enum values within the graph

Target is Rig VMController

Add Exposed Pin

Adds an exposed pin to the graph controlled by this

Target is Rig VMController

Add Free Reroute Node

Adds a free Reroute Node

Target is Rig VMController

Add Function Reference Node

Adds a function reference / invocation to the graph

Target is Rig VMController

Add Function to Library

Adds a function definition to a function library graph

Target is Rig VMController

Add if Node

Adds an if node to the graph. If nodes can be used to pick between two values based on a condition.

Target is Rig VMController

Add if Node from Struct

Add if Node from Struct

Target is Rig VMController

Add Injected Node

Adds a Function / Struct Node to the edited Graph as an injected node UnitNode represent a RIGVM_METHOD declaration on a USTRUCT. This causes a NodeAdded modified event.

Target is Rig VMController

Add Injected Node from Struct Path

Adds a Function / Struct Node to the edited Graph as an injected node UnitNode represent a RIGVM_METHOD declaration on a USTRUCT. This causes a NodeAdded modified event.

Target is Rig VMController

Add Link

Adds a link to the graph. This causes a LinkAdded modified event.

Target is Rig VMController

Add Local Variable

Add a local variable to the graph

Target is Rig VMController

Add Local Variable from Object Path

Add a local variable to the graph given a struct object path name.

Target is Rig VMController

Add Parameter Node

Adds a Parameter Node to the edited Graph. Parameters represent input or output arguments to the Graph / Function. Input Parameters are constant values / literals. This causes a NodeAdded modified event.

Target is Rig VMController

Add Parameter Node from Object Path

Adds a Parameter Node to the edited Graph given a struct object path name. Parameters represent input or output arguments to the Graph / Function. Input Parameters are constant values / literals. This causes a NodeAdded modified event.

Target is Rig VMController

Add Prototype Node

Adds a prototype node to the graph.

Target is Rig VMController

Add Reroute Node on Link

Adds a Reroute Node on an existing Link to the edited Graph. Reroute Nodes can be used to visually improve the data flow, they don't require any additional memory though and are purely

  1. This causes a NodeAdded modified event.

Target is Rig VMController

Add Reroute Node on Link Path

Adds a Reroute Node on an existing Link to the edited Graph given the Link's string representation. Reroute Nodes can be used to visually improve the data flow, they don't require any additional memory though and are purely

  1. This causes a NodeAdded modified event.

Target is Rig VMController

Add Reroute Node on Pin

Adds a Reroute Node on an existing Pin to the editor Graph. Reroute Nodes can be used to visually improve the data flow, they don't require any additional memory though and are purely

  1. This causes a NodeAdded modified event.

Target is Rig VMController

Add Select Node

Adds a select node to the graph. Select nodes can be used to pick between multiple values based on an index.

Target is Rig VMController

Add Select Node from Struct

Add Select Node from Struct

Target is Rig VMController

Add Unit Node

Adds a Function / Struct Node to the edited Graph. UnitNode represent a RIGVM_METHOD declaration on a USTRUCT. This causes a NodeAdded modified event.

Target is Rig VMController

Add Unit Node from Struct Path

Adds a Function / Struct Node to the edited Graph given its struct object path name. UnitNode represent a RIGVM_METHOD declaration on a USTRUCT. This causes a NodeAdded modified event.

Target is Rig VMController

Add Variable Node

Adds a Variable Node to the edited Graph. Variables represent local work state for the function and can be read from and written to. This causes a NodeAdded modified event.

Target is Rig VMController

Add Variable Node from Object Path

Adds a Variable Node to the edited Graph given a struct object path name. Variables represent local work state for the function and can be read from (bIsGetter == true) or written to (bIsGetter == false). This causes a NodeAdded modified event.

Target is Rig VMController

Bind Pin to Variable

Binds a pin to a variable (or removes the binding given NAME_None) This causes a PinBoundVariableChanged modified event.

Target is Rig VMController

Break All Links

Removes all links on a given pin from the graph. This might cause multiple LinkRemoved modified event.

Target is Rig VMController

Break Link

Removes a link from the graph. This causes a LinkRemoved modified event.

Target is Rig VMController

Can Import Nodes from Text

Exports the given nodes as text

Target is Rig VMController

Cancel Undo Bracket

Cancels an undo bracket / scoped transaction. This is primarily useful for Python. This causes a UndoBracketCanceled modified event.

Target is Rig VMController

Change Exposed Pin Type

Changes the type of an exposed pin in the graph controlled by this

Target is Rig VMController

Clear Array Pin

Removes all (but one) array element pin from an array pin. This causes a PinArraySizeChanged modified event.

Target is Rig VMController

Clear Node Selection

Deselects all currently selected nodes in the graph. This might cause several NodeDeselected modified event.

Target is Rig VMController

Close Undo Bracket

Closes an undo bracket / scoped transaction. This is primarily useful for Python. This causes a UndoBracketClosed modified event.

Target is Rig VMController

Collapse Nodes

Turns a series of nodes into a Collapse node

Target is Rig VMController

Duplicate Array Pin

Duplicates an array element pin. This causes a PinArraySizeChanged modified event.

Target is Rig VMController

Eject Node from Pin

Ejects the last injected node on a pin

Target is Rig VMController

Enable Reporting

Enables or disables the error reporting of this Controller.

Target is Rig VMController

Expand Library Node

Turns a library node into its contained nodes

Target is Rig VMController

Export Nodes to Text

Exports the given nodes as text

Target is Rig VMController

Export Selected Nodes to Text

Exports the selected nodes as text

Target is Rig VMController

Generate Python Commands

Generate Python Commands

Target is Rig VMController

Get Graph

Returns the currently edited Graph of this controller.

Target is Rig VMController

Get Pin Default Value

Returns the default value of a pin given its pinpath.

Target is Rig VMController

Get Top Level Graph

Returns the top level graph

Target is Rig VMController

Import Nodes from Text

Exports the given nodes as text

Target is Rig VMController

Insert Array Pin

Inserts an array element pin into an array pin. This causes a PinArraySizeChanged modified event.

Target is Rig VMController

Is Reporting Enabled

Returns true if reporting is enabled

Target is Rig VMController

Localize Function

Copies a function declaration into this graph's local function library

Target is Rig VMController

Localize Functions

Copies a series of function declaratioms into this graph's local function library

Target is Rig VMController

Make Bindings from Variable Node

Turns a variable node into one or more bindings

Target is Rig VMController

Make Variable Node from Binding

Turns a binding to a variable node

Target is Rig VMController

Modified Event Dynamic

Modified Event Dynamic

On External Variable Removed

Removes all nodes related to a given variable

Target is Rig VMController

On External Variable Renamed

Renames the variable name in all relevant nodes

Target is Rig VMController

On External Variable Type Changed

Changes the data type of all nodes matching a given variable name

Target is Rig VMController

On External Variable Type Changed from Object Path

On External Variable Type Changed from Object Path

Target is Rig VMController

Open Undo Bracket

Opens an undo bracket / scoped transaction for a series of actions to be performed as one step on the Undo stack. This is primarily useful for Python. This causes a UndoBracketOpened modified event.

Target is Rig VMController

Pop Graph

Pops the last graph off the stack This causes a GraphChanged modified event.

Target is Rig VMController

Promote Collapse Node to Function Reference Node

Turns a collapse node into a function node

Target is Rig VMController

Promote Function Reference Node to Collapse Node

Turns a collapse node into a function node

Target is Rig VMController

Promote Pin to Variable

Promotes a pin to a variable

Target is Rig VMController

Push Graph

Pushes a new graph to the stack This causes a GraphChanged modified event.

Target is Rig VMController

Redo

Re-does the last action on the stack. Note: This should really only be used for unit tests, use the GEditor's main Undo method instead.

Target is Rig VMController

Refresh Variable Node

Refreshes the variable node with the new data

Target is Rig VMController

Remove Array Pin

Removes an array element pin from an array pin. This causes a PinArraySizeChanged modified event.

Target is Rig VMController

Remove Exposed Pin

Removes an exposed pin from the graph controlled by this

Target is Rig VMController

Remove Function from Library

Removes a function from a function library graph

Target is Rig VMController

Remove Injected Node

Removes an injected node This causes a NodeRemoved modified event.

Target is Rig VMController

Remove Local Variable

Remove a local variable from the graph

Target is Rig VMController

Remove Node

Removes a node from the graph This causes a NodeRemoved modified event.

Target is Rig VMController

Remove Node by Name

Removes a node from the graph given the node's name. This causes a NodeRemoved modified event.

Target is Rig VMController

Rename Exposed Pin

Renames an exposed pin in the graph controlled by this

Target is Rig VMController

Rename Function

Renames a function in the function library

Target is Rig VMController

Rename Local Variable

Rename a local variable from the graph

Target is Rig VMController

Rename Node

Renames a node in the graph This causes a NodeRenamed modified event.

Target is Rig VMController

Rename Parameter

Renames a parameter in the graph. This causes a ParameterRenamed modified event.

Target is Rig VMController

Rename Variable

Renames a variable in the graph. This causes a VariableRenamed modified event.

Target is Rig VMController

Replace Parameter Node with Variable

Refreshes the variable node with the new data

Target is Rig VMController

Reset Pin Default Value

Resets the default value of a pin given its pinpath. This causes a PinDefaultValueChanged modified event.

Target is Rig VMController

Select Node

Selects a single node in the graph. This causes a NodeSelected / NodeDeselected modified event.

Target is Rig VMController

Select Node by Name

Selects a single node in the graph by name. This causes a NodeSelected / NodeDeselected modified event.

Target is Rig VMController

Set Array Pin Size

Sets the size of the array pin This causes a PinArraySizeChanged modified event.

Target is Rig VMController

Set Comment Text

Sets the comment text and properties of a comment node in the graph. This causes a CommentTextChanged modified event.

Target is Rig VMController

Set Comment Text by Name

Sets the comment text and properties of a comment node in the graph by name. This causes a CommentTextChanged modified event.

Target is Rig VMController

Set Exposed Pin Index

Sets the index for an exposed pin. This can be used to move the pin up and down on the node.

Target is Rig VMController

Set Graph

Sets the currently edited Graph of this controller. This causes a GraphChanged modified event.

Target is Rig VMController

Set Is Running Unit Test

Helper function to disable a series of checks that can be ignored during a unit test

Target is Rig VMController

Set Local Variable Default Value

Set Local Variable Default Value

Target is Rig VMController

Set Local Variable Type

Sets the type of the local variable

Target is Rig VMController

Set Local Variable Type from Object Path

Set Local Variable Type from Object Path

Target is Rig VMController

Set Node Category

Sets the category of a node in the graph. This causes a NodeCategoryChanged modified event.

Target is Rig VMController

Set Node Category by Name

Sets the category of a node in the graph. This causes a NodeCategoryChanged modified event.

Target is Rig VMController

Set Node Color

Sets the color of a node in the graph. This causes a NodeColorChanged modified event.

Target is Rig VMController

Set Node Color by Name

Sets the color of a node in the graph by name. This causes a NodeColorChanged modified event.

Target is Rig VMController

Set Node Description

Sets the function description of a node in the graph. This causes a NodeDescriptionChanged modified event.

Target is Rig VMController

Set Node Description by Name

Sets the keywords of a node in the graph. This causes a NodeDescriptionChanged modified event.

Target is Rig VMController

Set Node Keywords

Sets the keywords of a node in the graph. This causes a NodeKeywordsChanged modified event.

Target is Rig VMController

Set Node Keywords by Name

Sets the keywords of a node in the graph. This causes a NodeKeywordsChanged modified event.

Target is Rig VMController

Set Node Position

Sets the position of a node in the graph. This causes a NodePositionChanged modified event.

Target is Rig VMController

Set Node Position by Name

Sets the position of a node in the graph by name. This causes a NodePositionChanged modified event.

Target is Rig VMController

Set Node Selection

Selects the nodes given the selection This might cause several NodeDeselected modified event.

Target is Rig VMController

Set Node Size

Sets the size of a node in the graph. This causes a NodeSizeChanged modified event.

Target is Rig VMController

Set Node Size by Name

Sets the size of a node in the graph by name. This causes a NodeSizeChanged modified event.

Target is Rig VMController

Set Pin Default Value

Sets the default value of a pin given its pinpath. This causes a PinDefaultValueChanged modified event.

Target is Rig VMController

Set Pin Expansion

Sets the pin to be expanded or not This causes a PinExpansionChanged modified event.

Target is Rig VMController

Set Pin Is Watched

Sets the pin to be watched (or not) This causes a PinWatchedChanged modified event.

Target is Rig VMController

Set Remapped Variable

Sets the remapped variable on a function reference node

Target is Rig VMController

Set Reroute Compactness

Sets the compactness of a reroute node in the graph. This causes a RerouteCompactnessChanged modified event.

Target is Rig VMController

Set Reroute Compactness by Name

Sets the compactness of a reroute node in the graph by name. This causes a RerouteCompactnessChanged modified event.

Target is Rig VMController

Unbind Pin from Variable

Removes the binging of a pin to a variable This causes a PinBoundVariableChanged modified event.

Target is Rig VMController

Undo

Un-does the last action on the stack. Note: This should really only be used for unit tests, use the GEditor's main Undo method instead.

Target is Rig VMController