Version: Unity 6.7 Alpha (6000.7)
LanguageEnglish
  • C#

IState

interface in Unity.GraphToolkit.Editor

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Interface for a state in a IState.StateMachine.

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.
ID The globally unique identifier for this state.
IsConnected Whether the state is connected to at least one transition.
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.

Public Methods

Method Description
GetIncomingTransitions Retrieves the transitions that go to this state.
GetOutgoingTransitions Retrieves the transitions that originate from this state.
RemoveFromStateMachine Removes the state from its state machine.