4 * This file is part of OpenTTD.
5 * OpenTTD 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, version 2.
6 * OpenTTD 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.
7 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
10 /** @file order_backup.cpp Handling of order backups. */
13 #include "command_func.h"
14 #include "core/pool_func.hpp"
15 #include "network/network.h"
16 #include "network/network_func.h"
17 #include "order_backup.h"
18 #include "vehicle_base.h"
19 #include "window_func.h"
20 #include "station_map.h"
22 #include "safeguards.h"
24 OrderBackupPool
_order_backup_pool("BackupOrder");
25 INSTANTIATE_POOL_METHODS(OrderBackup
)
27 /** Free everything that is allocated. */
28 OrderBackup::~OrderBackup()
30 if (CleaningPool()) return;
32 Order
*o
= this->orders
;
34 Order
*next
= o
->next
;
41 * Create an order backup for the given vehicle.
42 * @param v The vehicle to make a backup of.
43 * @param user The user that is requesting the backup.
45 OrderBackup::OrderBackup(const Vehicle
*v
, uint32 user
)
49 this->group
= v
->group_id
;
51 this->CopyConsistPropertiesFrom(v
);
53 /* If we have shared orders, store the vehicle we share the order with. */
54 if (v
->IsOrderListShared()) {
55 this->clone
= (v
->FirstShared() == v
) ? v
->NextShared() : v
->FirstShared();
57 /* Else copy the orders */
58 Order
**tail
= &this->orders
;
60 /* Count the number of orders */
62 FOR_VEHICLE_ORDERS(v
, order
) {
63 Order
*copy
= new Order();
64 copy
->AssignOrder(*order
);
72 * Restore the data of this order to the given vehicle.
73 * @param v The vehicle to restore to.
75 void OrderBackup::DoRestore(Vehicle
*v
)
77 /* If we had shared orders, recover that */
78 if (this->clone
!= NULL
) {
79 DoCommand(0, v
->index
| CO_SHARE
<< 30, this->clone
->index
, DC_EXEC
, CMD_CLONE_ORDER
);
80 } else if (this->orders
!= NULL
&& OrderList::CanAllocateItem()) {
81 v
->orders
.list
= new OrderList(this->orders
, v
);
83 /* Make sure buoys/oil rigs are updated in the station list. */
84 InvalidateWindowClassesData(WC_STATION_LIST
, 0);
87 v
->CopyConsistPropertiesFrom(this);
89 /* Make sure orders are in range */
90 v
->UpdateRealOrderIndex();
91 if (v
->cur_implicit_order_index
>= v
->GetNumOrders()) v
->cur_implicit_order_index
= v
->cur_real_order_index
;
93 /* Restore vehicle group */
94 DoCommand(0, this->group
, v
->index
, DC_EXEC
, CMD_ADD_VEHICLE_GROUP
);
98 * Create an order backup for the given vehicle.
99 * @param v The vehicle to make a backup of.
100 * @param user The user that is requesting the backup.
101 * @note Will automatically remove any previous backups of this user.
103 /* static */ void OrderBackup::Backup(const Vehicle
*v
, uint32 user
)
105 /* Don't use reset as that broadcasts over the network to reset the variable,
106 * which is what we are doing at the moment. */
108 FOR_ALL_ORDER_BACKUPS(ob
) {
109 if (ob
->user
== user
) delete ob
;
111 if (OrderBackup::CanAllocateItem()) {
112 new OrderBackup(v
, user
);
117 * Restore the data of this order to the given vehicle.
118 * @param v The vehicle to restore to.
119 * @param user The user that built the vehicle, thus wants to restore.
120 * @note After restoration the backup will automatically be removed.
122 /* static */ void OrderBackup::Restore(Vehicle
*v
, uint32 user
)
125 FOR_ALL_ORDER_BACKUPS(ob
) {
126 if (v
->tile
!= ob
->tile
|| ob
->user
!= user
) continue;
134 * Reset an OrderBackup given a tile and user.
135 * @param tile The tile associated with the OrderBackup.
136 * @param user The user associated with the OrderBackup.
137 * @note Must not be used from the GUI!
139 /* static */ void OrderBackup::ResetOfUser(TileIndex tile
, uint32 user
)
142 FOR_ALL_ORDER_BACKUPS(ob
) {
143 if (ob
->user
== user
&& (ob
->tile
== tile
|| tile
== INVALID_TILE
)) delete ob
;
148 * Clear an OrderBackup
149 * @param tile Tile related to the to-be-cleared OrderBackup.
150 * @param flags For command.
152 * @param p2 User that had the OrderBackup.
153 * @param text Unused.
154 * @return The cost of this operation or an error.
156 CommandCost
CmdClearOrderBackup(TileIndex tile
, DoCommandFlag flags
, uint32 p1
, uint32 p2
, const char *text
)
158 /* No need to check anything. If the tile or user don't exist we just ignore it. */
159 if (flags
& DC_EXEC
) OrderBackup::ResetOfUser(tile
== 0 ? INVALID_TILE
: tile
, p2
);
161 return CommandCost();
165 * Reset an user's OrderBackup if needed.
166 * @param user The user associated with the OrderBackup.
167 * @pre _network_server.
168 * @note Must not be used from a command.
170 /* static */ void OrderBackup::ResetUser(uint32 user
)
172 assert(_network_server
);
175 FOR_ALL_ORDER_BACKUPS(ob
) {
176 /* If it's not an backup of us, so ignore it. */
177 if (ob
->user
!= user
) continue;
179 DoCommandP(0, 0, user
, CMD_CLEAR_ORDER_BACKUP
);
185 * Reset the OrderBackups from GUI/game logic.
186 * @param t The tile of the order backup.
187 * @param from_gui Whether the call came from the GUI, i.e. whether
188 * it must be synced over the network.
190 /* static */ void OrderBackup::Reset(TileIndex t
, bool from_gui
)
192 /* The user has CLIENT_ID_SERVER as default when network play is not active,
193 * but compiled it. A network client has its own variable for the unique
194 * client/user identifier. Finally if networking isn't compiled in the
195 * default is just plain and simple: 0. */
196 #ifdef ENABLE_NETWORK
197 uint32 user
= _networking
&& !_network_server
? _network_own_client_id
: CLIENT_ID_SERVER
;
203 FOR_ALL_ORDER_BACKUPS(ob
) {
204 /* If it's not an backup of us, so ignore it. */
205 if (ob
->user
!= user
) continue;
206 /* If it's not for our chosen tile either, ignore it. */
207 if (t
!= INVALID_TILE
&& t
!= ob
->tile
) continue;
210 /* We need to circumvent the "prevention" from this command being executed
211 * while the game is paused, so use the internal method. Nor do we want
212 * this command to get its cost estimated when shift is pressed. */
213 DoCommandPInternal(ob
->tile
, 0, user
, CMD_CLEAR_ORDER_BACKUP
, NULL
, NULL
, true, false);
215 /* The command came from the game logic, i.e. the clearing of a tile.
216 * In that case we have no need to actually sync this, just do it. */
223 * Clear the group of all backups having this group ID.
224 * @param group The group to clear.
226 /* static */ void OrderBackup::ClearGroup(GroupID group
)
229 FOR_ALL_ORDER_BACKUPS(ob
) {
230 if (ob
->group
== group
) ob
->group
= DEFAULT_GROUP
;
235 * Clear/update the (clone) vehicle from an order backup.
236 * @param v The vehicle to clear.
238 * @note If it is not possible to set another vehicle as clone
239 * "example", then this backed up order will be removed.
241 /* static */ void OrderBackup::ClearVehicle(const Vehicle
*v
)
245 FOR_ALL_ORDER_BACKUPS(ob
) {
246 if (ob
->clone
== v
) {
247 /* Get another item in the shared list. */
248 ob
->clone
= (v
->FirstShared() == v
) ? v
->NextShared() : v
->FirstShared();
249 /* But if that isn't there, remove it. */
250 if (ob
->clone
== NULL
) delete ob
;
256 * Removes an order from all vehicles. Triggers when, say, a station is removed.
257 * @param type The type of the order (OT_GOTO_[STATION|DEPOT|WAYPOINT]).
258 * @param destination The destination. Can be a StationID, DepotID or WaypointID.
260 /* static */ void OrderBackup::RemoveOrder(OrderType type
, DestinationID destination
)
263 FOR_ALL_ORDER_BACKUPS(ob
) {
264 for (Order
*order
= ob
->orders
; order
!= NULL
; order
= order
->next
) {
265 OrderType ot
= order
->GetType();
266 if (ot
== OT_GOTO_DEPOT
&& (order
->GetDepotActionType() & ODATFB_NEAREST_DEPOT
) != 0) continue;
267 if (ot
== OT_IMPLICIT
|| (IsHangarTile(ob
->tile
) && ot
== OT_GOTO_DEPOT
)) ot
= OT_GOTO_STATION
;
268 if (ot
== type
&& order
->GetDestination() == destination
) {
269 /* Remove the order backup! If a station/depot gets removed, we can't/shouldn't restore those broken orders. */