RAIN.Motion.AICharacterController Class Reference

AICharacterController is used to translate movement requests from the RAIN motion system into CharacterController movement requests. More...

Inheritance diagram for RAIN.Motion.AICharacterController:

List of all members.

Public Member Functions
void	Start ()
	Start is the Unity event handler for initialization.
override void	UpdateFromAvatar (Agent agent, float deltaTime)
	See AvatarController.
override void	CalculatePhysics (Agent agent, float deltaTime)
	See AvatarController.
override void	ApplyPhysicsToAvatar (Agent agent, float deltaTime)
	See AvatarController.
virtual void	HandleAIAnimationStateTransition (AnimationParams animparams)
	HandleAIAnimationStateTransition is called whenever the AI wants to transition from its current animation state to a new one. If a null animationState is requested, animation playback will be stopped. If a non-null value is passed and animation has not already been started, it will be started.
virtual void	AIRequest_StartAnimation ()
	AIRequest_StartAnimation is called to start animation playback based on the last set animation state.
virtual void	AIRequest_StopAnimation ()
	AIRequest_StopAnimation is called to stop all animation playback. The last state is remembered so that a subsequent call to AIRequest_StartAnimation will begin playback with the last state.
virtual void	HandleAIAnimationStateMovementOverride (AnimationParams animparams)
	The default implementation just passes the override to the HandleAIAnimationStateTransition Generally this method is called to override a default behavior - usually to override animation chosen through movement code.

---

Detailed Description

AICharacterController is used to translate movement requests from the RAIN motion system into CharacterController movement requests.

---

Member Function Documentation

virtual void RAIN.Motion.AICharacterController.AIRequest_StartAnimation

(

)

[virtual]

AIRequest_StartAnimation is called to start animation playback based on the last set animation state.

virtual void RAIN.Motion.AICharacterController.AIRequest_StopAnimation

(

)

[virtual]

AIRequest_StopAnimation is called to stop all animation playback. The last state is remembered so that a subsequent call to AIRequest_StartAnimation will begin playback with the last state.

override void RAIN.Motion.AICharacterController.ApplyPhysicsToAvatar	(	Agent	agent,
		float	deltaTime
	)		[virtual]

See AvatarController.

Parameters:

agent
deltaTime

Implements RAIN.Motion.AvatarController.

override void RAIN.Motion.AICharacterController.CalculatePhysics	(	Agent	agent,
		float	deltaTime
	)		[virtual]

See AvatarController.

Parameters:

agent
deltaTime

Implements RAIN.Motion.AvatarController.

virtual void RAIN.Motion.AICharacterController.HandleAIAnimationStateMovementOverride

(

AnimationParams

animparams

)

[virtual]

The default implementation just passes the override to the HandleAIAnimationStateTransition Generally this method is called to override a default behavior - usually to override animation chosen through movement code.

Parameters:

animparams

The state and speed to transition to, or null to stop the animation

virtual void RAIN.Motion.AICharacterController.HandleAIAnimationStateTransition

(

AnimationParams

animparams

)

[virtual]

HandleAIAnimationStateTransition is called whenever the AI wants to transition from its current animation state to a new one. If a null animationState is requested, animation playback will be stopped. If a non-null value is passed and animation has not already been started, it will be started.

Parameters:

animparams

The state and speed to transition to, or null to stop animation

void RAIN.Motion.AICharacterController.Start

(

)

Start is the Unity event handler for initialization.

override void RAIN.Motion.AICharacterController.UpdateFromAvatar	(	Agent	agent,
		float	deltaTime
	)		[virtual]

See AvatarController.

Parameters:

agent
deltaTime

Implements RAIN.Motion.AvatarController.