Class CustomEvent

A special named event with any amount of parameters called manually with the 'Trigger Custom Event' unit.

Inheritance
Object
GraphElement<FlowGraph>
Unit
EventUnit<CustomEventArgs>
GameObjectEventUnit<CustomEventArgs>
CustomEvent
Inherited Members
Namespace: Unity.VisualScripting
Syntax
[UnitCategory("Events")]
[UnitOrder(0)]
public sealed class CustomEvent : GameObjectEventUnit<CustomEventArgs>, IGraphElementWithData, IGraphEventHandler<CustomEventArgs>, IGameObjectEventUnit, IEventUnit, IUnit, IGraphElementWithDebugData, IGraphElement, IGraphItem, INotifiedCollectionItem, IDisposable, IPrewarmable, IAotStubbable, IIdentifiable, IGraphEventListener

Properties

argumentCount

Declaration
[DoNotSerialize]
[Inspectable]
[UnitHeaderInspectable("Arguments")]
public int argumentCount { get; set; }
Property Value
Type Description
Int32

argumentPorts

Declaration
[DoNotSerialize]
public List<ValueOutput> argumentPorts { get; }
Property Value
Type Description
List<ValueOutput>

hookName

Declaration
protected override string hookName { get; }
Property Value
Type Description
String
Overrides
Unity.VisualScripting.GameObjectEventUnit<Unity.VisualScripting.CustomEventArgs>.hookName

MessageListenerType

Declaration
public override Type MessageListenerType { get; }
Property Value
Type Description
Type
Overrides
Unity.VisualScripting.GameObjectEventUnit<Unity.VisualScripting.CustomEventArgs>.MessageListenerType

name

The name of the event.

Declaration
[DoNotSerialize]
public ValueInput name { get; }
Property Value
Type Description
ValueInput

Methods

AssignArguments(Flow, CustomEventArgs)

Declaration
protected override void AssignArguments(Flow flow, CustomEventArgs args)
Parameters
Type Name Description
Flow flow
CustomEventArgs args
Overrides
Unity.VisualScripting.EventUnit<Unity.VisualScripting.CustomEventArgs>.AssignArguments(Unity.VisualScripting.Flow, Unity.VisualScripting.CustomEventArgs)

Definition()

Declaration
protected override void Definition()
Overrides
Unity.VisualScripting.GameObjectEventUnit<Unity.VisualScripting.CustomEventArgs>.Definition()

ShouldTrigger(Flow, CustomEventArgs)

Declaration
protected override bool ShouldTrigger(Flow flow, CustomEventArgs args)
Parameters
Type Name Description
Flow flow
CustomEventArgs args
Returns
Type Description
Boolean
Overrides
Unity.VisualScripting.EventUnit<Unity.VisualScripting.CustomEventArgs>.ShouldTrigger(Unity.VisualScripting.Flow, Unity.VisualScripting.CustomEventArgs)

Trigger(GameObject, String, Object[])

Declaration
public static void Trigger(GameObject target, string name, params object[] args)
Parameters
Type Name Description
GameObject target
String name
Object[] args

Extension Methods