source: code/branches/questsystem/src/orxonox/objects/QuestHint.h @ 2137

/*
 *   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:
 *      Damian 'Mozork' Frick
 *   Co-authors:
 *      ...
 *
 */
 
#ifndef _QuestHint_H__
#define _QuestHint_H__

#include <map>
#include <string>

#include "core/XMLPort.h"
#include "QuestDescription.h"
#include "QuestItem.h"

namespace questHintStatus
{

    enum Enum
    {
        inactive,
        active
    };

}

namespace orxonox
{

    class Player; //Forward declaration, remove when fully integrated into the objecthirarchy.
    class Quest; //To avoid circual includes.

    /**
    @brief
        Represents a hint in the game towards completing a Quest.
        Consists of title and description in textual form and must belong to a quest.
        A QuestHit has a defined status (inactive or active, where inactive is default) for each player, which means each QuestHint exists only once for all players, it doesn't belong to a player, it just has different stati for each of them.
    @author
        Damian 'Mozork' Frick
    */
    class QuestHint : public QuestItem
    {
    
        public:
            QuestHint();
            ~QuestHint();
            
            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
            
            bool isActive(Player* player); //!< Returns true if the hint is active for the input player.
            
            bool activate(Player* player); //!< Activates the hint for the input player.
            
            bool setQuest(Quest* quest); //!< Sets the quest the hint belongs to.
            
            inline Quest* getQuest(void)
               { return this->quest_; }
            
        private:
            
            void initialize(void);
            
            Quest* quest_; //!< The quest the hint belongs to.
            std::map<Player*, questHintStatus::Enum> playerStatus_; //!< List of the status for each player, with the Player-pointer as key.
    
    };

}

#endif /* _QuestHint_H__ */