docs.unity3d.com
    Show / Hide Table of Contents

    Class EventUnit<TArgs>

    Inheritance
    Object
    GraphElement<FlowGraph>
    Unit
    EventUnit<TArgs>
    GameObjectEventUnit<TArgs>
    GlobalEventUnit<TArgs>
    MachineEventUnit<TArgs>
    ManualEventUnit<TArgs>
    Inherited Members
    Unit.CreateDebugData()
    Unit.AfterAdd()
    Unit.BeforeRemove()
    Unit.Instantiate(GraphReference)
    Unit.CopyFrom(Unit)
    Unit.canDefine
    Unit.failedToDefine
    Unit.isDefined
    Unit.AfterDefine()
    Unit.BeforeUndefine()
    Unit.EnsureDefined()
    Unit.Define()
    Unit.RemoveUnconnectedInvalidPorts()
    Unit.controlInputs
    Unit.controlOutputs
    Unit.valueInputs
    Unit.valueOutputs
    Unit.invalidInputs
    Unit.invalidOutputs
    Unit.inputs
    Unit.outputs
    Unit.validInputs
    Unit.validOutputs
    Unit.ports
    Unit.invalidPorts
    Unit.validPorts
    Unit.onPortsChanged
    Unit.PortsChanged()
    Unit.defaultValues
    Unit.relations
    Unit.connections
    Unit.Disconnect()
    Unit.isControlRoot
    Unit.EnsureUniqueInput(String)
    Unit.EnsureUniqueOutput(String)
    Unit.ControlInput(String, Func<Flow, ControlOutput>)
    Unit.ControlInputCoroutine(String, Func<Flow, IEnumerator>)
    Unit.ControlInputCoroutine(String, Func<Flow, ControlOutput>, Func<Flow, IEnumerator>)
    Unit.ControlOutput(String)
    Unit.ValueInput(Type, String)
    Unit.ValueInput<T>(String)
    Unit.ValueInput<T>(String, T)
    Unit.ValueOutput(Type, String)
    Unit.ValueOutput(Type, String, Func<Flow, Object>)
    Unit.ValueOutput<T>(String)
    Unit.ValueOutput<T>(String, Func<Flow, T>)
    Unit.Requirement(ValueInput, ControlInput)
    Unit.Requirement(ValueInput, ValueOutput)
    Unit.Assignment(ControlInput, ValueOutput)
    Unit.Succession(ControlInput, ControlOutput)
    Unit.position
    Unit.definitionException
    GraphElement<FlowGraph>.guid
    GraphElement<FlowGraph>.BeforeAdd()
    GraphElement<FlowGraph>.AfterRemove()
    GraphElement<FlowGraph>.Dispose()
    GraphElement<FlowGraph>.InstantiateNest()
    GraphElement<FlowGraph>.UninstantiateNest()
    GraphElement<FlowGraph>.dependencyOrder
    GraphElement<FlowGraph>.HandleDependencies()
    GraphElement<FlowGraph>.graph
    GraphElement<FlowGraph>.IGraphElement.graph
    GraphElement<FlowGraph>.IGraphItem.graph
    GraphElement<FlowGraph>.deserializationDependencies
    GraphElement<FlowGraph>.aotStubs
    GraphElement<FlowGraph>.Prewarm()
    GraphElement<FlowGraph>.CopyFrom(GraphElement<FlowGraph>)
    GraphElement<FlowGraph>.ToString()
    Namespace: Unity.VisualScripting
    Syntax
    [SerializationVersion("A", new Type[]{})]
    public abstract class EventUnit<TArgs> : Unit, IEventUnit, IUnit, IGraphElementWithDebugData, IGraphEventListener, IGraphElementWithData, IGraphElement, IGraphItem, INotifiedCollectionItem, IDisposable, IPrewarmable, IAotStubbable, IIdentifiable, IGraphEventHandler<TArgs>
    Type Parameters
    Name Description
    TArgs

    Properties

    coroutine

    Run this event in a coroutine, enabling asynchronous flow like wait units.

    Declaration
    [Serialize]
    [Inspectable]
    [InspectorExpandTooltip]
    public bool coroutine { get; set; }
    Property Value
    Type Description
    Boolean
    Implements
    IEventUnit.coroutine

    register

    Declaration
    [DoNotSerialize]
    protected abstract bool register { get; }
    Property Value
    Type Description
    Boolean

    trigger

    Declaration
    [DoNotSerialize]
    public ControlOutput trigger { get; }
    Property Value
    Type Description
    ControlOutput

    Methods

    AssignArguments(Flow, TArgs)

    Declaration
    protected virtual void AssignArguments(Flow flow, TArgs args)
    Parameters
    Type Name Description
    Flow flow
    TArgs args

    CompareNames(Flow, ValueInput, String)

    Declaration
    protected static bool CompareNames(Flow flow, ValueInput namePort, string calledName)
    Parameters
    Type Name Description
    Flow flow
    ValueInput namePort
    String calledName
    Returns
    Type Description
    Boolean

    CreateData()

    Declaration
    public virtual IGraphElementData CreateData()
    Returns
    Type Description
    IGraphElementData
    Implements
    IGraphElementWithData.CreateData()

    Definition()

    Declaration
    protected override void Definition()
    Overrides
    Unit.Definition()

    GetHook(GraphReference)

    Declaration
    public virtual EventHook GetHook(GraphReference reference)
    Parameters
    Type Name Description
    GraphReference reference
    Returns
    Type Description
    EventHook
    Implements
    IGraphEventHandler<TArgs>.GetHook(GraphReference)

    IsListening(GraphPointer)

    Declaration
    public bool IsListening(GraphPointer pointer)
    Parameters
    Type Name Description
    GraphPointer pointer
    Returns
    Type Description
    Boolean
    Implements
    IGraphEventListener.IsListening(GraphPointer)
    IGraphEventHandler<TArgs>.IsListening(GraphPointer)

    ShouldTrigger(Flow, TArgs)

    Declaration
    protected virtual bool ShouldTrigger(Flow flow, TArgs args)
    Parameters
    Type Name Description
    Flow flow
    TArgs args
    Returns
    Type Description
    Boolean

    StartListening(GraphStack)

    Declaration
    public virtual void StartListening(GraphStack stack)
    Parameters
    Type Name Description
    GraphStack stack
    Implements
    IGraphEventListener.StartListening(GraphStack)

    StopListening(GraphStack)

    Declaration
    public virtual void StopListening(GraphStack stack)
    Parameters
    Type Name Description
    GraphStack stack
    Implements
    IGraphEventListener.StopListening(GraphStack)

    Trigger(GraphReference, TArgs)

    Declaration
    public void Trigger(GraphReference reference, TArgs args)
    Parameters
    Type Name Description
    GraphReference reference
    TArgs args
    Implements
    IGraphEventHandler<TArgs>.Trigger(GraphReference, TArgs)

    Uninstantiate(GraphReference)

    Declaration
    public override void Uninstantiate(GraphReference instance)
    Parameters
    Type Name Description
    GraphReference instance
    Overrides
    Unit.Uninstantiate(GraphReference)
    Implements
    IGraphElement.Uninstantiate(GraphReference)

    Extension Methods

    XAnalyserProvider.Analyser(Object, IGraphContext)
    XAnalyserProvider.Analyser<TAnalyser>(Object, IGraphContext)
    XAnalyserProvider.Analysis(Object, IGraphContext)
    XAnalyserProvider.Analysis<TAnalysis>(Object, IGraphContext)
    XAnalyserProvider.Analyser(Object, GraphReference)
    XAnalyserProvider.Analyser<TAnalyser>(Object, GraphReference)
    XAnalyserProvider.Analysis(Object, GraphReference)
    XAnalyserProvider.Analysis<TAnalysis>(Object, GraphReference)
    XDescriptorProvider.Describe(Object)
    XDescriptorProvider.HasDescriptor(Object)
    XDescriptorProvider.Descriptor(Object)
    XDescriptorProvider.Descriptor<TDescriptor>(Object)
    XDescriptorProvider.Description(Object)
    XDescriptorProvider.Description<TDescription>(Object)
    XUnitOptionProvider.Option(IUnit)
    XUnitOptionProvider.Option<TOption>(IUnit)
    Cloning.Clone(Object, ICloner, Boolean)
    Cloning.Clone<T>(T, ICloner, Boolean)
    Cloning.CloneViaFakeSerialization(Object)
    Cloning.CloneViaFakeSerialization<T>(T)
    XGraphEventListener.StartListening(IGraphEventListener, GraphReference)
    XGraphEventListener.StopListening(IGraphEventListener, GraphReference)
    GraphsExceptionUtility.GetException(IGraphElementWithDebugData, GraphPointer)
    GraphsExceptionUtility.SetException(IGraphElementWithDebugData, GraphPointer, Exception)
    GraphsExceptionUtility.HandleException(IGraphElementWithDebugData, GraphPointer, Exception)
    ConversionUtility.IsConvertibleTo(Object, Type, Boolean)
    ConversionUtility.IsConvertibleTo<T>(Object, Boolean)
    ConversionUtility.ConvertTo(Object, Type)
    ConversionUtility.ConvertTo<T>(Object)
    TypeUtility.ToShortString(Object, Int32)
    Serialization.CloneViaSerialization<T>(T, Boolean)
    Serialization.CloneViaSerializationInto<TSource, TDestination>(TSource, ref TDestination, Boolean)
    Serialization.Serialize(Object, Boolean)
    LinqUtility.Yield<T>(T)
    UnityObjectUtility.IsUnityNull(Object)
    UnityObjectUtility.ToSafeString(Object)
    XUnit.CompatibleValueInput(IUnit, Type)
    XUnit.CompatibleValueOutput(IUnit, Type)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023