Photon 0.0.2

Simple Open Source 2D Game API

TaskManager

TaskManager class, maintains a list of Tasks and manages their status, handles adding, deleting, pausing, and unpausing tasks.

To use TaskManager

(1) Add any tasks (should be derived from Task)
(2) Call step() every frame when task should update.

Summary

TaskManager	TaskManager class, maintains a list of Tasks and manages their status, handles adding, deleting, pausing, and unpausing tasks.
(Con/ De)structors
TaskManager	TaskManager constructor, initializes task manager
~TaskManager	TaskManager destructor, destroys task manager
Running
step	Steps the task manager, calling each active task once.
Task Management
addTask	Add a new Task to the TaskManager’s list.
killTask	Kill a task in the TaskManager task list.
pauseTask	Pause a task in the TaskManager task list.
unpauseTask	Unpause a task in the TaskManager task list.
killAllTasks	Kills all tasks.

(Con/ De)structors

TaskManager

TaskManager()

TaskManager constructor, initializes task manager

~TaskManager

~TaskManager()

TaskManager destructor, destroys task manager

Running

step

void step( scalar timeDelta )

Steps the task manager, calling each active task once.

Each ‘step’ all tasks are run in order of their priorities, if two tasks have the same priority, they are run in the order they were added.

Parameters

timeDelta

The time elapsed between frames, possibly fixed via Application::setFixedUpdateStep.

Task Management

addTask

void addTask( TaskPtr task )

Add a new Task to the TaskManager’s list. All tasks MUST have unique names.

Parameters

task	<TaskPtr> representing instance of Task subclass to add.

killTask

void killTask( const std:: string & taskName )

Kill a task in the TaskManager task list. Dead tasks are removed in next loop through tasks.

Parameters

taskName

Name of task to kill.

pauseTask

void pauseTask( const std:: string & taskName )

Pause a task in the TaskManager task list.

Parameters

taskName

Name of task to pause.

unpauseTask

void unpauseTask( const std:: string & taskName )

Unpause a task in the TaskManager task list.

Parameters

taskName

Name of task to unpause.

killAllTasks

void killAllTasks()

Kills all tasks. Dead tasks are removed in next loop through tasks.

TaskManager()

TaskManager constructor, initializes task manager

~TaskManager()

TaskManager destructor, destroys task manager

void step( scalar timeDelta )

Steps the task manager, calling each active task once.

void addTask( TaskPtr task )

Add a new Task to the TaskManager’s list.

void killTask( const std:: string & taskName )

Kill a task in the TaskManager task list.

void pauseTask( const std:: string & taskName )

Pause a task in the TaskManager task list.

void unpauseTask( const std:: string & taskName )

Unpause a task in the TaskManager task list.

void killAllTasks()

Kills all tasks.

void setFixedUpdateStep( bool enable,
scalar fixedStep,
scalar maxStep = )

Sets a fixed timestep to be used in calls to the current State’s update method.