RAIN.Path.WaypointPathFollower Class Reference

Inheritance diagram for RAIN.Path.WaypointPathFollower:

List of all members.

Public Member Functions
override void	SetActionContext (ActionContext context)
	SetActionContext is used to pass a reference to a shared action context. An Action should ensure that its own current state is set/reset based on the new action context. An Action should also usually call SetActionContext on any child actions.
override ActionResult	Start (Agent agent, float deltaTime)
	Start is called by an Action Executor one time prior to calling consecutive Execute calls.
override ActionResult	Execute (Agent agent, float deltaTime)
	Execute is called by an Action Executor to perform the work of the Action. An Action can run to completion, but will typically perform only the work for a single timestep, then continue at the next timestep for long running actions.
override ActionResult	Stop (Agent agent, float deltaTime)
	Stop is called to support cleanup and termination of execution activites. Stop should always be called by the Action Executor after a Start, regardless of the SUCCESS or FAILURE of any Execute calls.
Public Attributes
const string	ACTION_NAME = "WaypointPathFollower"
bool	useNavGridPathFollowing = false

---

Member Function Documentation

override ActionResult RAIN.Path.WaypointPathFollower.Execute	(	Agent	agent,
		float	deltaTime
	)		[virtual]

Execute is called by an Action Executor to perform the work of the Action. An Action can run to completion, but will typically perform only the work for a single timestep, then continue at the next timestep for long running actions.

Parameters:

agent	The AI agent owning this action
deltaTime	timestep in seconds

Returns:

Returns SUCCESS if the action completed successfully, FAILURE if a failure occured, RUNNING if more work is to be done

Reimplemented from RAIN.Action.Action.

override void RAIN.Path.WaypointPathFollower.SetActionContext

(

ActionContext

context

)

[virtual]

SetActionContext is used to pass a reference to a shared action context. An Action should ensure that its own current state is set/reset based on the new action context. An Action should also usually call SetActionContext on any child actions.

Parameters:

context

Reimplemented from RAIN.Action.Action.

override ActionResult RAIN.Path.WaypointPathFollower.Start	(	Agent	agent,
		float	deltaTime
	)		[virtual]

Start is called by an Action Executor one time prior to calling consecutive Execute calls.

Parameters:

agent	The AI agent owning this action
deltaTime	timestep in seconds

Returns:

Returns an ActionResult of SUCCESS or FAILURE, which may be ignored by the caller if desired

Reimplemented from RAIN.Action.Action.

override ActionResult RAIN.Path.WaypointPathFollower.Stop	(	Agent	agent,
		float	deltaTime
	)		[virtual]

Stop is called to support cleanup and termination of execution activites. Stop should always be called by the Action Executor after a Start, regardless of the SUCCESS or FAILURE of any Execute calls.

Parameters:

agent	The AI agent owning this action
deltaTime	timestep in seconds

Returns:

Returns an ActionResult of SUCCESS or FAILURE, which may be ignored by the caller if desired

Reimplemented from RAIN.Action.Action.