StateBehaviour Class Reference

Class that defines the behavior of the State. More...

Inheritance diagram for StateBehaviour:

Public Member Functions
virtual void	OnStateAwake ()
	Called when [state enter first]. More...
virtual void	OnStateBegin ()
	Called when [state enter]. More...
virtual void	OnStateEnd ()
	Called when [state exit]. More...
virtual void	OnStateTrigger (string message)
	Called from SendTrigger. More...
bool	Transition (int nextStateID, bool force)
	State transition More...
bool	Transition (int stateID)
	State transition. More...
bool	Transition (State nextState, bool force)
	State transition More...
bool	Transition (State nextState)
	State transition. More...
bool	Transition (StateLink nextStateLink, bool force)
	State transition More...
bool	Transition (StateLink nextStateLink)
	State transition. More...
StateBehaviour	AddBehaviour (System.Type type)
	Adds the behaviour. More...
T	AddBehaviour< T > ()
	Adds the behaviour. More...
StateBehaviour	GetBehaviour (System.Type type)
	Gets the behaviour. More...
T	GetBehaviour< T > ()
	Gets the behaviour. More...
StateBehaviour[]	GetBehaviours (System.Type type)
	Gets the behaviours. More...
T[]	GetBehaviours< T > ()
	Gets the behaviours. More...
void	Destroy ()
	Destroys this instance. More...

Public Attributes
bool	expanded = true

Properties
ArborFSMInternal	stateMachine [get]
	Gets the state machine. More...
State	state [get]
	Get the State. More...
int	stateID [get]
	Gets the state identifier. More...
bool	behaviourEnabled [get, set]
	Gets or sets a value indicating whether [behaviour enabled]. More...

Detailed Description

Class that defines the behavior of the State.

Inherited and to use.

Member Function Documentation

StateBehaviour AddBehaviour

(

System.Type

type

)

Adds the behaviour.

Parameters

type	Type of add StateBehaviour

Returns

Added StateBehaviour

T AddBehaviour< T >

(

)

Adds the behaviour.

Template Parameters

T	Type of add StateBehaviour

Returns

Added StateBehaviour

Type Constraints

T

:

StateBehaviour

void Destroy

(

)

Destroys this instance.

StateBehaviour GetBehaviour

(

System.Type

type

)

Gets the behaviour.

Parameters

type	Type of you want to get StateBehaviour.

Returns

Found StateBehaviour. Or null if it is not.

T GetBehaviour< T >

(

)

Gets the behaviour.

Template Parameters

T	Type of you want to get StateBehaviour.

Returns

Found StateBehaviour. Or null if it is not.

Type Constraints

T

:

StateBehaviour

StateBehaviour [] GetBehaviours

(

System.Type

type

)

Gets the behaviours.

Parameters

type	Type of you want to get StateBehaviour.

Returns

Array of found StateBehaviour.

T [] GetBehaviours< T >

(

)

Gets the behaviours.

Template Parameters

T	Type of you want to get StateBehaviour.

Returns

Array of found StateBehaviour.

Type Constraints

T

:

StateBehaviour

virtual void OnStateAwake ( )

virtual

Called when [state enter first].

virtual void OnStateBegin ( )

virtual

Called when [state enter].

virtual void OnStateEnd ( )

virtual

Called when [state exit].

virtual void OnStateTrigger ( string  message )

virtual

Called from SendTrigger.

Parameters

message

Message

bool Transition	(	int	nextStateID,
		bool	force
	)

State transition

Parameters

nextStateID	State ID for the transition destination.
force	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

stateID

)

State transition.

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

Parameters

stateID

State ID for the transition destination.

Returns

Whether or not the transition

bool Transition	(	State	nextState,
		bool	force
	)

State transition

Parameters

nextState	Destination state.
force	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	(	StateLink	nextStateLink,
		bool	force
	)

State transition

Parameters

nextStateLink	The destination of transition.
force	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

bool expanded = true

Property Documentation

bool behaviourEnabled

getset

Gets or sets a value indicating whether [behaviour enabled].

true if [behaviour enabled]; otherwise, false.

State state

get

Get the State.

int stateID

get

Gets the state identifier.

ArborFSMInternal stateMachine

get

Gets the state machine.