BitQuirky.Behavior.Nodes.State
Public behavior trees and state machines: runtime symbols in BitQuirky.Behavior.Nodes.State.
Source snapshot 29003d8b1658.
On this page
Assembly: BitQuirky.Behavior.Runtime
ActionExecutionTokens
Section titled “ActionExecutionTokens”Category: Node contracts
class BitQuirky.Behavior.Nodes.State.ActionExecutionTokensSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:17-29
Stable source tokens for action-state list execution.
Responsibilities:
- Name the deterministic ordered and same-advancement execution policies.
Does NOT:
- Store authored values or schedule actions.
Members
Section titled “Members”Parallel
Section titled “Parallel”public const string Parallel = "parallel"Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:28
Same-advancement: every action in the group advances on each tick, and the first non-success cancels the rest of the range.
Sequence
Section titled “Sequence”public const string Sequence = "sequence"Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:23
Ordered: the group advances one action at a time in authored order. The bake assumes this when no execution policy is authored.
ActionLifetimeTokens
Section titled “ActionLifetimeTokens”Category: Node contracts
class BitQuirky.Behavior.Nodes.State.ActionLifetimeTokensSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:40-51
Stable source tokens for action-state activation lifetime.
Responsibilities:
- Name one-pass and repeating action-state behavior.
Does NOT:
- Reset runtime state or evaluate transitions.
Members
Section titled “Members”public const string Once = "once"Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:45
One pass: the Active Update holds its terminal result instead of starting again.
Repeat
Section titled “Repeat”public const string Repeat = "repeat"Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:50
Repeating: the Active Update starts a new pass after each terminal result. The bake assumes this when no lifetime is authored.
ActionPhaseTokens
Section titled “ActionPhaseTokens”Category: Node contracts
class BitQuirky.Behavior.Nodes.State.ActionPhaseTokensSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:62-76
Stable source tokens for one action’s lifecycle group.
Responsibilities:
- Name the Entry, Active Update, and Exit placements an action may author.
Does NOT:
- Order actions, resolve omitted phases, or schedule lifecycle groups.
Members
Section titled “Members”public const string Enter = "enter"Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:65
Entry group: evaluated once when the owning state activates.
public const string Exit = "exit"Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:75
Exit group: evaluated once after an outgoing transition latches and before the target state activates.
Update
Section titled “Update”public const string Update = "update"Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:70
Active Update group: the state’s repeating work, and the placement the bake assumes for an action that authors no phase.
StateCompletionMode
Section titled “StateCompletionMode”Category: Node contracts
enum BitQuirky.Behavior.Nodes.State.StateCompletionModeSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:115-125
Underlying type: byte
What a state does after a terminal Active Update with no selected transition.
Members
Section titled “Members”Finish
Section titled “Finish”Finish = 1Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:121
Finish the state machine with the authored machine result.
Return
Section titled “Return”Return = 2Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:124
Return to the state activation suspended by the matching Push.
Stay = 0Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:118
Remain active; Once holds its result and Repeat starts a new pass.
StateCompletionResult
Section titled “StateCompletionResult”Category: Node contracts
enum BitQuirky.Behavior.Nodes.State.StateCompletionResultSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:128-141
Underlying type: byte
The explicit machine result produced by a finishing state.
Members
Section titled “Members”ActiveUpdate
Section titled “ActiveUpdate”ActiveUpdate = 2Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:140
Finish with Success when the Active Update ended in Success, and with Failure for every other terminal result.
Failure
Section titled “Failure”Failure = 1Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:134
Finish with Failure whatever the Active Update’s own terminal result was.
Success
Section titled “Success”Success = 0Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:131
Finish with Success whatever the Active Update’s own terminal result was.
StateCompletionTokens
Section titled “StateCompletionTokens”Category: Node contracts
class BitQuirky.Behavior.Nodes.State.StateCompletionTokensSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:214-234
Canonical source values for state completion and explicit machine results.
Members
Section titled “Members”ActiveUpdate
Section titled “ActiveUpdate”public const string ActiveUpdate = "active_update"Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:233
Authoredfinish_resultvalue that mirrors the Active Update’s own terminal
result, and the value the bake assumes when the parameter is absent.
Failure
Section titled “Failure”public const string Failure = "failure"Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:228
Authored finish_result value finishing the machine with Failure.
Finish
Section titled “Finish”public const string Finish = "finish"Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:222
Authored completion value selecting Finish.
Return
Section titled “Return”public const string Return = "return"Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:224
Authored completion value selecting Return.
public const string Stay = "stay"Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:220
Authoredcompletion value selecting Stay, and
the value the bake assumes when the parameter is absent.
Success
Section titled “Success”public const string Success = "success"Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:226
Authored finish_result value finishing the machine with Success.
StateConstants
Section titled “StateConstants”Category: Node contracts
class BitQuirky.Behavior.Nodes.State.StateConstantsSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:242-315
Constants for the Statechart Root and State node types. The statechart root contains one or more states; each state contains zero or one BT subgraph plus zero or more outgoing transitions (data-model.md §Layer 2 Node Type taxonomy).
Members
Section titled “Members”AnyStateKind
Section titled “AnyStateKind”public const BitQuirky.Behavior.Baked.BakedNodeKind AnyStateKind = AnyStateSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:276
Baked node kind the runtime dispatches on for the Any State pseudo-state.
AnyStateNodeKindToken
Section titled “AnyStateNodeKindToken”public const string AnyStateNodeKindToken = "any_state"Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:260-261
Source:::any_statetoken for the pseudo-state whose outgoing transitions are
evaluated from whichever state is active, ahead of that state’s own transitions.
EntryStateKind
Section titled “EntryStateKind”public const BitQuirky.Behavior.Baked.BakedNodeKind EntryStateKind = EntryStateSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:274
Baked node kind the runtime dispatches on for the entry state.
EntryStateNodeKindToken
Section titled “EntryStateNodeKindToken”public const string EntryStateNodeKindToken = "entry"Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:254-255
Source:::entrytoken for the state the machine activates on start; the bake
requires exactly one entry state per machine.
MinActiveSecondsParameterId
Section titled “MinActiveSecondsParameterId”public const int MinActiveSecondsParameterId = -108903004Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:288
Stable baked id of the authored minimum-active-duration parameter,
BehaviorNodeParameterTokens.MinActiveSeconds . A :::state
node without one keeps a zero dwell budget and never gates its outgoing
transitions, exactly as before the parameter existed. Registered only against
State, never
Entry.
ReferenceKind
Section titled “ReferenceKind”public const BitQuirky.Behavior.Baked.BakedNodeKind ReferenceKind = StateMachineReferenceSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:278
Baked node kind the runtime dispatches on for a referenced-machine state.
ReferenceNodeKindToken
Section titled “ReferenceNodeKindToken”public const string ReferenceNodeKindToken = "state_machine_reference"Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:266-267
Source:::state_machine_referencetoken for a state that runs a separately
authored machine in place of its own actions.
RootKind
Section titled “RootKind”public const BitQuirky.Behavior.Baked.BakedNodeKind RootKind = StatechartRootSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:270
Baked node kind the runtime dispatches on for the statechart root.
RootNodeKindToken
Section titled “RootNodeKindToken”public const string RootNodeKindToken = "root"Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:245-246
Source :::root token for the statechart root that owns the machine’s states.
StateKind
Section titled “StateKind”public const BitQuirky.Behavior.Baked.BakedNodeKind StateKind = StateSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:272
Baked node kind the runtime dispatches on for an ordinary state.
StateNodeKindToken
Section titled “StateNodeKindToken”public const string StateNodeKindToken = "state"Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:248-249
Source :::state token for one ordinary state of the machine.
StateSelfReentry
Section titled “StateSelfReentry”Category: Node contracts
enum BitQuirky.Behavior.Nodes.State.StateSelfReentrySource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:105-112
Underlying type: byte
How an explicitly authored self-transition re-enters its active state.
Members
Section titled “Members”Restart
Section titled “Restart”Restart = 0Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:108
Run the normal bounded Exit/Entry handoff and restart state progress.
Resume
Section titled “Resume”Resume = 1Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:111
Keep current state progress without running Exit or Entry.
StateTransitionEvaluation
Section titled “StateTransitionEvaluation”Category: Node contracts
enum BitQuirky.Behavior.Nodes.State.StateTransitionEvaluationSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:79-89
Underlying type: byte
When an outgoing state transition is eligible for evaluation.
Members
Section titled “Members”Continuous
Section titled “Continuous”Continuous = 0Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:82
Evaluate at each existing pre- and post-update transition boundary.
OnFinish
Section titled “OnFinish”OnFinish = 1Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:85
Evaluate while a Once Active Update holds its terminal result.
OnIteration
Section titled “OnIteration”OnIteration = 2Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:88
Evaluate exactly once at each Active Update pass boundary.
StateTransitionKind
Section titled “StateTransitionKind”Category: Node contracts
enum BitQuirky.Behavior.Nodes.State.StateTransitionKindSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:175-182
Underlying type: byte
How a state transition treats the source activation.
Members
Section titled “Members”Push = 1Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:181
Suspend the source without Exit and enter the target as a nested activation.
Switch
Section titled “Switch”Switch = 0Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:178
Cancel the source and every suspended activation before entering the target.
StateTransitionKindTokens
Section titled “StateTransitionKindTokens”Category: Node contracts
class BitQuirky.Behavior.Nodes.State.StateTransitionKindTokensSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:195-211
Canonical source values for transition kind and return policy.
Members
Section titled “Members”public const string Push = "push"Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:203
Authored kind value selecting Push.
Reenter
Section titled “Reenter”public const string Reenter = "reenter"Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:210
Authored on_return value selecting Reenter.
Resume
Section titled “Resume”public const string Resume = "resume"Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:208
Authoredon_return value selecting Resume,
and the value the bake assumes when the parameter is absent.
Switch
Section titled “Switch”public const string Switch = "switch"Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:201
Authoredkind value selecting Switch, and the
value the bake assumes when the parameter is absent.
StateTransitionOnReturn
Section titled “StateTransitionOnReturn”Category: Node contracts
enum BitQuirky.Behavior.Nodes.State.StateTransitionOnReturnSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:185-192
Underlying type: byte
How a state resumes after the pushed activation returns.
Members
Section titled “Members”Reenter
Section titled “Reenter”Reenter = 1Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:191
Run Entry and begin a fresh Active Update activation.
Resume
Section titled “Resume”Resume = 0Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:188
Continue the exact preserved activation without Entry.
StateTransitionResultFilter
Section titled “StateTransitionResultFilter”Category: Node contracts
enum BitQuirky.Behavior.Nodes.State.StateTransitionResultFilterSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:92-102
Underlying type: byte
Which terminal Active Update result permits a transition to fire.
Members
Section titled “Members”Any = 0Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:95
Do not filter the transition by terminal result.
Failure
Section titled “Failure”Failure = 2Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:101
Permit only a failed terminal result.
Success
Section titled “Success”Success = 1Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:98
Permit only a successful terminal result.
StateTransitionTokens
Section titled “StateTransitionTokens”Category: Node contracts
class BitQuirky.Behavior.Nodes.State.StateTransitionTokensSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:144-172
Canonical source values for transition cadence, result filtering, and re-entry.
Members
Section titled “Members”AnyResult
Section titled “AnyResult”public const string AnyResult = "any"Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:160
Authoredresult value selecting Any,
and the value the bake assumes when the parameter is absent.
Continuous
Section titled “Continuous”public const string Continuous = "continuous"Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:151
Authoredevaluatevalue selecting
Continuous, and the value the bake assumes when
the parameter is absent.
Failure
Section titled “Failure”public const string Failure = "failure"Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:164
Authored result value selecting Failure.
OnFinish
Section titled “OnFinish”public const string OnFinish = "on_finish"Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:153
Authored evaluate value selecting OnFinish.
OnIteration
Section titled “OnIteration”public const string OnIteration = "on_iteration"Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:155
Authored evaluate value selecting OnIteration.
Restart
Section titled “Restart”public const string Restart = "restart"Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:169
Authoredreentry value selecting Restart, and the
value the bake assumes when the parameter is absent.
Resume
Section titled “Resume”public const string Resume = "resume"Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:171
Authored reentry value selecting Resume.
Success
Section titled “Success”public const string Success = "success"Source declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:162
Authored result value selecting Success.
StatechartState
Section titled “StatechartState”Category: Node contracts
struct BitQuirky.Behavior.Nodes.State.StatechartStateSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:331-388
Authoritative baked lookup row for one statechart state.
Responsibilities:
- Carry the state’s baked node identity and optional hosted behavior-tree root.
- Own the effective Active Update lifetime independently of direct-action storage.
- Address its contiguous authored outgoing-transition and direct-action row ranges.
- Address its optional hosted-lifecycle row without graph-wide runtime scans.
- Provide a Burst-friendly snapshot selected through the artifact’s node-to-state index.
Does NOT:
- Hold per-follower state: that lives on
BehaviorRuntimeInstance. - Own companion arrays or evaluate transitions and actions.
Members
Section titled “Members”ActionListCount
Section titled “ActionListCount”public int ActionListCountSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:363
Number of contiguous direct-action lifecycle rows owned by this state.
ActionListStart
Section titled “ActionListStart”public int ActionListStartSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:360
First direct-action lifecycle row in the baked action-list table.
BehaviorTreeRootIndex
Section titled “BehaviorTreeRootIndex”public int BehaviorTreeRootIndexSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:338
Index of the contained BT root inNodes, or -1 if the state has no behavior tree.
Completion
Section titled “Completion”public BitQuirky.Behavior.Nodes.State.StateCompletionMode CompletionSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:384
Completion policy applied after terminal Active Update work.
CompletionResult
Section titled “CompletionResult”public BitQuirky.Behavior.Nodes.State.StateCompletionResult CompletionResultSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:387
Machine result selected when Completion is Finish.
HostedBehaviorIndex
Section titled “HostedBehaviorIndex”public int HostedBehaviorIndexSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:369
Index of this state’s row in the hosted-behavior table, or -1 when it owns no hosted behavior tree.
IsEntry
Section titled “IsEntry”public bool IsEntrySource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:351
True when this state is the entry state of the enclosing statechart (exactly one per source; bake enforces).
MachineIndex
Section titled “MachineIndex”public int MachineIndexSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:375
Owning machine row in the artifact’s dense machine table.
OutgoingTransitionCount
Section titled “OutgoingTransitionCount”public int OutgoingTransitionCountSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:345
Number of outgoing transitions in the artifact’s transition table whoseSourceStateIndex equals this state’s node index.
OutgoingTransitionStart
Section titled “OutgoingTransitionStart”public int OutgoingTransitionStartSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:357
First authored outgoing transition in the baked transition table.
StateMachineReferenceIndex
Section titled “StateMachineReferenceIndex”public int StateMachineReferenceIndexSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:372
Referenced-machine row, or -1 for an ordinary action state.
StateNodeIndex
Section titled “StateNodeIndex”public int StateNodeIndexSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:354
Baked node index of the state represented by this row.
UpdateLifetime
Section titled “UpdateLifetime”public BitQuirky.Behavior.Baked.BakedActionLifetime UpdateLifetimeSource declaration: Packages/io.bitquirky.behavior/Runtime/Nodes/State/StatechartState.cs:381
Effective lifetime of the state’s selected Active Update source. Actionless states retain this policy without requiring a direct-action row.
Source fingerprint: sha256:29003d8b1658b98a79bebcd93e3b4030caf8511268b96817ab764d63df8d6c3b