Souichirou/Singularity
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Singularity/Library/PackageCache/com.unity.visualscripting@1.../Documentation~/vs-scripts-reference.md
2024-05-06 11:45:45 -07:00

12 KiB
Raw Blame History

Script Graph nodes

Visual scripting has four nodes that you can use to identify and manipulate the Script Graphs assigned to a GameObject and its Script Machines:

Set Script Graph

You can use the Set Script Graph node to assign a Script Graph to a specific Script Machine, or to the first Script Machine attached to a specific GameObject.

The Set Script Graph node

Item Description
Node Parameters
The letter A in a blue circle, matching the label on the Set Script Graph node image. Container Type Specifies whether the Target is a GameObject or Script Machine.
Input Ports
The letter B in a blue circle, matching the label on the Set Script Graph node image. Enter (Input Trigger) The execution input trigger for the node.
The letter C in a blue circle, matching the label on the Set Script Graph node image. Target (GameObject or Script Machine) The GameObject or Script Machine where the node sets the Graph.
The letter D in a blue circle, matching the label on the Set Script Graph node image. Graph (Script Graph Asset) The Script Graph the node sets on the Target.
Output Ports
The letter E in a blue circle, matching the label on the Set Script Graph node image. Exit (Output Trigger) The execution output trigger.
The letter F in a blue circle, matching the label on the Set Script Graph node image. Graph (Script Graph Asset; Optional) Outputs the Graph.

Setting the required node parameters and inputs

The Set Script Graph node has one required input parameter, called Container Type, which is set using the dropdown in the node's header. The Container Type specifies what component type the node should expect as an input for its Target:

  • If you choose GameObject, the node expects to receive a GameObject, and assigns the graph to the first Script Machine attached to that GameObject.

  • If you choose Script Machine, the node expects to receive a Script Machine, and you can specify the exact Script Machine where you want to set your Script Graph.

Depending on which Container Type you select, the icon displayed next to the Target input port on the node changes:

Container Type Target Icon
GameObject The GameObject icon
Script Machine The Script Machine icon

The node has three input ports, located on the left side. The first port, Enter, connects to the node that should start the execution of the Set Script Graph node.

The other two ports collect the Set Script Graph node's required input data:

  • The Target, or the GameObject or Script Machine where you want to set a Script Graph.

  • The Graph, or the Script Graph to assign to the GameObject or Script Machine.

Outputs

The Set Script Graph node has two output ports, located on the right side.

The first port, Exit, establishes the connection to the node that should execute after the Set Script Graph node has finished.

The second port, Graph, can output the Script Graph that you assigned using the node.

Has Script Graph

The Has Script Graph node allows you to determine whether a GameObject or Script Machine has a specific Script Graph assigned to it.

The Has Script Graph node

Item Description
Node Parameters
The letter A in a blue circle, matching the label on the Set Script Graph node image. Container Type Specify whether the Target is a GameObject or Script Machine.
Input Ports
The letter B in a blue circle, matching the label on the Set Script Graph node image. Enter (Input Trigger) The execution input trigger for the node.
The letter C in a blue circle, matching the label on the Set Script Graph node image. Target (GameObject or Script Machine) The GameObject or Script Machine where the node should check for the Graph.
The letter D in a blue circle, matching the label on the Set Script Graph node image. Graph (Script Graph Asset) The Script Graph to search for on the GameObject or Script Machine.
Output Ports
The letter E in a blue circle, matching the label on the Set Script Graph node image. Exit (Output Trigger) The execution output trigger, which starts execution of the next node in the flow after checking for the specified Script Graph.
The letter F in a blue circle, matching the label on the Set Script Graph node image. Has Graph (Boolean) Outputs true if the node found the specified Script Graph, false if not.

Setting the required node parameters and inputs

The Has Script Graph node has one required input parameter, called Container Type, which is set using the dropdown in the node's header. The Container Type specifies what component type the node should expect as an input for its Target:

  • If you choose GameObject, the node expects to receive a GameObject, and checks for the graph on the first Script Machine attached to that GameObject.

  • If you choose Script Machine, the node expects to receive a Script Machine, and you can specify the exact Script Machine where you want to check for the Script Graph.

Depending on which Container Type you select, the icon displayed next to the Target input port on the node changes:

Container Type Target Icon
GameObject The GameObject icon
Script Machine The Script Machine icon

The node has three input ports, located on the left side. The first port, Enter, connects to the node that should start the execution of the Has Script Graph node.

The other two ports collect the Has Script Graph node's required input data:

  • The Target, or the GameObject or Script Machine where you want to check for a Script Graph.

  • The Graph, or the Script Graph to search for on the GameObject or Script Machine.

Outputs

The Has Script Graph node returns true if it finds the specified Script Graph. Otherwise, it returns false.

You can use a control node connected to the Has Script Graph's output port to change what your script does next, based on the result from Has Script Graph. For more information about control nodes, see Control nodes.

Get Script Graph

The Get Script Graph node returns the first Script Graph set on a GameObject.

The Get Script Graph node

Item Description
Input Ports
The letter A in a blue circle, matching the label on the Set Script Graph node image. GameObject (GameObject) The GameObject where the node should retrieve a set Script Graph.
Output Ports
The letter B in a blue circle, matching the label on the Set Script Graph node image. Graph (Script Graph Asset) Outputs the first or only Script Graph set on the GameObject, or null if there is no set Script Graph.

Setting the required node parameters and inputs

The Get Script Graph node is a data node. It can't control any logic in your script, and is only used to return data.

The node has a single input port, located on the left side, which collects the node's required input data:

  • The GameObject where the node should retrieve the Script Graph. You can choose a specific GameObject, or leave the default selection as This to use the GameObject where your script is currently running.

Outputs

The Get Script Graph node has a single output port, located on the right side. The output port returns the GameObject's first set Script Graph, or null, if there is no set Script Graph.

Note

The Get Script Graph node returns only the first Script Graph set on a GameObject. To return all Script Graphs set on a GameObject, use the Get Script Graphs node.

Get Script Graphs

The Get Script Graphs node returns a list of all Script Graphs set on a GameObject.

The Get Script Graphs node

Item Description
Input Ports
The letter A in a blue circle, matching the label on the Set Script Graph node image. GameObject (GameObject) The GameObject where the node should retrieve a list of set Script Graphs.
Output Ports
The letter B in a blue circle, matching the label on the Set Script Graph node image. Graphs (List of Script Graph Assets) Outputs a list of all Script Graphs set on the GameObject, or an empty list if there are no set Script Graphs.

Setting the required node parameters and inputs

The Get Script Graphs node is a data node. It can't control any logic in your script, and is only used to return data.

The node has a single input port, located on the left side, which collects the node's required input data:

  • The GameObject where the node should retrieve a list of Script Graphs. You can choose a specific GameObject, or leave the default selection as This to use the GameObject where your script is currently running.

Outputs

The Get Script Graphs node has a single output port, located on the right side. The output port returns a list of all set Script Graphs for the GameObject, or an empty list, if there are no set Script Graphs.