Arbor 3: FSM & BT Graph Editor  3.1.3
ArborFSM Class Reference

Core part of StateMachine. More...

Inheritance diagram for ArborFSM:
ArborFSMInternal NodeGraph

Static Public Member Functions

static ArborFSM FindFSM (string name)
 Get the ArborFSM that in the scene with the name. More...
 
static ArborFSM[] FindFSMs (string name)
 Get the ArborFSM of the same name that is in the scene. More...
 
static ArborFSM FindFSM (GameObject gameObject, string name)
 Get ArborFSM in the name that has been attached to the GameObject. More...
 
static ArborFSM[] FindFSMs (GameObject gameObject, string name)
 Get the ArborFSM of the same name that is attached to a GameObject. More...
 
- Static Public Member Functions inherited from NodeGraph
static NodeGraph FindGraph (string name)
 Get the NodeGraph that in the scene with the name. More...
 
static NodeGraph FindGraph (string name, System.Type type)
 Get the NodeGraph that in the scene with the name. More...
 
static T FindGraph< T > (string name)
 Get the NodeGraph that in the scene with the name. More...
 
static NodeGraph[] FindGraphs (string name)
 Get the NodeGraph of the same name that is in the scene. More...
 
static NodeGraph[] FindGraphs (string name, System.Type type)
 Get the NodeGraph of the same name that is in the scene. More...
 
static T[] FindGraphs< T > (string name)
 Get the NodeGraph of the same name that is in the scene. More...
 
static NodeGraph FindGraph (GameObject gameObject, string name)
 Get NodeGraph in the name that has been attached to the GameObject. More...
 
static NodeGraph FindGraph (GameObject gameObject, string name, System.Type type)
 Get NodeGraph in the name that has been attached to the GameObject. More...
 
static T FindGraph< T > (GameObject gameObject, string name)
 Get NodeGraph in the name that has been attached to the GameObject. More...
 
static NodeGraph[] FindGraphs (GameObject gameObject, string name)
 Get the NodeGraph of the same name that is attached to a GameObject. More...
 
static NodeGraph[] FindGraphs (GameObject gameObject, string name, System.Type type)
 Get the NodeGraph of the same name that is attached to a GameObject. More...
 
static T[] FindGraphs< T > (GameObject gameObject, string name)
 Get the NodeGraph of the same name that is attached to a GameObject. More...
 
static NodeGraph Create (GameObject gameObject, System.Type classType)
 Create NodeGraph More...
 
static GraphType Create< GraphType > (GameObject gameObject)
 Create NodeGraph More...
 
static NodeGraph Instantiate (NodeGraph sourceGraph, NodeBehaviour ownerBehaviour)
 Instantiate NodeGraph More...
 
static GraphType Instantiate< GraphType > (GraphType sourceGraph, NodeBehaviour ownerBehaviour)
 Instantiate NodeGraph More...
 
static void Destroy (NodeGraph nodeGraph)
 Destroy NodeGraph More...
 

Additional Inherited Members

- Public Member Functions inherited from ArborFSMInternal
int IndexOfStateLinkHistory (StateLink stateLink)
 Retrieve the index in the history that transited by the specified StateLink. More...
 
State GetStateFromIndex (int index)
 Get State from index. More...
 
int GetStateIndex (State state)
 Get State index. More...
 
State GetStateFromID (int stateID)
 Gets Arbor.State from the state identifier. More...
 
State GetState (StateLink stateLink)
 Gets Arbor.State from the StateLink. More...
 
State CreateState (int nodeID, bool resident)
 Create state. More...
 
State CreateState (bool resident)
 Create state. More...
 
State CreateState ()
 Create state. More...
 
State FindState (string stateName)
 Search state by name. More...
 
State[] FindStates (string stateName)
 Search state by name. More...
 
State FindStateContainsBehaviour (StateBehaviour behaviour)
 Acquisition of states StateBehaviour belongs. More...
 
bool DeleteState (State state)
 Delete state. More...
 
StateLinkRerouteNode CreateStateLinkRerouteNode (Vector2 position, int nodeID)
 Create StateLinkRerouteNode. More...
 
StateLinkRerouteNode CreateStateLinkRerouteNode (Vector2 position)
 Create StateLinkRerouteNode. More...
 
void Play ()
 Start playing the state machine. More...
 
void Stop ()
 Stopping playback of the state machine. More...
 
void Pause ()
 Pause playback of the state machine. More...
 
void Resume ()
 Resume playing state machine. More...
 
