QuestDescription.h

Go to the documentation of this file.

/*
 *   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 _QuestDescription_H__
#define _QuestDescription_H__

#include "questsystem/QuestsystemPrereqs.h"

#include <string>
#include "core/BaseObject.h"

// tolua_begin
namespace orxonox
{

    class _QuestsystemExport QuestDescription : public BaseObject
    {
// tolua_end
        public:
            QuestDescription(Context* context);
            virtual ~QuestDescription();

            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode) override; 

// tolua_begin
            inline const std::string & getTitle(void) const
                { return this->title_; }

            inline const std::string & getDescription(void) const
                { return this->description_; }
// tolua_end

            inline const std::string & getFailMessage(void)
                { return this->failMessage_; }

            inline const std::string & getCompleteMessage(void)
                { return this->completeMessage_; }

            inline bool sendAddHintNotification(PlayerInfo* player)
                { return notificationHelper("hint", "", player); }

            inline bool sendAddQuestNotification(PlayerInfo* player)
                { return notificationHelper("quest", "start", player); }

            inline bool sendFailQuestNotification(PlayerInfo* player)
                { return notificationHelper("quest", "fail", player); }

            inline bool sendCompleteQuestNotification(PlayerInfo* player)
                { return notificationHelper("quest", "complete", player); }

        private:
            static const std::string SENDER;

            std::string title_; 
            std::string description_; 
            std::string failMessage_; 
            std::string completeMessage_; 

            bool notificationHelper(const std::string & item, const std::string & status, PlayerInfo* player); 

            inline void setTitle(const std::string & title)
                { this->title_ = title; }

            inline void setDescription(const std::string & description)
                { this->description_ = description; }

            inline void setFailMessage(const std::string & message)
                { this->failMessage_ = message; }

            inline void setCompleteMessage(const std::string & message)
                { this->completeMessage_ = message; }

    }; // tolua_export

} // tolua_export

#endif /* _QuestDescription_H__ */