ArborFSMInternal Class Reference

Internal class of Arbor.ArborFSM. More...

Inheritance diagram for ArborFSMInternal:

Public Member Functions
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
string	fsmName
	The FSM name. More...

Properties
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

Internal class of Arbor.ArborFSM.

To actually attach to GameObject is to use the Arbor.ArborFSM.

Member Function Documentation

CalculatorNode CreateCalculator

(

System.Type

calculatorType

)

Create calculator.

Returns

The created calculator.

CalculatorBranch CreateCalculatorBranch

(

)

Create calculator.

Returns

The created calculator.

CommentNode CreateComment

(

)

Create comment.

Returns

The created comment.

GroupNode CreateGroup

(

)

Create group.

Returns

The created group.

State CreateState

(

bool

resident

)

Create state.

Parameters

resident

Resident whether flags.

Returns

The created state.

State CreateState

(

)

Create state.

Returns

The created state.

bool DeleteCalculator

(

CalculatorNode

calculatorNode

)

Delete calculator.

Parameters

calculatorNode

Calculator that you want to delete.

Returns

true if deleted

void DeleteCalculatorBranch

(

CalculatorBranch

branch

)

Delete calculator branch.

Parameters

branch

Calculator branch that you want to delete.

void DeleteComment

(

CommentNode

comment

)

Delete comment.

Parameters

comment

Comment that you want to delete.

void DeleteGroup

(

GroupNode

group

)

Delete group.

Parameters

group

Group that you want to delete.

bool DeleteNode

(

Node

node

)

Delete node.

Parameters

node	Node that you want to delete.

Returns

true if deleted

bool DeleteState

(

State

state

)

Delete state.

Parameters

state

State that you want to delete.

Returns

true if deleted

void DestroySubComponents

(

)

Method to be used internally.

In particular there is no need to call.

void DisconnectCalculatorBranch

(

Object

obj

)

Method to be used internally.

In particular there is no need to call.

CalculatorNode FindCalculator

(

Calculator

calculator

)

Acquisition of CalculatorNodes Calculator belongs.

Parameters

calculator

Calculator

Returns

CalculatorNodes Calculator belongs. Return null if not.

State FindState

(

string

stateName

)

Search state by name.

Parameters

stateName

The name of the search state.

Returns

Found state. Return null if not.

State FindStateContainsBehaviour

(

StateBehaviour

behaviour

)

Acquisition of states StateBehaviour belongs.

Parameters

behaviour

StateBehaviour

Returns

States StateBehaviour belongs. Return null if not.

State [] FindStates

(

string

stateName

)

Search state by name.

Parameters

stateName

The name of the search state.

Returns

Array of found state.

CalculatorBranch GetCalculatorBranchFromID

(

int

branchID

)

Gets Arbor.CalculatorBranch from the calculator branch identifier.

Parameters

branchID

The calculator branch identifier.

Returns

Found Arbor.CalculatorBranch. Returns null if not found.

CalculatorBranch GetCalculatorBranchFromIndex

(

int

index

)

Get CalculatorBranch from index.

Parameters

index

Index

Returns

CalculatorBranch

int GetCalculatorBranchIndex

(

CalculatorBranch

branch

)

Get CalculatorBranch index.

Parameters

branch

CalculatorBranch

Returns

Index. If not, it returns -1.

CalculatorNode GetCalculatorFromID

(

int

calculatorID

)

Gets Arbor.CalculatorNode from the calculator identifier.

Parameters

calculatorID

The calculator identifier.

Returns

Found Arbor.CalculatorNode. Returns null if not found.

CalculatorNode GetCalculatorFromIndex

(

int

index

)

Get CalculatorNode from index.

Parameters

index

Index

Returns

CalculatorNode

int GetCalculatorIndex

(

CalculatorNode

calculator

)

Get CalculatorNode index.

Parameters

calculator

CalculatorNode

Returns

Index. If not, it returns -1.

CommentNode GetCommentFromID

(

int

commentID

)

Gets Arbor.CommentNode from the comment identifier.

Parameters

commentID

The comment identifier.

Returns

Found Arbor.CommentNode. Returns null if not found.

CommentNode GetCommentFromIndex

(

int

index

)

Get CommentNode from index.

Parameters

index

Index

Returns