void ExecuteUpdate (bool autoExecuteLateUpdate=false)
 Perform an update. More...
 
void ExecuteLateUpdate ()
 Perform an LateUpdate. More...
 
bool Transition (State nextState, TransitionTiming transitionTiming)
 State transition More...
 
bool Transition (State nextState, bool immediateTransition)
 State transition More...
 
bool Transition (State nextState)
 State transition. More...
 
bool Transition (int nextStateID, TransitionTiming transitionTiming)
 State transition More...
 
bool Transition (int nextStateID, bool immediateTransition)
 State transition More...
 
bool Transition (int nextStateID)
 State transition. More...
 
bool Transition (StateLink nextStateLink, TransitionTiming transitionTiming)
 State transition More...
 
bool Transition (StateLink nextStateLink, bool immediateTransition)
 State transition More...
 
bool Transition (StateLink nextStateLink)
 State transition. More...
 
void SendTrigger (string message)
 Sending of trigger More...
 
- Public Member Functions inherited from NodeGraph
Node GetNodeFromIndex (int index)
 Get Node from index. More...
 
Node GetNodeFromID (int nodeID)
 Gets Arbor.Node from the node identifier. More...
 
CalculatorNode GetCalculatorFromIndex (int index)
 Get CalculatorNode from index. More...
 
int GetCalculatorIndex (CalculatorNode calculator)
 Get CalculatorNode index. More...
 
CalculatorNode GetCalculatorFromID (int calculatorID)
 Gets Arbor.CalculatorNode from the calculator identifier. More...
 
CalculatorNode CreateCalculator (int nodeID, System.Type calculatorType)
 Create calculator. More...
 
CalculatorNode CreateCalculator (System.Type calculatorType)
 Create calculator. More...
 
CalculatorNode FindCalculator (Calculator calculator)
 Acquisition of CalculatorNodes Calculator belongs. More...
 
bool DeleteCalculator (CalculatorNode calculatorNode)
 Delete calculator. More...
 
CommentNode GetCommentFromIndex (int index)
 Get CommentNode from index. More...
 
int GetCommentIndex (CommentNode comment)
 Get CommentNode index. More...
 
CommentNode GetCommentFromID (int commentID)
 Gets Arbor.CommentNode from the comment identifier. More...
 
CommentNode CreateComment (int nodeID)
 Create comment. More...
 
CommentNode CreateComment ()
 Create comment. More...
 
void DeleteComment (CommentNode comment)
 Delete comment. More...
 
GroupNode GetGroupFromIndex (int index)
 Get GroupNode from index. More...
 
GroupNode CreateGroup (int nodeID)
 Create group. More...
 
GroupNode CreateGroup ()
 Create group. More...
 
void DeleteGroup (GroupNode group)
 Delete group. More...
 
GroupNode GetGroupFromID (int groupID)
 Gets Arbor.GroupNode from the group identifier. More...
 
CalculatorBranchRerouteNode CreateCalculatorBranchRerouteNode (Vector2 position, System.Type type, int nodeID)
 Create CalculatorBranchRerouteNode. More...
 
CalculatorBranchRerouteNode CreateCalculatorBranchRerouteNode (Vector2 position, System.Type type)
 Create CalculatorBranchRerouteNode. More...
 
void DeleteCalculatorBranchRerouteNode (CalculatorBranchRerouteNode rerouteNode)
 Delete CalculatorBranchRerouteNode. More...
 
virtual void OnValidateNodes ()
 Called when the node is changed. More...
 
bool DeleteNode (Node node)
 Delete node. More...
 
Node FindNodeContainsBehaviour (NodeBehaviour behaviour)
 Acquisition of nodes NodeBehaviour belongs. More...
 
CalculatorBranch GetCalculatorBranchFromIndex (int index)
 Get CalculatorBranch from index. More...
 
int GetCalculatorBranchIndex (CalculatorBranch branch)
 Get CalculatorBranch index. More...
 
CalculatorBranch GetCalculatorBranchFromID (int branchID)
 Gets Arbor.CalculatorBranch from the calculator branch identifier. More...
 
CalculatorBranch ConnectCalculatorBranch (int branchID, int inputNodeID, Object inputObj, CalculatorSlot inputSlot, int outputNodeID, Object outputObj, CalculatorSlot outputSlot)
 Connect CalculatorSlot. More...
 
CalculatorBranch ConnectCalculatorBranch (int inputNodeID, Object inputObj, CalculatorSlot inputSlot, int outputNodeID, Object outputObj, CalculatorSlot outputSlot)
 Connect CalculatorSlot. More...
 
