IState
Interface for a state in a IState.StateMachine.
Read time 1 minuteLast updated 7 days ago
Definition
- Type: Interface
- Namespace: Unity.GraphToolkit.Editor
- Assembly: UnityEditor
public interface IState
Remarks
A state is the state machine equivalent of an INode. Unlike a node, a state does not expose configurable input and output ports: its incoming and outgoing connections are transitions managed by the state machine itself.
See also:
-
State for the base class used to define custom states
-
ISubgraphState for how to work with subgraph-based states
Unity implements this interface. Do not implement it in your own types.
Properties
Property | Description |
|---|---|
| DefaultColor | The highlight color of the state. The highlight is located on the upper border of the state. |
| FillAmount | The progress fill amount displayed on the state's accent bar, expressed as a percentage. |
| ID | The globally unique identifier for this state. |
| IsConnected | Whether the state is connected to at least one transition. |
| OptionCount | The number of options defined in the state. |
| Options | The options defined on this state. |
| Position | The position of the state in the state machine. |
| StateMachine | The IState.StateMachine that contains this state. |
| Subtitle | The secondary text displayed in the state's header. |
| Title | The main text displayed in the state's header. |
| Tooltip | The text displayed when hovering over the state's header. |
Methods
Method | Description |
|---|---|
| GetIncomingTransitions | Retrieves the transitions that go to this state. |
| GetOption | Retrieves a state option using its zero-based index. |
| GetOptionByName | Retrieves a state option using its name. |
| GetOutgoingTransitions | Retrieves the transitions that originate from this state. |
| RemoveFromStateMachine | Removes the state from its state machine. |