summaryrefslogtreecommitdiffstats
path: root/src/game-server/map.h
blob: 2ade1d753078ea2d894fdc6aa3da040b6338413c (plain)
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
/*
 *  The Mana Server
 *  Copyright (C) 2004-2011  The Mana World Development Team
 *
 *  This file is part of The Mana Server.
 *
 *  The Mana Server 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 Server 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 Server.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef MAP_H
#define MAP_H

#include <list>
#include <map>
#include <string>
#include <vector>

#include "utils/logger.h"
#include "utils/point.h"
#include "utils/string.h"

typedef std::list<Point> Path;

enum BlockType
{
    BLOCKTYPE_NONE = -1,
    BLOCKTYPE_WALL,
    BLOCKTYPE_CHARACTER,
    BLOCKTYPE_MONSTER,
    NB_BLOCKTYPES
};

/**
 * A meta tile stores additional information about a location on a tile map.
 * This is information that doesn't need to be repeated for each tile in each
 * layer of the map.
 */
class MetaTile
{
    public:
        MetaTile()
            : blockmask(0)
        {
            for (unsigned i = 0; i < NB_BLOCKTYPES; ++i)
                occupation[i] = 0;
        }

        unsigned occupation[NB_BLOCKTYPES];
        char blockmask;          /**< walkability bitfield */
};

class MapObject
{
    public:
        MapObject(const Rectangle &bounds,
                  const std::string &name,
                  const std::string &type)
            : mBounds(bounds),
              mName(name),
              mType(type)
        { }

        void addProperty(const std::string &key, const std::string &value)
        {
            if (mProperties.contains(key))
                LOG_WARN("Duplicate property " << key <<
                         " of object " << mName);
            else
                mProperties.insert(key, value);
        }

        const std::string &getProperty(const std::string &key) const
        { return mProperties.value(key); }

        const std::string &getName() const
        { return mName; }

        const std::string &getType() const
        { return mType; }

        const Rectangle &getBounds() const
        { return mBounds; }

        int getX() const { return mBounds.x; }
        int getY() const { return mBounds.y; }

    private:
        Rectangle mBounds;
        std::string mName;
        std::string mType;
        utils::NameMap<std::string> mProperties;
};


/**
 * A tile map.
 */
class Map
{
    public:
        /**
         * Constructor that takes initial map size as parameters.
         */
        Map(int width, int height,
            int tileWidth, int tileHeight);

        ~Map();

        /**
         * Sets the size of the map. This will destroy any existing map data.
         */
        void setSize(int width, int height);

        /**
         * Marks a tile as occupied
         */
        void blockTile(int x, int y, BlockType type);

        /**
         * Marks a tile as unoccupied
         */
        void freeTile(int x, int y, BlockType type);

        /**
         * Gets walkability for a tile with a blocking bitmask
         */
        bool getWalk(int x, int y, char walkmask = BLOCKMASK_WALL) const;

        /**
         * Tells if a tile location is within the map range.
         */
        bool contains(int x, int y) const
        { return x >= 0 && y >= 0 && x < mWidth && y < mHeight; }

        /**
         * Returns the width of this map.
         */
        int getWidth() const
        { return mWidth; }

        /**
         * Returns the height of this map.
         */
        int getHeight() const
        { return mHeight; }

        /**
         * Returns the tile width of this map.
         */
        int getTileWidth() const
        { return mTileWidth; }

        /**
         * Returns the tile height used by this map.
         */
        int getTileHeight() const
        { return mTileHeight; }

        /**
         * Returns a general map property defined in the map file
         */
        const std::string &getProperty(const std::string &key) const;

        /**
        * Sets a map property
        */
        void setProperty(const std::string &key, const std::string &val)
        { mProperties[key] = val; }

        /**
         * Adds an object.
         */
        void addObject(MapObject *object)
        { mMapObjects.push_back(object); }

        /**
         * Returns the objects of the map.
         */
        const std::vector<MapObject*> &getObjects() const
        { return mMapObjects; }

        /**
         * Find a path from one location to the next.
         */
        Path findPath(int startX, int startY,
                      int destX, int destY,
                      unsigned char walkmask,
                      int maxCost = 20) const;

        /**
         * Blockmasks for different entities
         */
        static const unsigned char BLOCKMASK_WALL = 0x80;     // = bin 1000 0000
        static const unsigned char BLOCKMASK_CHARACTER = 0x01;// = bin 0000 0001
        static const unsigned char BLOCKMASK_MONSTER = 0x02;  // = bin 0000 0010

    private:
        // map properties
        int mWidth, mHeight;
        int mTileWidth, mTileHeight;
        std::map<std::string, std::string> mProperties;

        std::vector<MetaTile> mMetaTiles;
        std::vector<MapObject*> mMapObjects;
};

#endif