Arbor: State Diagram Editor  2.2.0
ArborFSM Class Reference

Core part of Arbor. More...

Inheritance diagram for ArborFSM:
ArborFSMInternal

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...
 

Additional Inherited Members

- Public Member Functions inherited from ArborFSMInternal
Node GetNodeFromIndex (int index)
 Get Node from index. More...
 
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...
 
CommentNode GetCommentFromIndex (int index)
 Get CommentNode from index. More...
 
int GetCommentIndex (CommentNode comment)
 Get CommentNode index. More...
 
CalculatorNode GetCalculatorFromIndex (int index)
 Get CalculatorNode from index. More...
 
int GetCalculatorIndex (CalculatorNode calculator)
 Get CalculatorNode index. More...
 
GroupNode GetGroupFromIndex (int index)
 Get GroupNode from index. More...
 
CalculatorBranch GetCalculatorBranchFromIndex (int index)
 Get CalculatorBranch from index. More...
 
int GetCalculatorBranchIndex (CalculatorBranch branch)
 Get CalculatorBranch index. More...
 
Node GetNodeFromID (int nodeID)
 Gets Arbor.Node from the node identifier. More...
 
State GetStateFromID (int stateID)
 Gets Arbor.State from the state identifier. More...
 
CommentNode GetCommentFromID (int commentID)
 Gets Arbor.CommentNode from the comment identifier. More...
 
CalculatorNode GetCalculatorFromID (int calculatorID)
 Gets Arbor.CalculatorNode from the calculator identifier. More...
 
GroupNode GetGroupFromID (int groupID)
 Gets Arbor.GroupNode from the group identifier. More...
 
CalculatorBranch GetCalculatorBranchFromID (int branchID)
 Gets Arbor.CalculatorBranch from the calculator branch identifier. More...
 
State CreateState (bool resident)
 Create state. More...
 
State CreateState ()
 Create state. More...
 
CommentNode CreateComment ()
 Create comment. More...
 
CalculatorNode CreateCalculator (System.Type calculatorType)
 Create calculator. More...
 
GroupNode CreateGroup ()
 Create group. More...
 
CalculatorBranch CreateCalculatorBranch ()
 Create calculator. 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...
 
CalculatorNode FindCalculator (Calculator calculator)
 Acquisition of CalculatorNodes Calculator belongs. More...
 
void DisconnectCalculatorBranch (Object obj)
 Method to be used internally. More...
 
bool DeleteState (State state)
 Delete state. More...
 
void DeleteComment (CommentNode comment)
 Delete comment. More...
 
bool DeleteCalculator (CalculatorNode calculatorNode)
 Delete calculator. More...
 
void DeleteGroup (GroupNode group)
 Delete group. More...
 
bool DeleteNode (Node node)
 Delete node. More...
 
void DeleteCalculatorBranch (CalculatorBranch branch)
 Delete calculator branch. More...
 
void Refresh ()
 Method to be used internally. More...
 
bool Transition (State nextState, bool immediateTransition)
 State transition More...
 
bool Transition (State nextState)
 State transition. More...
 
bool Transition (int nextStateID, bool immediateTransition)
 State transition More...
 
bool Transition (int nextStateID)
 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...
 
void DestroySubComponents ()
 Method to be used internally. More...
 
virtual void OnBeforeSerialize ()
 
virtual void OnAfterDeserialize ()
 
- Public Attributes inherited from ArborFSMInternal
string fsmName
 The FSM name. More...
 
- Properties inherited from ArborFSMInternal
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 nodeCount [get]
 Get a count of Node. More...
 
int stateCount [get]
 Get a count of State. More...
 
State[] states [get]
 Gets all of Arbor.State. More...
 
int commentCount [get]
 Get a count of CommentNode. More...
 
CommentNode[] comments [get]
 Gets all of Arbor.CommentNode. More...
 
int calculatorCount [get]
 Get a count of CalculatorNode. More...
 
CalculatorNode[] calculators [get]
 Gets all of Arbor.CalculatorNode. More...
 
int groupCount [get]
 Get a count of GroupNode. More...
 
int calculatorBranchCount [get]
 Get a count of CalculatorBranch. More...
 
CalculatorBranch[] calculatorBranchies [get]
 Gets all of Arbor.CalculatorBranch. More...
 

Detailed Description

Core part of Arbor.


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.