1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
// Cyphesis Online RPG Server and AI Engine
// Copyright (C) 2004-2005 Alistair Riddoch
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software Foundation,
// Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
// $Id: Task.h,v 1.17 2008-01-13 01:32:55 alriddoch Exp $
#ifndef RULESETS_TASK_H
#define RULESETS_TASK_H
#include "common/OperationRouter.h"
#include <string>
#include <cassert>
class Character;
/// \brief Interface class for handling tasks which take a short while to
/// complete
class Task {
private:
/// \brief Count of references held by entities involved in this task
int m_refCount;
protected:
/// \brief Serial number of the tick due to arrive next at this task.
int m_serialno;
/// \brief Flag to indicate if this task is obsolete and should be removed
bool m_obsolete;
/// \brief Progress towards task completion
float m_progress;
/// \brief Rate of progress towards task completion
float m_rate;
/// \brief Character performing the task
///
/// This doesn't handle the idea that there might be multiple actors
/// involved.
Character & m_character;
/// \brief Name of task presented to client
std::string m_name;
/// \brief Protected constructor to be called by classes which inherit
explicit Task(Character & chr);
private:
/// \brief Private and un-implemented, to make sure slicing is impossible
Task(const Task & t);
/// \brief Private and un-implemented, to make sure slicing is impossible
const Task & operator=(const Task &);
public:
virtual ~Task();
/// \brief Flag this task as obsolete
virtual void irrelevant();
/// \brief Handle the operation that instigates the task
///
/// @param op The operation to be processed
/// @param res The result of the operation is returned here.
virtual void initTask(const Operation & op, OpVector & res) = 0;
/// \brief Handle a tick operation to perform the task
///
/// A Task gets regular ticks which cause whatever actions this
/// Task involves to be returned.
/// @param op The operation to be processed
/// @param res The result of the operation is returned here.
virtual void TickOperation(const Operation & op, OpVector & res) = 0;
/// \brief Add a representation of this task to an entity
///
/// Adds a TASK attribute to the entity, which is a list containing
/// an atlas representation of this task.
virtual void addToEntity(const Atlas::Objects::Entity::RootEntity &);
/// \brief Create a new tick op for the next iteration of this task
Operation nextTick(double interval);
/// \brief Increment the reference count on this task
void incRef() {
++m_refCount;
}
/// \brief Decrement the reference count on this task
void decRef() {
if (m_refCount <= 1) {
assert(m_refCount == 1);
delete this;
} else {
--m_refCount;
}
}
/// \brief Return the number of entities involved in this task
int count() const {
return m_refCount;
}
/// \brief Return the number of the next to arrive at this task
int serialno() const {
return m_serialno;
}
/// \brief Return a new tick serial number.
int newTick() {
return ++m_serialno;
}
/// \brief Accessor to determine if this Task is obsolete
const bool obsolete() { return m_obsolete; }
/// \brief Accessor for character that owns this Task.
Character & character() const { return m_character; }
/// \brief Accessor for name of this task
std::string & name() { return m_name; }
/// \brief Accessor for progress towards completion
float & progress() { return m_progress; }
/// \brief Accessor for rate of progress towards completion
float & rate() { return m_rate; }
};
#endif // RULESETS_TASK_H
|
