RAIN.Animation.AnimationRequestHandler Class Reference

AnimationRequestHandler is a stub class/component that can be added to a game object to quickly provide support for Animation driven by AI It is a simple imlementation of the IAnimationRequestHandler interface, which defines the methods RAIN will use to manipulate animation. More...

Inheritance diagram for RAIN.Animation.AnimationRequestHandler:
RAIN.Animation.IAnimationRequestHandler

List of all members.

Public Member Functions

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

AnimationRequestHandler is a stub class/component that can be added to a game object to quickly provide support for Animation driven by AI It is a simple imlementation of the IAnimationRequestHandler interface, which defines the methods RAIN will use to manipulate animation.


Member Function Documentation

virtual void RAIN.Animation.AnimationRequestHandler.AIRequest_StartAnimation ( ) [virtual]

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

Implements RAIN.Animation.IAnimationRequestHandler.

virtual void RAIN.Animation.AnimationRequestHandler.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.

Implements RAIN.Animation.IAnimationRequestHandler.

void RAIN.Animation.AnimationRequestHandler.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.

Parameters:
animparamsThe state and speed to transition to, or null to stop the animation

Implements RAIN.Animation.IAnimationRequestHandler.

virtual void RAIN.Animation.AnimationRequestHandler.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:
animparamsThe state and speed to transition to, or null to stop animation

Implements RAIN.Animation.IAnimationRequestHandler.