source: code/trunk/src/modules/questsystem/QuestEffect.h @ 9870

/*
 *   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:
 *      ...
 *
 */

/**
    @file QuestEffect.h
    @brief Definition of the QuestEffect class.
    @ingroup Questsystem
*/

#ifndef _QuestEffect_H__
#define _QuestEffect_H__

#include "questsystem/QuestsystemPrereqs.h"

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

namespace orxonox
{

    /**
    @brief
        Handles QuestEffects for @ref orxonox::Quest "Quests".
        QuestEffects are one of the ways for @ref orxonox::Quest "Quests" to have any side effects on the game world and for the game world to influence the @ref orxonox::Quest "Quests".

    @author
        Damian 'Mozork' Frick

    @ingroup Questsystem
    */
    class _QuestsystemExport QuestEffect : public BaseObject
    {
        public:
            QuestEffect(Context* context);
            virtual ~QuestEffect();

            virtual bool invoke(PlayerInfo* player) = 0; //!< Invokes the QuestEffect.
            static bool invokeEffects(PlayerInfo* player, std::list<QuestEffect*> & effects); //!< Invokes all QuestEffects in the list.

    };

}

#endif /* _QuestEffect_H__ */