eris  1.4.0
A WorldForge client library.
Eris::Task Class Reference
Inheritance diagram for Eris::Task:
Collaboration diagram for Eris::Task:

Public Member Functions

 Task (Entity &owner, std::string name)
 
const std::string & name () const
 Gets the name of the task. More...
 
double progress () const
 Return the current progress of the task. Value will always be in the range [0..1]. More...
 
double progressRate () const
 Gets the progress rate. More...
 
bool isComplete () const
 Returns true if the task has completed. More...
 
const std::vector< TaskUsage > & getUsages () const
 

Public Attributes

sigc::signal< void > Completed
 
sigc::signal< void > Progressed
 
sigc::signal< void > ProgressRateChanged
 
sigc::signal< void > UsagesChanged
 

Friends

class View
 
class Entity
 

Detailed Description

Definition at line 28 of file Task.h.

Constructor & Destructor Documentation

◆ Task()

Eris::Task::Task ( Entity owner,
std::string  name 
)

Create a new task owned by the specified entity

Definition at line 19 of file Task.cpp.

Member Function Documentation

◆ isComplete()

bool Eris::Task::isComplete ( ) const

Returns true if the task has completed.

Returns
True if the task has completed.

Definition at line 33 of file Task.cpp.

◆ name()

const std::string & Eris::Task::name ( ) const
inline

Gets the name of the task.

Returns
The name of the task.

Definition at line 94 of file Task.h.

◆ progress()

double Eris::Task::progress ( ) const
inline

Return the current progress of the task. Value will always be in the range [0..1].

Definition at line 98 of file Task.h.

◆ progressRate()

double Eris::Task::progressRate ( ) const
inline

Gets the progress rate.

Returns

Definition at line 102 of file Task.h.


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