State
The base class for all user-accessible states in a State.StateMachine.
Read time 2 minutesLast updated 6 days ago
Definition
- Type: Class
- Namespace: Unity.GraphToolkit.Editor
- Assembly: UnityEditor
- Implements: IState
public abstract class State : IState
Remarks
Inherit from this class to define custom state types that appear in a state machine graph. A state represents a node in a State.StateMachine; transitions connect states to one another. Unlike Node, a state does not expose configurable input and output ports: its incoming and outgoing transition connections are managed by the state machine itself.
See also:
-
State.StateMachine for the graph type that contains states
-
Node for the equivalent base class used in regular graphs
-
IState for the interface this class implements
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 State.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 |
|---|---|
| DefineState | Defines the structure of the state by building its options. |
| 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. |
| OnDefineOptions | Called during State.DefineState to define the options available on the state. |
| OnDisable | Called when the state is removed or when the state machine is disabled. |
| OnEnable | Called when the state is created or when the state machine is enabled. |
| RemoveFromStateMachine | Removes the state from its state machine. |
Interfaces
Interface | Description |
|---|---|
| State.IOptionDefinitionContext | Interface that provides methods to declare state options inside a state. |