Create a Custom Scripting Event node

You can create a Custom Scripting Event node with a C# script. With C#, you can customize all aspects of your Custom Scripting Event, unlike a Visual Scripting custom Event. For more information on the different types of custom Events, see Custom Events.

To create a Custom Scripting Event node:

[!includeopen-project-window]
[!includeright-click-project]
[!includecreate-c-script-project]
Enter a name, such as MyEventNode, for the new script file.
Press Enter.
[!includeopen-new-external-code]

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

using Unity.VisualScripting;
using UnityEngine;

//Register a string name for your Custom Scripting Event to hook it to an Event. You can save this class in a separate file and add multiple Events to it as public static strings.
public static class EventNames
{
  public static string MyCustomEvent = "MyCustomEvent";
}

[UnitTitle("On my Custom Event")]//The Custom Scripting Event node to receive the Event. Add "On" to the node title as an Event naming convention.
[UnitCategory("Events\\MyEvents")]//Set the path to find the node in the fuzzy finder as Events > My Events.
public class MyCustomEvent : EventUnit<int>
{
  [DoNotSerialize]// No need to serialize ports.
  public ValueOutput result { get; private set; }// The Event output data to return when the Event is triggered.
  protected override bool register => true;

  // Add an EventHook with the name of the Event to the list of Visual Scripting Events.
  public override EventHook GetHook(GraphReference reference)
  {
      return new EventHook(EventNames.MyCustomEvent);
  }
  protected override void Definition()
  {
      base.Definition();
      // Setting the value on our port.
      result = ValueOutput<int>(nameof(result));
  }
  // Setting the value on our port.
  protected override void AssignArguments(Flow flow, int data)
  {
      flow.SetValue(result, data);
  }
}

[!includesave-script]
[!includereturn-unity]
[!includeregen-node-library]
Open a Script Graph where you want to add your new node.
[!includeopen-fuzzy-finder].
Go to Events > My Events.
Select your On My Custom Event node to add it to the graph.

Note

If you change the UnitTitle or UnitCategory attributes for the node in your code, the node appears in the location in the fuzzy finder with the name that you specify.

After you regenerate your Node Library, the Custom Scripting Event node appears in the fuzzy finder. If you didn't change the [UnitCategory] or [UnitTitle] from the sample code, then the fuzzy finder displays the node under Events > MyEvents, as the On my Custom Event node. For more information on the fuzzy finder, see The interface.

Next steps

After you create your Custom Scripting Event node, you can create a Custom Scripting Event Sender node to trigger your Event from another Script Graph or location in the same Script Graph. You can also create a script to trigger your Event from code or create a script to listen to your Event.

3.9 KiB Raw Blame History

Create a Custom Scripting Event node

Next steps

3.9 KiB

Raw Blame History