| 1 | /* |
|---|
| 2 | * ORXONOX - the hottest 3D action shooter ever to exist |
|---|
| 3 | * > www.orxonox.net < |
|---|
| 4 | * |
|---|
| 5 | * |
|---|
| 6 | * License notice: |
|---|
| 7 | * |
|---|
| 8 | * This program is free software; you can redistribute it and/or |
|---|
| 9 | * modify it under the terms of the GNU General Public License |
|---|
| 10 | * as published by the Free Software Foundation; either version 2 |
|---|
| 11 | * of the License, or (at your option) any later version. |
|---|
| 12 | * |
|---|
| 13 | * This program is distributed in the hope that it will be useful, |
|---|
| 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
|---|
| 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|---|
| 16 | * GNU General Public License for more details. |
|---|
| 17 | * |
|---|
| 18 | * You should have received a copy of the GNU General Public License |
|---|
| 19 | * along with this program; if not, write to the Free Software |
|---|
| 20 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
|---|
| 21 | * |
|---|
| 22 | * Author: |
|---|
| 23 | * Fabian 'x3n' Landau |
|---|
| 24 | * Co-authors: |
|---|
| 25 | * ... |
|---|
| 26 | * |
|---|
| 27 | */ |
|---|
| 28 | |
|---|
| 29 | #ifndef _GSLevelMemento_H__ |
|---|
| 30 | #define _GSLevelMemento_H__ |
|---|
| 31 | |
|---|
| 32 | #include "OrxonoxPrereqs.h" |
|---|
| 33 | |
|---|
| 34 | #include "core/class/OrxonoxInterface.h" |
|---|
| 35 | |
|---|
| 36 | namespace orxonox |
|---|
| 37 | { |
|---|
| 38 | /** |
|---|
| 39 | @brief This class is an interface for all instances that want to maintain a state beyond the reloading of a level. |
|---|
| 40 | */ |
|---|
| 41 | class _OrxonoxExport GSLevelMemento : virtual public OrxonoxInterface |
|---|
| 42 | { |
|---|
| 43 | friend class GSLevel; |
|---|
| 44 | |
|---|
| 45 | public: |
|---|
| 46 | GSLevelMemento(); // Implemented in GSLevel.cc |
|---|
| 47 | |
|---|
| 48 | protected: |
|---|
| 49 | /** |
|---|
| 50 | * Returns the state of this memento. Returns nullptr if no state needed to persist. |
|---|
| 51 | */ |
|---|
| 52 | virtual GSLevelMementoState* exportMementoState() = 0; |
|---|
| 53 | |
|---|
| 54 | /** |
|---|
| 55 | * A list of the states of all mementos. must find the correct one by itself. |
|---|
| 56 | */ |
|---|
| 57 | virtual void importMementoState(const std::vector<GSLevelMementoState*>& states) = 0; |
|---|
| 58 | }; |
|---|
| 59 | |
|---|
| 60 | /** |
|---|
| 61 | @brief Represents the state of a memento. Needs to be inherited by the actual state. |
|---|
| 62 | */ |
|---|
| 63 | struct _OrxonoxExport GSLevelMementoState |
|---|
| 64 | { |
|---|
| 65 | virtual ~GSLevelMementoState() {} // virtual destructor for RTTI |
|---|
| 66 | }; |
|---|
| 67 | } |
|---|
| 68 | |
|---|
| 69 | #endif /* _GSLevelMemento_H__ */ |
|---|
