MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
worldtrigger.h
1 // © Copyright 2010 - 2014 BlackTopp Studios Inc.
2 /* This file is part of The Mezzanine Engine.
3 
4  The Mezzanine Engine is free software: you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation, either version 3 of the License, or
7  (at your option) any later version.
8 
9  The Mezzanine Engine is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with The Mezzanine Engine. If not, see <http://www.gnu.org/licenses/>.
16 */
17 /* The original authors have included a copy of the license specified above in the
18  'Docs' folder. See 'gpl.txt'
19 */
20 /* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
21  Build professional software and charge for their product.
22 
23  However there are some practical restrictions, so if your project involves
24  any of the following you should contact us and we will try to work something
25  out:
26  - DRM or Copy Protection of any kind(except Copyrights)
27  - Software Patents You Do Not Wish to Freely License
28  - Any Kind of Linking to Non-GPL licensed Works
29  - Are Currently In Violation of Another Copyright Holder's GPL License
30  - If You want to change our code and not add a few hundred MB of stuff to
31  your distribution
32 
33  These and other limitations could cause serious legal problems if you ignore
34  them, so it is best to simply contact us or the Free Software Foundation, if
35  you have any questions.
36 
37  Joseph Toppi - toppij@gmail.com
38  John Blackwood - makoenergy02@gmail.com
39 */
40 #ifndef _worldtrigger_h
41 #define _worldtrigger_h
42 
43 #include "datatypes.h"
44 
45 namespace Mezzanine
46 {
47  ///////////////////////////////////////////////////////////////////////////////
48  /// @class WorldTrigger
49  /// @headerfile worldtrigger.h
50  /// @brief This is an abstract class for creating in-game triggers.
51  /// @details
52  ///////////////////////////////////////
54  {
55  protected:
56  String Name;
57  public:
58  /// @brief Class constructor.
59  /// @param name The unique name to be given to this trigger.
60  WorldTrigger(const String& name);
61  /// @brief Class destructor.
62  virtual ~WorldTrigger();
63  /// @brief Gets the name of this trigger.
64  /// @return Returns a string containing the name of this trigger.
65  virtual String GetName();
66  /// @brief Checks for the condition for the trigger.
67  /// @return Returns a bool indicating whether or not the condition(s) has been met.
68  virtual bool ConditionsAreMet() = 0;
69  /// @brief Applies the effects of this trigger.
70  virtual void ApplyTrigger() = 0;
71  };//trigger
72 }//Mezzanine
73 
74 #endif