State
Class in Arbor / Inherits from: Node
Implements interfaces: INodeBehaviourContainer
Description
Class that represents the state
Fields
| Field Name | Description |
|---|---|
| name | The name of the state. |
Properties
| Property Name | Description |
|---|---|
| behaviourCount | Get a count of Behavior. |
| behaviours | Deprecated. Use behaviourCount and GetBehaviourFromIndex. |
| breakPoint | Break point. When this property is true, the editor is in a pause state at the timing of entering the state. |
| isActive | Returns true if it is active. |
| resident | Gets a value indicating whether thisStateis resident. |
| stateID | Gets the state identifier. |
| stateMachine | Gets the state machine. |
| transitionCount | Transition count. |
Methods
| Method Name | Description |
|---|---|
| AddBehaviour | Adds the behaviour. |
| Contains | Whether StateBehaviour are included. |
| DestroyBehaviour | Destroy StateBehaviour |
| DestroyBehaviourAt | Destroy StateBehaviour |
| DestroyBehaviours | For internal. |
| DisconnectState | For internal. |
| GetBehaviour | Gets the behaviour. |
| GetBehaviourFromIndex | Get StateBehavior from index. |
| GetBehaviourObjectFromIndex | Get Object of StateBehavior from index. |
| GetBehaviours | Gets the behaviours. |
| GetName | Get node name. |
| IndexOfBehaviour | Return index of StateBehaviour. |
| InsertBehaviour | Insert the behaviour. |
| IsContainsBehaviour | Check if it contains NodeBehaviour. |
| MoveBehaviour | Move the order of StateBehaviour. |
| RemoveBehaviour | I want to remove the StateBehaviour. For instance is not deleted, that you use theStateBehaviour.Destroy(). |
| RemoveBehaviourAt | I want to remove the StateBehaviour. For instance is not deleted, that you use theStateBehaviour.Destroy(). |
| SendTrigger | Send a trigger message.StateBehaviour.OnStateTrigger(string)is called. |
| SetBehaviour | Set StateBehaviour. |
| SwapBehaviour | Swap the order of StateBehaviour. |
Inherited Members
Fields
| Field Name | Description |
|---|---|
| nodeComment | Comment |
| position | Position on the Arbor Editor. |
| showComment | Whether to display comments |
Properties
| Property Name | Description |
|---|---|
| nodeGraph | Gets the NodeGraph. |
| nodeID | Gets the node identifier. |
Methods
| Method Name | Description |
|---|---|
| IsDeletable | Returns whether or not it can be deleted. |
| ToString | Convert node to string (for debugging). |