source: code/branches/questsystem/src/orxonox/objects/AddQuestHint.h @ 2259

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

#include <string>

#include "QuestEffect.h"

namespace orxonox {

    class Player; //Forward declaration, remove when fully integrated into the objecthirarchy.

    /**
    @brief
        Adds a QuestHint, resp. Activates the QuestHint.
    @author
        Damian 'Mozork' Frick
    */
    class AddQuestHint : public QuestEffect
    {
        public:
            AddQuestHint();
            ~AddQuestHint();
            
            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
            
            virtual bool invoke(Player* player); //!< Invokes the effect.
            
        private:
            std::string hintId_;
            
            inline const std::string & getHintId(void) const
                { return this->hintId_; }
            void setHintId(const std::string & id);
    
    };

}

#endif /* _AddQuestHint_H__ */