Class OnButtonInput

A configurable event to handle global button input.

Inheritance
Object
GraphElement<FlowGraph>
Unit
EventUnit<EmptyEventArgs>
MachineEventUnit<EmptyEventArgs>
OnButtonInput
Inherited Members
Namespace: Unity.VisualScripting
Syntax
[UnitCategory("Events/Input")]
public sealed class OnButtonInput : MachineEventUnit<EmptyEventArgs>, IEventUnit, IUnit, IGraphElementWithDebugData, IGraphEventListener, IGraphElementWithData, IGraphElement, IGraphItem, INotifiedCollectionItem, IDisposable, IPrewarmable, IAotStubbable, IIdentifiable, IGraphEventHandler<EmptyEventArgs>

Properties

action

The type of input.

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

buttonName

The name of the button that received input.

Declaration
[DoNotSerialize]
[PortLabel("Name")]
public ValueInput buttonName { get; }
Property Value
Type Description
ValueInput

hookName

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

Methods

Definition()

Declaration
protected override void Definition()
Overrides
Unity.VisualScripting.EventUnit<Unity.VisualScripting.EmptyEventArgs>.Definition()

ShouldTrigger(Flow, EmptyEventArgs)

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

Extension Methods