void DisconnectCalculatorBranch (Object obj)
 Method to be used internally. More...
 
void DeleteCalculatorBranch (CalculatorBranch branch)
 Delete calculator branch. More...
 
bool CheckLoopCalculatorBranch (int inputNodeID, Object inputObj, int outputNodeID, Object outputObj)
 Check if CalculatorBranch is looping. More...
 
delegate void NodeGraphCallback (NodeGraph nodeGraph)
 Delegate for NodeGraph callback More...
 
void DestroySubComponents ()
 Method to be used internally. More...
 
override string ToString ()
 Convert graph to string (for debugging). More...
 
- Public Attributes inherited from ArborFSMInternal
bool playOnStart = true
 Flag to be played at the start. More...
 
UpdateSettings updateSettings = new UpdateSettings()
 Settings related to updating. More...
 
- Public Attributes inherited from NodeGraph
string graphName
 The Graph name. More...
 
- Protected Member Functions inherited from ArborFSMInternal
override bool OnDeleteNode (Node node)
 Delete node. More...
 
override void OnValidate ()
 See MonoBehaviour.OnValidate. More...
 
sealed override void OnReset ()
 Reset or create callback. More...
 
- Properties inherited from ArborFSMInternal
PlayState playState [get]
 Play state More...
 
string fsmName [get, set]
 The FSM name. More...
 
int startStateID [get]
 Gets the start state identifier. More...
 
State currentState [get]
 Gets Arbor.State of the current. More...
 
State nextState [get]
 Gets Arbor.State of the next state. More...
 
int stateCount [get]
 Get a count of State. More...
 
StateLinkRerouteNodeList stateLinkRerouteNodes [get]
 StateLinkRerouteNode List More...
 
State[] states [get]
 Gets all of Arbor.State. More...
 
- Properties inherited from NodeGraph
string displayGraphName [get]
 Display name of the node graph. More...
 
NodeGraph parentGraph [get]
 Parent graph More...
 
NodeGraph rootGraph [get]
 Root graph More...
 
Object ownerBehaviourObject [get, set]
 Object of NodeBehaviour own this graph More...
 
NodeBehaviour ownerBehaviour [get, set]
 NodeBehaviour is the owner of this graph More...
 
bool external [get]
 Flag instantiated from external graph More...
 
int nodeCount [get]
 Get a count of Node. More...
 
int calculatorCount [get]
 Get a count of CalculatorNode. More...
 
CalculatorNode[] calculators [get]
 Gets all of Arbor.CalculatorNode. More...
 
int commentCount [get]
 Get a count of CommentNode. More...
 
CommentNode[] comments [get]
 Gets all of Arbor.CommentNode. More...
 
int groupCount [get]
 Get a count of GroupNode. More...
 
CalculatorBranchRerouteNodeList calculatorBranchRerouteNodes [get]
 CalculatorBranchRerouteNode list More...
 
int calculatorBranchCount [get]
 Get a count of CalculatorBranch. More...
 
CalculatorBranch[] calculatorBranchies [get]
 Gets all of Arbor.CalculatorBranch. More...
 
- Events inherited from NodeGraph
NodeGraphCallback destroyCallback
 Call back when being destroyed More...
 
NodeGraphCallback stateChangedCallback
 Call back when the state changes More...
 

Detailed Description

Core part of StateMachine.


Is used by attaching to GameObject.

Click on the Open Editor button to open the Arbor Editor Window.

Member Function Documentation

static ArborFSM FindFSM ( string  name)
static

Get the ArborFSM that in the scene with the name.

Parameters
nameThe name of the search ArborFSM
Returns
Found ArborFSM. Returns null if not found.
static ArborFSM FindFSM ( GameObject  gameObject,
string  name 
)
static

Get ArborFSM in the name that has been attached to the GameObject.

Parameters
gameObjectWant to search GameObject.
nameThe name of the search ArborFSM.
Returns
Found ArborFSM. Returns null if not found.
static ArborFSM [] FindFSMs ( string  name)
static

Get the ArborFSM of the same name that is in the scene.

Parameters
nameThe name of the search ArborFSM.
Returns
Array of found ArborFSM.
static ArborFSM [] FindFSMs ( GameObject  gameObject,
string  name 
)
static

Get the ArborFSM of the same name that is attached to a GameObject.

Parameters
gameObjectWant to search GameObject.
nameThe name of the search ArborFSM.
Returns
Array of found ArborFSM.