Class EventUnit<TArgs>
Implements
Inherited Members
Namespace: Unity.VisualScripting
Assembly: Unity.VisualScripting.Flow.dll
Syntax
[SerializationVersion("A", new Type[] { })]
public abstract class EventUnit<TArgs> : Unit, IEventUnit, IUnit, IGraphElementWithDebugData, IGraphEventListener, IGraphElementWithData, IGraphElement, IGraphItem, INotifiedCollectionItem, IDisposable, IPrewarmable, IAotStubbable, IIdentifiable, IAnalyticsIdentifiable, IGraphEventHandler<TArgs>
Type Parameters
Name | Description |
---|---|
TArgs |
Properties
coroutine
Run this event in a coroutine, enabling asynchronous flow like wait nodes.
Declaration
[Serialize]
[Inspectable]
[InspectorExpandTooltip]
public bool coroutine { get; set; }
Property Value
Type | Description |
---|---|
bool |
register
Declaration
[DoNotSerialize]
protected abstract bool register { get; }
Property Value
Type | Description |
---|---|
bool |
trigger
Declaration
[DoNotSerialize]
public ControlOutput trigger { get; }
Property Value
Type | Description |
---|---|
Control |
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 | |
Value |
namePort | |
string | calledName |
Returns
Type | Description |
---|---|
bool |
CreateData()
Declaration
public virtual IGraphElementData CreateData()
Returns
Type | Description |
---|---|
IGraph |
Definition()
Declaration
protected override void Definition()
Overrides
GetHook(GraphReference)
Declaration
public virtual EventHook GetHook(GraphReference reference)
Parameters
Type | Name | Description |
---|---|---|
Graph |
reference |
Returns
Type | Description |
---|---|
Event |
IsListening(GraphPointer)
Declaration
public bool IsListening(GraphPointer pointer)
Parameters
Type | Name | Description |
---|---|---|
Graph |
pointer |
Returns
Type | Description |
---|---|
bool |
ShouldTrigger(Flow, TArgs)
Declaration
protected virtual bool ShouldTrigger(Flow flow, TArgs args)
Parameters
Type | Name | Description |
---|---|---|
Flow | flow | |
TArgs | args |
Returns
Type | Description |
---|---|
bool |
StartListening(GraphStack)
Declaration
public virtual void StartListening(GraphStack stack)
Parameters
Type | Name | Description |
---|---|---|
Graph |
stack |
StopListening(GraphStack)
Declaration
public virtual void StopListening(GraphStack stack)
Parameters
Type | Name | Description |
---|---|---|
Graph |
stack |
Trigger(GraphReference, TArgs)
Declaration
public void Trigger(GraphReference reference, TArgs args)
Parameters
Type | Name | Description |
---|---|---|
Graph |
reference | |
TArgs | args |
Uninstantiate(GraphReference)
Declaration
public override void Uninstantiate(GraphReference instance)
Parameters
Type | Name | Description |
---|---|---|
Graph |
instance |