worldtrigger.h

// © Copyright 2010 - 2016 BlackTopp Studios Inc.
/* This file is part of The Mezzanine Engine.

    The Mezzanine Engine 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 3 of the License, or
    (at your option) any later version.

    The Mezzanine Engine 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 The Mezzanine Engine.  If not, see <http://www.gnu.org/licenses/>.
*/
/* The original authors have included a copy of the license specified above in the
   'Docs' folder. See 'gpl.txt'
*/
/* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
   Build professional software and charge for their product.

   However there are some practical restrictions, so if your project involves
   any of the following you should contact us and we will try to work something
   out:
    - DRM or Copy Protection of any kind(except Copyrights)
    - Software Patents You Do Not Wish to Freely License
    - Any Kind of Linking to Non-GPL licensed Works
    - Are Currently In Violation of Another Copyright Holder's GPL License
    - If You want to change our code and not add a few hundred MB of stuff to
        your distribution

   These and other limitations could cause serious legal problems if you ignore
   them, so it is best to simply contact us or the Free Software Foundation, if
   you have any questions.

   Joseph Toppi - toppij@gmail.com
   John Blackwood - makoenergy02@gmail.com
*/
#ifndef _worldtrigger_h
#define _worldtrigger_h

#include "datatypes.h"

namespace Mezzanine
{
    ///////////////////////////////////////////////////////////////////////////////
    /// @class WorldTrigger
    /// @headerfile worldtrigger.h
    /// @brief This is an abstract class for creating in-game triggers.
    /// @details
    ///////////////////////////////////////
    class MEZZ_LIB WorldTrigger
    {
        protected:
            String Name;
        public:
            /// @brief Class constructor.
            /// @param name The unique name to be given to this trigger.
            WorldTrigger(const String& name);
            /// @brief Class destructor.
            virtual ~WorldTrigger();
            /// @brief Gets the name of this trigger.
            /// @return Returns a string containing the name of this trigger.
            virtual String GetName();
            /// @brief Checks for the condition for the trigger.
            /// @return Returns a Boole indicating whether or not the condition(s) has been met.
            virtual Boole ConditionsAreMet() = 0;
            /// @brief Applies the effects of this trigger.
            virtual void ApplyTrigger() = 0;
    };//trigger
}//Mezzanine

#endif