3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 #ifndef ROLLBACK_INTERFACE_HEADER
21 #define ROLLBACK_INTERFACE_HEADER
27 #include "exceptions.h"
28 #include "inventory.h"
33 class InventoryManager;
42 bool operator == (const RollbackNode &other)
44 return (name == other.name && param1 == other.param1 &&
45 param2 == other.param2 && meta == other.meta);
47 bool operator != (const RollbackNode &other) { return !(*this == other); }
50 RollbackNode(Map *map, v3s16 p, IGameDef *gamedef);
59 TYPE_MODIFY_INVENTORY_STACK,
70 std::string inventory_location;
71 std::string inventory_list;
74 ItemStack inventory_stack;
82 void setSetNode(v3s16 p_, const RollbackNode &n_old_,
83 const RollbackNode &n_new_)
91 void setModifyInventoryStack(const std::string &inventory_location_,
92 const std::string &inventory_list_, int index_,
93 bool add_, const ItemStack &inventory_stack_)
95 type = TYPE_MODIFY_INVENTORY_STACK;
96 inventory_location = inventory_location_;
97 inventory_list = inventory_list_;
98 inventory_index = index_;
100 inventory_stack = inventory_stack_;
103 // String should not contain newlines or nulls
104 std::string toString() const;
106 // Eg. flowing water level changes are not important
107 bool isImportant(IGameDef *gamedef) const;
109 bool getPosition(v3s16 *dst) const;
111 bool applyRevert(Map *map, InventoryManager *imgr, IGameDef *gamedef) const;
115 class IRollbackManager
118 virtual void reportAction(const RollbackAction &action) = 0;
119 virtual std::string getActor() = 0;
120 virtual bool isActorGuess() = 0;
121 virtual void setActor(const std::string &actor, bool is_guess) = 0;
122 virtual std::string getSuspect(v3s16 p, float nearness_shortcut,
123 float min_nearness) = 0;
125 virtual ~IRollbackManager() {};
126 virtual void flush() = 0;
127 // Get all actors that did something to position p, but not further than
128 // <seconds> in history
129 virtual std::list<RollbackAction> getNodeActors(v3s16 pos, int range,
130 time_t seconds, int limit) = 0;
131 // Get actions to revert <seconds> of history made by <actor>
132 virtual std::list<RollbackAction> getRevertActions(const std::string &actor,
137 class RollbackScopeActor
140 RollbackScopeActor(IRollbackManager * rollback_,
141 const std::string & actor, bool is_guess = false) :
145 old_actor = rollback->getActor();
146 old_actor_guess = rollback->isActorGuess();
147 rollback->setActor(actor, is_guess);
150 ~RollbackScopeActor()
153 rollback->setActor(old_actor, old_actor_guess);
158 IRollbackManager * rollback;
159 std::string old_actor;
160 bool old_actor_guess;