CommentNode

int GetCommentIndex

(

CommentNode

comment

)

Get CommentNode index.

Parameters

comment

CommentNode

Returns

Index. If not, it returns -1.

GroupNode GetGroupFromID

(

int

groupID

)

Gets Arbor.GroupNode from the group identifier.

Parameters

groupID

The group identifier.

Returns

Found Arbor.GroupNode. Returns null if not found.

GroupNode GetGroupFromIndex

(

int

index

)

Get GroupNode from index.

Parameters

index

Index

Returns

GroupNode

Node GetNodeFromID

(

int

nodeID

)

Gets Arbor.Node from the node identifier.

Parameters

nodeID

The node identifier.

Returns

Found Arbor.Node. Returns null if not found.

Node GetNodeFromIndex

(

int

index

)

Get Node from index.

Parameters

index

Index

Returns

Node

State GetStateFromID

(

int

stateID

)

Gets Arbor.State from the state identifier.

Parameters

stateID

The state identifier.

Returns

Found Arbor.State. Returns null if not found.

State GetStateFromIndex

(

int

index

)

Get State from index.

Parameters

index

Index

Returns

State

int GetStateIndex

(

State

state

)

Get State index.

Parameters

index

Index

Returns

Index. If not, it returns -1.

int IndexOfStateLinkHistory

(

StateLink

stateLink

)

Retrieve the index in the history that transited by the specified StateLink.

Parameters

stateLink

StateLink to acquire

Returns

Index of history. -1 is not eligible. Larger values indicate older transitions.

virtual void OnAfterDeserialize ( )

virtual

virtual void OnBeforeSerialize ( )

virtual

void Refresh

(

)

Method to be used internally.

In particular there is no need to call.

void SendTrigger

(

string

message

)

Sending of trigger

Parameters

message

Message to be sent

bool Transition	(	State	nextState,
		bool	immediateTransition
	)

State transition

Parameters

nextState	Destination state.
immediateTransition	Whether or not to transition immediately. If false I will transition to the end of the current frame (when LateUpdate).

Returns

Whether or not the transition

bool Transition

(

State

nextState

)

State transition.

Timing to actually transition current frame last (when LateUpdate).

Parameters

nextState

Destination state.

Returns

Whether or not the transition

bool Transition	(	int	nextStateID,
		bool	immediateTransition
	)

State transition

Parameters

nextStateID	State ID for the transition destination.
immediateTransition	Whether or not to transition immediately. If false I will transition to the end of the current frame (when LateUpdate).

Returns

Whether or not the transition

bool Transition

(

int

nextStateID

)

State transition.

Timing to actually transition current frame last (when LateUpdate).

Parameters

nextStateID

State ID for the transition destination.

Returns

Whether or not the transition

bool Transition	(	StateLink	nextStateLink,
		bool	immediateTransition
	)

State transition

Parameters

nextStateLink	The destination of transition.
immediateTransition	Whether or not to transition immediately. If false I will transition to the end of the current frame (when LateUpdate).

Returns

Whether or not the transition

bool Transition

(

StateLink

nextStateLink

)

State transition.

Timing to actually transition current frame last (when LateUpdate).

Parameters

nextStateLink

The destination of transition.

Returns

Whether or not the transition

Member Data Documentation

string fsmName

The FSM name.

It is used for identification and retrieval when there is more than one FSM in one GameObject.

Property Documentation

int calculatorBranchCount

get

Get a count of CalculatorBranch.

CalculatorBranch [] calculatorBranchies

get

Gets all of Arbor.CalculatorBranch.

int calculatorCount

get

Get a count of CalculatorNode.

CalculatorNode [] calculators

get

Gets all of Arbor.CalculatorNode.

int commentCount

get

Get a count of CommentNode.

CommentNode [] comments

get

Gets all of Arbor.CommentNode.

State currentState

get

Gets Arbor.State of the current.

Arbor.State of the current.

int groupCount

get

Get a count of GroupNode.

State nextState

get

Gets Arbor.State of the next state.

Arbor.State of the next state.

int nodeCount

get

Get a count of Node.

int startStateID

get

Gets the start state identifier.

The start state identifier.

int stateCount

get

Get a count of State.

State [] states

get

Gets all of Arbor.State.

Array of Arbor.State.