summaryrefslogtreecommitdiff
path: root/src/object.h
blob: a696ea519dcb5bd94e09b8ee7114a48642c470b9 (plain) (blame)
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
144
145
146
147
/*
 *  The Mana World Server
 *  Copyright 2004 The Mana World Development Team
 *
 *  This file is part of The Mana World.
 *
 *  The Mana World  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 any later version.
 *
 *  The Mana  World 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 The Mana  World; if not, write to the  Free Software Foundation, Inc.,
 *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 *  $Id$
 */


#ifndef _TMWSERV_OBJECT_H_
#define _TMWSERV_OBJECT_H_


namespace tmwserv
{


/**
 * Structure type for the statistics.
 *
 * Notes:
 *     - the structure can be used to define stats modifiers (i.e. how an
 *       object would modify the stats of a being when it is equipped) or
 *       computed stats of a being.
 *     - the attributes are not unsigned to allow negative values.
 */
struct Statistics
{
    int health;
    int attack;
    int defense;
    int magic;
    int accuracy;
    int speed;
};


/**
 * Generic in-game object definition.
 * Base class for in-game objects.
 */
class Object
{
    public:
        /**
         * Default constructor.
         */
        Object(void);


        /**
         * Destructor.
         */
        virtual
        ~Object(void)
            throw();


        /**
         * Set the x coordinate.
         *
         * @param x the new x coordinate.
         */
        void
        setX(unsigned int x);


        /**
         * Get the x coordinate.
         *
         * @return the x coordinate.
         */
        unsigned int
        getX(void) const;


        /**
         * Set the y coordinate.
         *
         * @param y the new y coordinate.
         */
        void
        setY(unsigned int y);


        /**
         * Get the y coordinate.
         *
         * @return the y coordinate.
         */
        unsigned int
        getY(void) const;


        /**
         * Set the statistics.
         *
         * @param stats the statistics.
         */
        void
        setStatistics(const Statistics& stats);


        /**
         * Get the statistics.
         *
         * @return the statistics.
         */
        Statistics&
        getStatistics(void);


        /**
         * Update the internal status.
         */
        virtual void
        update(void) = 0;


    protected:
        Statistics mStats; /**< stats modifiers or computed stats */


    private:
        unsigned int mX;   /**< x coordinate */
        unsigned int mY;   /**< y coordinate */
};


} // namespace tmwserv


#endif // _TMWSERV_OBJECT_H_