Listen to a Custom Scripting Event from a C# script

You can use a C# script to listen for or receive a Custom Scripting Event from a Script Graph. You can use an Event receiver script to execute additional logic in your application.

Note

Before you can create a listener for a Custom Scripting Event node, you must create a Custom Scripting Event node and its trigger. The examples below are based on the previous example to create a Custom Scripting Event node. For more information, see Create a Custom Scripting Event node and Create a Custom Scripting Event Sender node.

To receive a Custom Scripting Event from a Script Graph:

Go to Window > General > Project, or press Ctrl+5 (macOS: Cmd+5) to open the Project window.
Right-click a folder in the Project window's folder list or anywhere in the Project window's preview pane.
Go to Create > C# Script.
Enter a name, such as EventReceiver, for the new script file.
Press Enter.
Double-click the new C# file. Unity opens the file in the program you specified in your preferences, under External Script Editor.

Note

For more information on script editors in Unity, see the Integrated development environment (IDE) support in the Unity User Manual.

In your external editor, copy and paste the following code into your C# script:

using Unity.VisualScripting;
using UnityEngine;
public class EventReceiver : MonoBehaviour
{
  void Start()
  {
      EventBus.Register<int>(EventNames.MyCustomEvent, i =>
      {
          Debug.Log("RECEIVED " + i);
      });
  }
}

Save your script file.
Return to the Unity Editor.
Go to Window > General > Hierarchy, or press Ctrl+4 (macOS: Cmd+4) to open the Hierarchy window.
Do one of the following in the Hierarchy window:
- Select an existing GameObject where you want to attach the new script.
- Select Add New (+) and in the menu, select a new GameObject to add to your scene from any of the available options. You can also right-click anywhere in the Hierarchy window and select the same options in the context menu.
With the GameObject selected in the Hierarchy window, go to Window > General > Inspector, or press Ctrl+3 (macOS: Cmd+3) to open the Inspector window.
Select Add Component.
In the Component menu, enter the name of the script file.
Select it to add it to the GameObject.
Select Play from the Unity Editor's Toolbar to enter Play mode. If you have a Custom Scripting Event Sender node or a C# script to trigger your Event, you can trigger your Custom Scripting Event.

The EventReceiver script logs the following message to the console every time the Event is triggered, as shown in the following image.