source: code/trunk/src/orxonox/gametypes/Gametype.h @ 11071

/*
 *   ORXONOX - the hottest 3D action shooter ever to exist
 *                    > www.orxonox.net <
 *
 *
 *   License notice:
 *
 *   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.
 *
 *   Author:
 *      Fabian 'x3n' Landau
 *   Co-authors:
 *      ...
 *
 */

#ifndef _Gametype_H__
#define _Gametype_H__

#include "OrxonoxPrereqs.h"

#include <map>
#include <set>
#include <string>

#include "core/BaseObject.h"
#include "core/class/SubclassIdentifier.h"
#include "tools/interfaces/Tickable.h"
#include "infos/GametypeInfo.h"
#include "tools/Timer.h"
#include "gamestates/GSLevelMemento.h"

namespace orxonox
{
    enum class PlayerState
    {
        Uninitialized,
        Joined,
        Alive,
        Dead
    };

    struct Player
    {
        PlayerInfo* info_;
        PlayerState state_;
        int frags_;
        int killed_;
    };

    class _OrxonoxExport Gametype : public BaseObject, public Tickable, public GSLevelMemento
    {
        friend class PlayerInfo;

        public:
            Gametype(Context* context);
            virtual ~Gametype();

            virtual void init();

            void setConfigValues();

            virtual void tick(float dt) override;

            inline const GametypeInfo* getGametypeInfo() const
                { return this->gtinfo_; }

            inline bool hasStarted() const
                { return this->gtinfo_->hasStarted(); }
            inline bool hasEnded() const
                { return this->gtinfo_->hasEnded(); }

            virtual void start();
            virtual void end();
            virtual void playerEntered(PlayerInfo* player);
            virtual bool playerLeft(PlayerInfo* player);
            virtual void playerSwitched(PlayerInfo* player, Gametype* newgametype);
            virtual void playerSwitchedBack(PlayerInfo* player, Gametype* oldgametype);
            virtual bool playerChangedName(PlayerInfo* player);

            virtual void playerScored(PlayerInfo* player, int score = 1);

            virtual bool allowPawnHit(Pawn* victim, Pawn* originator = nullptr);
            virtual bool allowPawnDamage(Pawn* victim, Pawn* originator = nullptr);
            virtual bool allowPawnDeath(Pawn* victim, Pawn* originator = nullptr);

            virtual void pawnKilled(Pawn* victim, Pawn* killer = nullptr);
            virtual void pawnPreSpawn(Pawn* pawn);
            virtual void pawnPostSpawn(Pawn* pawn);
            virtual void playerPreSpawn(PlayerInfo* player);
            virtual void playerPostSpawn(PlayerInfo* player);

            virtual void playerStartsControllingPawn(PlayerInfo* player, Pawn* pawn);
            virtual void playerStopsControllingPawn(PlayerInfo* player, Pawn* pawn);

            inline const std::map<PlayerInfo*, Player>& getPlayers() const
                { return this->players_; }

            int getScore(PlayerInfo* player) const;

            inline void registerSpawnPoint(SpawnPoint* spawnpoint)
                { this->spawnpoints_.insert(spawnpoint); }

            inline bool isStartCountdownRunning() const
                { return this->gtinfo_->isStartCountdownRunning(); }
            inline float getStartCountdown() const
                { return this->gtinfo_->getStartCountdown(); }

            inline void setHUDTemplate(const std::string& name)
                { this->gtinfo_->setHUDTemplate(name); }
            inline const std::string& getHUDTemplate() const
                { return this->gtinfo_->getHUDTemplate(); }

            virtual void addBots(unsigned int amount);
            void killBots(unsigned int amount = 0);

            virtual void addTime(float t);
            virtual void removeTime(float t);

            inline  void startTimer()
            {
                this->time_ = this->timeLimit_;
                this->timerIsActive_ = true;
            }

            inline void stopTimer()
              { this->timerIsActive_ = false; }

            inline float getTime()
              { return this->time_; }

            inline bool getTimerIsActive()
              { return timerIsActive_; }

            inline void setTimeLimit(float t)
              { this->timeLimit_ = t; }

            //inline bool getForceSpawn()
            //  { return this->bForceSpawn_; }

            virtual void resetTimer();
            virtual void resetTimer(float t);

            /**
            @brief Get number of Players in game.
            */
            inline unsigned int getNumberOfPlayers() const
                { return this->players_.size(); }
            void showMenu();


        protected:
            virtual SpawnPoint* getBestSpawnPoint(PlayerInfo* player) const;

            virtual void assignDefaultPawnsIfNeeded();
            virtual void checkStart();
            virtual void spawnPlayer(PlayerInfo* player);
            virtual void spawnPlayerAsDefaultPawn(PlayerInfo* player);
            virtual void spawnPlayersIfRequested();
            virtual void spawnDeadPlayersIfRequested();

            virtual GSLevelMementoState* exportMementoState() override;
            virtual void importMementoState(const std::vector<GSLevelMementoState*>& states) override;

            WeakPtr<GametypeInfo> gtinfo_;

            bool bAutoStart_;
            bool bForceSpawn_;
            bool bAutoEnd_;

            float time_;
            float timeLimit_;
            bool timerIsActive_;

            float initialStartCountdown_;
            unsigned int numberOfBots_;
            SubclassIdentifier<Bot> botclass_;

            std::map<PlayerInfo*, Player> players_;
            std::set<SpawnPoint*> spawnpoints_;
            SubclassIdentifier<ControllableEntity> defaultControllableEntity_;

            OverlayGroup* scoreboard_;

            // Config Values
            std::string scoreboardTemplate_;

            Timer showMenuTimer_;
    };

    /**
        @brief Keeps position and orientation of the camera, as well as the name of current scene.
    */
    struct _OrxonoxExport GametypeMementoState : public GSLevelMementoState
    {
        Vector3 cameraPosition_;
        Quaternion cameraOrientation_;
        std::string sceneName_;
    };
}

#endif /* _Gametype_H__ */