Class ToggleValue
Toggles between two values with on and off triggers.
Implements
Inherited Members
Namespace: Unity.VisualScripting
Assembly: Unity.VisualScripting.Flow.dll
Syntax
[UnitCategory("Control")]
[UnitOrder(19)]
public sealed class ToggleValue : Unit, IUnit, IGraphElementWithDebugData, IGraphElementWithData, IGraphElement, IGraphItem, INotifiedCollectionItem, IDisposable, IPrewarmable, IAotStubbable, IIdentifiable, IAnalyticsIdentifiableProperties
isOn
Whether the flow is currently on.
Declaration
[DoNotSerialize]
public ValueOutput isOn { get; }Property Value
| Type | Description |
|---|---|
| Value |
offValue
The value to return if the toggle is off.
Declaration
[DoNotSerialize]
public ValueInput offValue { get; }Property Value
| Type | Description |
|---|---|
| Value |
onValue
The value to return if the toggle is on.
Declaration
[DoNotSerialize]
public ValueInput onValue { get; }Property Value
| Type | Description |
|---|---|
| Value |
startOn
Whether the toggle should start in the on state.
Declaration
[Serialize]
[Inspectable]
[UnitHeaderInspectable("Start On")]
[InspectorToggleLeft]
public bool startOn { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
toggle
Trigger to toggle the state of the toggle.
Declaration
[DoNotSerialize]
public ControlInput toggle { get; }Property Value
| Type | Description |
|---|---|
| Control |
turnOff
Trigger to turn off the toggle.
Declaration
[DoNotSerialize]
[PortLabel("Off")]
public ControlInput turnOff { get; }Property Value
| Type | Description |
|---|---|
| Control |
turnOn
Trigger to turn on the toggle.
Declaration
[DoNotSerialize]
[PortLabel("On")]
public ControlInput turnOn { get; }Property Value
| Type | Description |
|---|---|
| Control |
turnedOff
Triggered when the flow gets turned off.
Declaration
[DoNotSerialize]
public ControlOutput turnedOff { get; }Property Value
| Type | Description |
|---|---|
| Control |
turnedOn
Triggered when the flow gets turned on.
Declaration
[DoNotSerialize]
public ControlOutput turnedOn { get; }Property Value
| Type | Description |
|---|---|
| Control |
value
The value of the toggle selected depending on the state.
Declaration
[DoNotSerialize]
public ValueOutput value { get; }Property Value
| Type | Description |
|---|---|
| Value |
Methods
CreateData()
Declaration
public IGraphElementData CreateData()Returns
| Type | Description |
|---|---|
| IGraph |
Definition()
Declaration
protected override void Definition()