QuestEffectBeacon.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 _QuestEffectBeacon_H__
#define _QuestEffectBeacon_H__

#include "questsystem/QuestsystemPrereqs.h"

#include <list>
#include "worldentities/StaticEntity.h"

namespace orxonox
{

    enum class QuestEffectBeaconStatus
    {
        Inactive, 
        Active 
    };

    class _QuestsystemExport QuestEffectBeacon : public StaticEntity
    {
        public:
            QuestEffectBeacon(Context* context);
            virtual ~QuestEffectBeacon();

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

            bool execute(bool bTriggered, BaseObject* trigger); 

            inline bool isActive(void)
            { return this->status_ == QuestEffectBeaconStatus::Active; }

            bool setActive(bool activate); 

        protected:
            bool decrementTimes(void); 

            inline const int & getTimes(void) const
                { return this->times_; }

        private:
            static const int INFINITE_TIME = -1; 

            std::list<QuestEffect*> effects_; 
            int times_; 
            QuestEffectBeaconStatus status_; 

            bool setTimes(const int & n); 
            bool addEffect(QuestEffect* effect); 

            const QuestEffect* getEffect(unsigned int index) const; 

    };

}

#endif /* _QuestEffectBeacon_H__ */