game_base.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef ULTIMA_SHARED_EARLY_GAME_BASE_H
#define ULTIMA_SHARED_EARLY_GAME_BASE_H

#include "common/scummsys.h"
#include "common/array.h"
#include "common/serializer.h"
#include "ultima/shared/engine/events.h"
#include "ultima/shared/engine/input_handler.h"
#include "ultima/shared/engine/input_translator.h"

namespace Ultima {
namespace Shared {

class UltimaEngine;
class GameState;

namespace Gfx {
class Font;
class Popup;
class TextCursor;
class TextInput;
class VisualItem;
} // End of namespace Gfx

namespace Maps {
class Map;
} // End of namespace Maps

class GameBase : public TreeItem, public EventTarget {
private:
    int getSavegameSlot();

    void leftButtonDoubleClick(const Point &mousePos) override;
    void middleButtonDoubleClick(const Point &mousePos) override;
    void rightButtonDoubleClick(const Point &mousePos);

    bool isMouseControlEnabled() const { return true; }

    void changeView(const Common::String &name);
protected:
    uint32 _priorLeftDownTime;
    uint32 _priorMiddleDownTime;
    uint32 _priorRightDownTime;
    Gfx::VisualItem *_currentView;
    Gfx::Popup *_pendingPopup;
    InputHandler _inputHandler;
    InputTranslator _inputTranslator;
    Gfx::Font *_font;
public:
    Gfx::TextCursor *_textCursor;
    uint _videoMode;
public:
    GameBase();

    ~GameBase() override;

    void onIdle() override;

    void mouseMove(const Point &mousePos) override;
    void leftButtonDown(const Point &mousePos) override;
    void leftButtonUp(const Point &mousePos) override;
    void middleButtonDown(const Point &mousePos) override;
    void middleButtonUp(const Point &mousePos) override;
    void rightButtonDown(const Point &mousePos) override;
    void rightButtonUp(const Point &mousePos) override;
    void mouseWheel(const Point &mousePos, bool wheelUp) override;
    void keyDown(Common::KeyState keyState) override;

    virtual void starting(bool isLoading) {}

    virtual bool isVGA() const { return false; }

    void update();

    void mouseChanged();

    void setView(Gfx::VisualItem *view);

    void setView(const Common::String &viewName);

    void setPopup(Gfx::Popup *popup);

    Gfx::VisualItem *getView() const { return _currentView; }

    void setFont(Gfx::Font *font);

    Gfx::Font *getFont() const { return _font; }

    virtual Maps::Map *getMap() const { return nullptr; }

    uint getRandomNumber(uint max);

    uint getRandomNumber(uint min, uint max);

    void sleep(uint time);

    uint32 getMillis() const;

    virtual bool canLoadGameStateCurrently() { return true; }

    virtual bool canSaveGameStateCurrently() { return false; }

    virtual void synchronize(Common::Serializer &s);
};

} // End of namespace Shared
} // End of namespace Ultima

#endif