StateBehaviour
Class in Arbor / Inherits from: PlayableBehaviour
Implements interfaces: IPlayableBehaviourCallbackReceiver
Description
Class that defines the behavior of the State. Inherited and to use.
Remarks
Available Attributes :
Fields
| Field Name | Description |
|---|---|
| onBehaviourEnabledChanged | Called when behaviorEnabled changes |
Properties
| Property Name | Description |
|---|---|
| behaviourEnabled | Gets or sets a value indicating whether [behaviour enabled]. |
| nextTransitionState | Next state |
| prevTransitionState | Prev state |
| state | Get the State. |
| stateID | Gets the state identifier. |
| stateLinkCount | Count of StateLink. |
| stateMachine | Gets the state machine. |
Events
| Event Name | Description |
|---|---|
| onStateLinkRebuilt | Called when the StateLink cache is rebuilt |
Methods
| Method Name | Description |
|---|---|
| AddBehaviour | Adds the behaviour. |
| Destroy | Destroys this instance. |
| GetBehaviour | Gets the behaviour. |
| GetBehaviours | Gets the behaviours. |
| GetStateLink | Return StateLink of index. |
| OnInitializeEnabled | Called to perform enabled initialization. |
| OnRebuildFields | It is called when reconstructing data about fields. |
| OnStateAwake | Called when [state enter first]. |
| OnStateBegin | Called when [state enter]. |
| OnStateEnd | Called when [state exit]. |
| OnStateFixedUpdate | FixedUpdate for State. Frame-rate-independent Update for physics operations. |
| OnStateLateUpdate | LateUpdate for State. Every frame, called after all updates. |
| OnStateTrigger | Called from SendTrigger. |
| OnStateUpdate | Update of State. It is called every frame. |
| RebuildStateLinkCache | Rebuild StateLink's cache. |
| Transition | State transition |
Inherited Members
Fields
| Field Name | Description |
|---|---|
| expanded | Expanded on ArborEditorWindow. |
| schedulerDestroyTiming | Timing to destroy the scheduler. |
| schedulerUpdateTiming | Scheduler update timing |
Properties
| Property Name | Description |
|---|---|
| calculatorSlotFieldCount | Number of DataSlotField |
| CancellationTokenOnEnd | Cancel token generated when exiting a node |
| dataSlotCount | Number of DataSlot |
| dataSlotFieldCount | Number of DataSlotField |
| node | Get the Node. |
| nodeGraph | Gets the NodeGraph. |
| nodeID | Gets the node identifier. |
| scheduler | Get scheduler. |
| schedulerProgress | Get the progress of the scheduler |
Events
| Event Name | Description |
|---|---|
| onValidate | Callback called during OnValidate |
Methods
| Method Name | Description |
|---|---|
| ContainsSlot | Determine if the Data Slot is included. |
| GetCalculatorSlotField | Get DataSlotField. |
| GetDataSlot | Get DataSlot. |
| GetDataSlotField | Get DataSlotField. |
| GetOrCreateScheduler | Get the scheduler. If there is no scheduler, create one. |
| Initialize | For Editor. |
| OnCreated | Raises the created event. |
| OnGraphPause | This function is called when the graph is paused. |
| OnGraphResume | This function is called when the graph resumes. |
| OnGraphStop | This function is called when the graph stops. |
| OnPreDestroy | Raises the pre destroy event. |
| RebuildCalculatorSlotFields | Rebuild the DataSlotField. |
| RebuildDataSlotFieldIfNecessary | Check if DataSlot exists and rebuild if necessary. |
| RebuildDataSlotFields | Rebuild the DataSlotField. |
| RebuildFields | For internal. |
| UpdateDataLink | Manually update DataLink values.Update the value of DataLink field of DataLinkUpdateTiming.Manual. |
| Yield | Gets an awaitable asynchronous task that waits until the next OnUpdate call. |
Static Methods
| Method Name | Description |
|---|---|
| CreateNodeBehaviour | For Editor. |
| Destroy | Destroy NodeBehaviour. |