AIFriendOfStatefulTask Class Reference

Detailed Description

A hook to the protected control functions of AIStatefulTask.

Allows to call the protected control functions of a task.

Usage:

class MyTool : public AIFriendOfStatefulTask
{
 public:
  // Task is the (base class of the) class containing this MyTool as member object.
  MyTool(AIStatefulTask* task) : AIFriendOfStatefulTask(task) { }
 
  void f()
  {
    // Now we can call the protected control functions of `task`.
    yield();
  }
};

#include <AIFriendOfStatefulTask.h>

Inheritance diagram for AIFriendOfStatefulTask:

Collaboration diagram for AIFriendOfStatefulTask:

Public Types
using	state_type = AIStatefulTask::state_type
	Proxy for AIStatefulTask::state_type.
using	condition_type = AIStatefulTask::condition_type
	Proxy for AIStatefulTask::condition_type.

Protected Member Functions
	AIFriendOfStatefulTask (AIStatefulTask *task)
	Construct a friend of task.
void	set_state (state_type new_state)
	Proxy for AIStatefulTask::set_state.
void	wait (condition_type conditions)
	Proxy for AIStatefulTask::wait.
void	wait_until (AIWaitConditionFunc const &wait_condition, condition_type conditions)
	Proxy for AIStatefulTask::wait_until.
void	wait_until (AIWaitConditionFunc const &wait_condition, condition_type conditions, state_type new_state)
	Proxy for AIStatefulTask::wait_until.
void	finish ()
	Proxy for AIStatefulTask::finish.
void	yield ()
	Proxy for AIStatefulTask::yield.
void	target (AIEngine *engine)
	Proxy for AIStatefulTask::target.
void	yield (AIEngine *engine)
	Proxy for AIStatefulTask::yield.
void	yield_frame (AIEngine *engine, unsigned int frames)
	Proxy for AIStatefulTask::yield_frame.
void	yield_ms (AIEngine *engine, unsigned int ms)
	Proxy for AIStatefulTask::yield_ms.
bool	yield_if_not (AIEngine *engine)
	Proxy for AIStatefulTask::yield_if_not.

Protected Attributes
AIStatefulTask *	m_task
	The base class of the object that this object is a member of.

---

The documentation for this class was generated from the following file:

• statefultask/AIFriendOfStatefulTask.h