dtActors::TaskActorOrderedProxy Class Reference

Proxy for the game event task actor. More...

#include <taskactorordered.h>

Inheritance diagram for dtActors::TaskActorOrderedProxy:

List of all members.

Public Member Functions
	TaskActorOrderedProxy ()
	Constructs the ordered task actor proxy.
virtual void	BuildPropertyMap ()
	Builds the property map for the ordered task proxy.
virtual bool	RequestScoreChange (const TaskActorProxy &childTask, const TaskActorProxy &origTask)
	Overriding this method applies the ordering rules inherent to the ordered task actor.
virtual void	NotifyScoreChanged (const TaskActorProxy &childTask)
	Updates this tasks total score tracking based on the newly changed child task.
const TaskActorProxy *	GetFailingTaskProxy () const
	Gets the last task that requested a score change out of order.
Protected Member Functions
virtual	~TaskActorOrderedProxy ()
	Destroys the proxy.
virtual void	CreateActor ()
	Create the underlying rollup task actor to be managed by this proxy.
void	SetFailingTaskProxy (const TaskActorProxy &task)
	Sets the last known task that attempted to change its status out of order.
Friends
class	TaskActorOrdered

---

Detailed Description

Proxy for the game event task actor.

It contains properties to track the number of occurances of an event as well as determine how many times a game event is listened for before completeness can occur.

---

Constructor & Destructor Documentation

dtActors::TaskActorOrderedProxy::TaskActorOrderedProxy

(

)

Constructs the ordered task actor proxy.

dtActors::TaskActorOrderedProxy::~TaskActorOrderedProxy

(

)

[protected, virtual]

Destroys the proxy.

---

Member Function Documentation

void dtActors::TaskActorOrderedProxy::BuildPropertyMap

(

)

[virtual]

Builds the property map for the ordered task proxy.

These properties wrap the specified properties located in the ordered task actor.

Reimplemented from dtActors::TaskActorProxy.

bool dtActors::TaskActorOrderedProxy::RequestScoreChange	(	const TaskActorProxy &	childTask,
		const TaskActorProxy &	origTask
	)			[virtual]

Overriding this method applies the ordering rules inherent to the ordered task actor.

If a task is completed out of order one of two things may happen depending on the value of the failure property and the child task requesting the change is rejected. Also note that the original task that first instigated the change (a leaf node in the task tree) is slated as the cause for the failure.

Parameters:

	childTask	The child task seeking approval.
	origTask	The tree node in the task list that first instigated the request.

Returns:

True if a score change is allowed, false otherwise.

See also:

SetFailureType

GetFailureType

Reimplemented from dtActors::TaskActorProxy.

void dtActors::TaskActorOrderedProxy::NotifyScoreChanged

(

const TaskActorProxy &

childTask

)

[virtual]

Updates this tasks total score tracking based on the newly changed child task.

Parameters:

childTask

The child task that issued the score changed notify.

Reimplemented from dtActors::TaskActorProxy.

const TaskActorProxy* dtActors::TaskActorOrderedProxy::GetFailingTaskProxy

(

)

const [inline]

Gets the last task that requested a score change out of order.

Returns:

The "bad" task.

void dtActors::TaskActorOrderedProxy::CreateActor

(

)

[protected, virtual]

Create the underlying rollup task actor to be managed by this proxy.

Reimplemented from dtActors::TaskActorProxy.

void dtActors::TaskActorOrderedProxy::SetFailingTaskProxy

(

const TaskActorProxy &

task

)

[inline, protected]

Sets the last known task that attempted to change its status out of order.

Parameters:

task

The "bad" task.

---

Friends And Related Function Documentation

friend class TaskActorOrdered [friend]

---