OpenTTD

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

vehicle_cmd.cpp
Go to the documentation of this file.
1 /* $Id: vehicle_cmd.cpp 27677 2016-11-05 19:16:59Z frosch $ */
2
3 /*
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/>.
8 */
9
12 #include "stdafx.h"
13 #include "roadveh.h"
14 #include "news_func.h"
15 #include "airport.h"
16 #include "cmd_helper.h"
17 #include "command_func.h"
18 #include "company_func.h"
19 #include "train.h"
20 #include "aircraft.h"
21 #include "newgrf_text.h"
22 #include "vehicle_func.h"
23 #include "string_func.h"
24 #include "depot_map.h"
25 #include "vehiclelist.h"
26 #include "engine_func.h"
27 #include "articulated_vehicles.h"
28 #include "autoreplace_gui.h"
29 #include "group.h"
30 #include "order_backup.h"
31 #include "ship.h"
32 #include "newgrf.h"
33 #include "company_base.h"
34
35 #include "table/strings.h"
36
37 #include "safeguards.h"
38
39 /* Tables used in vehicle.h to find the right command for a certain vehicle type */
40 const uint32 _veh_build_proc_table[] = {
41 CMD_BUILD_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_BUY_TRAIN),
42 CMD_BUILD_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_BUY_ROAD_VEHICLE),
43 CMD_BUILD_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_BUY_SHIP),
44 CMD_BUILD_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_BUY_AIRCRAFT),
45 };
46
47 const uint32 _veh_sell_proc_table[] = {
48 CMD_SELL_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_SELL_TRAIN),
49 CMD_SELL_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_SELL_ROAD_VEHICLE),
50 CMD_SELL_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_SELL_SHIP),
51 CMD_SELL_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_SELL_AIRCRAFT),
52 };
53
54 const uint32 _veh_refit_proc_table[] = {
55 CMD_REFIT_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_REFIT_TRAIN),
56 CMD_REFIT_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_REFIT_ROAD_VEHICLE),
57 CMD_REFIT_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_REFIT_SHIP),
58 CMD_REFIT_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_REFIT_AIRCRAFT),
59 };
60
61 const uint32 _send_to_depot_proc_table[] = {
62 CMD_SEND_VEHICLE_TO_DEPOT | CMD_MSG(STR_ERROR_CAN_T_SEND_TRAIN_TO_DEPOT),
63 CMD_SEND_VEHICLE_TO_DEPOT | CMD_MSG(STR_ERROR_CAN_T_SEND_ROAD_VEHICLE_TO_DEPOT),
64 CMD_SEND_VEHICLE_TO_DEPOT | CMD_MSG(STR_ERROR_CAN_T_SEND_SHIP_TO_DEPOT),
65 CMD_SEND_VEHICLE_TO_DEPOT | CMD_MSG(STR_ERROR_CAN_T_SEND_AIRCRAFT_TO_HANGAR),
66 };
67
68
69 CommandCost CmdBuildRailVehicle(TileIndex tile, DoCommandFlag flags, const Engine *e, uint16 data, Vehicle **v);
70 CommandCost CmdBuildRoadVehicle(TileIndex tile, DoCommandFlag flags, const Engine *e, uint16 data, Vehicle **v);
71 CommandCost CmdBuildShip (TileIndex tile, DoCommandFlag flags, const Engine *e, uint16 data, Vehicle **v);
72 CommandCost CmdBuildAircraft (TileIndex tile, DoCommandFlag flags, const Engine *e, uint16 data, Vehicle **v);
73
85 CommandCost CmdBuildVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
86 {
87 /* Elementary check for valid location. */
88 if (!IsDepotTile(tile) || !IsTileOwner(tile, _current_company)) return CMD_ERROR;
89
90 VehicleType type = GetDepotVehicleType(tile);
91
92 /* Validate the engine type. */
93 EngineID eid = GB(p1, 0, 16);
94 if (!IsEngineBuildable(eid, type, _current_company)) return_cmd_error(STR_ERROR_RAIL_VEHICLE_NOT_AVAILABLE + type);
95
96 const Engine *e = Engine::Get(eid);
97 CommandCost value(EXPENSES_NEW_VEHICLES, e->GetCost());
98
99 /* Engines without valid cargo should not be available */
100 if (e->GetDefaultCargoType() == CT_INVALID) return CMD_ERROR;
101
102 /* Check whether the number of vehicles we need to build can be built according to pool space. */
103 uint num_vehicles;
104 switch (type) {
105 case VEH_TRAIN: num_vehicles = (e->u.rail.railveh_type == RAILVEH_MULTIHEAD ? 2 : 1) + CountArticulatedParts(eid, false); break;
106 case VEH_ROAD: num_vehicles = 1 + CountArticulatedParts(eid, false); break;
107 case VEH_SHIP: num_vehicles = 1; break;
108 case VEH_AIRCRAFT: num_vehicles = e->u.air.subtype & AIR_CTOL ? 2 : 3; break;
109 default: NOT_REACHED(); // Safe due to IsDepotTile()
110 }
111 if (!Vehicle::CanAllocateItem(num_vehicles)) return_cmd_error(STR_ERROR_TOO_MANY_VEHICLES_IN_GAME);
112
113 /* Check whether we can allocate a unit number. Autoreplace does not allocate
114 * an unit number as it will (always) reuse the one of the replaced vehicle
115 * and (train) wagons don't have an unit number in any scenario. */
116 UnitID unit_num = (flags & DC_AUTOREPLACE || (type == VEH_TRAIN && e->u.rail.railveh_type == RAILVEH_WAGON)) ? 0 : GetFreeUnitNumber(type);
117 if (unit_num == UINT16_MAX) return_cmd_error(STR_ERROR_TOO_MANY_VEHICLES_IN_GAME);
118
119 Vehicle *v;
120 switch (type) {
121 case VEH_TRAIN: value.AddCost(CmdBuildRailVehicle(tile, flags, e, GB(p1, 16, 16), &v)); break;
122 case VEH_ROAD: value.AddCost(CmdBuildRoadVehicle(tile, flags, e, GB(p1, 16, 16), &v)); break;
123 case VEH_SHIP: value.AddCost(CmdBuildShip (tile, flags, e, GB(p1, 16, 16), &v)); break;
124 case VEH_AIRCRAFT: value.AddCost(CmdBuildAircraft (tile, flags, e, GB(p1, 16, 16), &v)); break;
125 default: NOT_REACHED(); // Safe due to IsDepotTile()
126 }
127
128 if (value.Succeeded() && flags & DC_EXEC) {
129 v->unitnumber = unit_num;
130 v->value = value.GetCost();
131
132 InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);
133 InvalidateWindowClassesData(GetWindowClassForVehicleType(type), 0);
134 SetWindowDirty(WC_COMPANY, _current_company);
135 if (IsLocalCompany()) {
136 InvalidateAutoreplaceWindow(v->engine_type, v->group_id); // updates the auto replace window (must be called before incrementing num_engines)
137 }
138
139 GroupStatistics::CountEngine(v, 1);
140 GroupStatistics::UpdateAutoreplace(_current_company);
141
142 if (v->IsPrimaryVehicle()) {
143 GroupStatistics::CountVehicle(v, 1);
144 OrderBackup::Restore(v, p2);
145 }
146 }
147
148 return value;
149 }
150
151 CommandCost CmdSellRailWagon(DoCommandFlag flags, Vehicle *v, uint16 data, uint32 user);
152
165 CommandCost CmdSellVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
166 {
167 Vehicle *v = Vehicle::GetIfValid(GB(p1, 0, 20));
168 if (v == NULL) return CMD_ERROR;
169
170 Vehicle *front = v->First();
171
172 CommandCost ret = CheckOwnership(front->owner);
173 if (ret.Failed()) return ret;
174
175 if (front->vehstatus & VS_CRASHED) return_cmd_error(STR_ERROR_VEHICLE_IS_DESTROYED);
176
177 if (!front->IsStoppedInDepot()) return_cmd_error(STR_ERROR_TRAIN_MUST_BE_STOPPED_INSIDE_DEPOT + front->type);
178
179 /* Can we actually make the order backup, i.e. are there enough orders? */
180 if (p1 & MAKE_ORDER_BACKUP_FLAG &&
181 front->orders.list != NULL &&
182 !front->orders.list->IsShared() &&
183 !Order::CanAllocateItem(front->orders.list->GetNumOrders())) {
184 /* Only happens in exceptional cases when there aren't enough orders anyhow.
185 * Thus it should be safe to just drop the orders in that case. */
186 p1 &= ~MAKE_ORDER_BACKUP_FLAG;
187 }
188
189 if (v->type == VEH_TRAIN) {
190 ret = CmdSellRailWagon(flags, v, GB(p1, 20, 12), p2);
191 } else {
192 ret = CommandCost(EXPENSES_NEW_VEHICLES, -front->value);
193
194 if (flags & DC_EXEC) {
195 if (front->IsPrimaryVehicle() && p1 & MAKE_ORDER_BACKUP_FLAG) OrderBackup::Backup(front, p2);
196 delete front;
197 }
198 }
199
200 return ret;
201 }
202
212 static int GetRefitCostFactor(const Vehicle *v, EngineID engine_type, CargoID new_cid, byte new_subtype, bool *auto_refit_allowed)
213 {
214 /* Prepare callback param with info about the new cargo type. */
215 const Engine *e = Engine::Get(engine_type);
216
217 /* Is this vehicle a NewGRF vehicle? */
218 if (e->GetGRF() != NULL) {
219 const CargoSpec *cs = CargoSpec::Get(new_cid);
220 uint32 param1 = (cs->classes << 16) | (new_subtype << 8) | e->GetGRF()->cargo_map[new_cid];
221
222 uint16 cb_res = GetVehicleCallback(CBID_VEHICLE_REFIT_COST, param1, 0, engine_type, v);
223 if (cb_res != CALLBACK_FAILED) {
224 *auto_refit_allowed = HasBit(cb_res, 14);
225 int factor = GB(cb_res, 0, 14);
226 if (factor >= 0x2000) factor -= 0x4000; // Treat as signed integer.
227 return factor;
228 }
229 }
230
231 *auto_refit_allowed = e->info.refit_cost == 0;
232 return (v == NULL || v->cargo_type != new_cid) ? e->info.refit_cost : 0;
233 }
234
244 static CommandCost GetRefitCost(const Vehicle *v, EngineID engine_type, CargoID new_cid, byte new_subtype, bool *auto_refit_allowed)
245 {
246 ExpensesType expense_type;
247 const Engine *e = Engine::Get(engine_type);
248 Price base_price;
249 int cost_factor = GetRefitCostFactor(v, engine_type, new_cid, new_subtype, auto_refit_allowed);
250 switch (e->type) {
251 case VEH_SHIP:
252 base_price = PR_BUILD_VEHICLE_SHIP;
253 expense_type = EXPENSES_SHIP_RUN;
254 break;
255
256 case VEH_ROAD:
257 base_price = PR_BUILD_VEHICLE_ROAD;
258 expense_type = EXPENSES_ROADVEH_RUN;
259 break;
260
261 case VEH_AIRCRAFT:
262 base_price = PR_BUILD_VEHICLE_AIRCRAFT;
263 expense_type = EXPENSES_AIRCRAFT_RUN;
264 break;
265
266 case VEH_TRAIN:
267 base_price = (e->u.rail.railveh_type == RAILVEH_WAGON) ? PR_BUILD_VEHICLE_WAGON : PR_BUILD_VEHICLE_TRAIN;
268 cost_factor <<= 1;
269 expense_type = EXPENSES_TRAIN_RUN;
270 break;
271
272 default: NOT_REACHED();
273 }
274 if (cost_factor < 0) {
275 return CommandCost(expense_type, -GetPrice(base_price, -cost_factor, e->GetGRF(), -10));
276 } else {
277 return CommandCost(expense_type, GetPrice(base_price, cost_factor, e->GetGRF(), -10));
278 }
279 }
280
282 struct RefitResult {
283 Vehicle *v;
284 uint capacity;
285 uint mail_capacity;
286 byte subtype;
287 };
288
301 static CommandCost RefitVehicle(Vehicle *v, bool only_this, uint8 num_vehicles, CargoID new_cid, byte new_subtype, DoCommandFlag flags, bool auto_refit)
302 {
303 CommandCost cost(v->GetExpenseType(false));
304 uint total_capacity = 0;
305 uint total_mail_capacity = 0;
306 num_vehicles = num_vehicles == 0 ? UINT8_MAX : num_vehicles;
307
308 VehicleSet vehicles_to_refit;
309 if (!only_this) {
310 GetVehicleSet(vehicles_to_refit, v, num_vehicles);
311 /* In this case, we need to check the whole chain. */
312 v = v->First();
313 }
314
315 static SmallVector<RefitResult, 16> refit_result;
316 refit_result.Clear();
317
318 v->InvalidateNewGRFCacheOfChain();
319 byte actual_subtype = new_subtype;
320 for (; v != NULL; v = (only_this ? NULL : v->Next())) {
321 /* Reset actual_subtype for every new vehicle */
322 if (!v->IsArticulatedPart()) actual_subtype = new_subtype;
323
324 if (v->type == VEH_TRAIN && !vehicles_to_refit.Contains(v->index) && !only_this) continue;
325
326 const Engine *e = v->GetEngine();
327 if (!e->CanCarryCargo()) continue;
328
329 /* If the vehicle is not refittable, or does not allow automatic refitting,
330 * count its capacity nevertheless if the cargo matches */
331 bool refittable = HasBit(e->info.refit_mask, new_cid) && (!auto_refit || HasBit(e->info.misc_flags, EF_AUTO_REFIT));
332 if (!refittable && v->cargo_type != new_cid) continue;
333
334 /* Determine best fitting subtype if requested */
335 if (actual_subtype == 0xFF) {
336 actual_subtype = GetBestFittingSubType(v, v, new_cid);
337 }
338
339 /* Back up the vehicle's cargo type */
340 CargoID temp_cid = v->cargo_type;
341 byte temp_subtype = v->cargo_subtype;
342 if (refittable) {
343 v->cargo_type = new_cid;
344 v->cargo_subtype = actual_subtype;
345 }
346
347 uint16 mail_capacity = 0;
348 uint amount = e->DetermineCapacity(v, &mail_capacity);
349 total_capacity += amount;
350 /* mail_capacity will always be zero if the vehicle is not an aircraft. */
351 total_mail_capacity += mail_capacity;
352
353 if (!refittable) continue;
354
355 /* Restore the original cargo type */
356 v->cargo_type = temp_cid;
357 v->cargo_subtype = temp_subtype;
358
359 bool auto_refit_allowed;
360 CommandCost refit_cost = GetRefitCost(v, v->engine_type, new_cid, actual_subtype, &auto_refit_allowed);
361 if (auto_refit && (flags & DC_QUERY_COST) == 0 && !auto_refit_allowed) {
362 /* Sorry, auto-refitting not allowed, subtract the cargo amount again from the total.
363 * When querrying cost/capacity (for example in order refit GUI), we always assume 'allowed'.
364 * It is not predictable. */
365 total_capacity -= amount;
366 total_mail_capacity -= mail_capacity;
367
368 if (v->cargo_type == new_cid) {
369 /* Add the old capacity nevertheless, if the cargo matches */
370 total_capacity += v->cargo_cap;
371 if (v->type == VEH_AIRCRAFT) total_mail_capacity += v->Next()->cargo_cap;
372 }
373 continue;
374 }
375 cost.AddCost(refit_cost);
376
377 /* Record the refitting.
378 * Do not execute the refitting immediately, so DetermineCapacity and GetRefitCost do the same in test and exec run.
379 * (weird NewGRFs)
380 * Note:
381 * - If the capacity of vehicles depends on other vehicles in the chain, the actual capacity is
382 * set after RefitVehicle() via ConsistChanged() and friends. The estimation via _returned_refit_capacity will be wrong.
383 * - We have to call the refit cost callback with the pre-refit configuration of the chain because we want refit and
384 * autorefit to behave the same, and we need its result for auto_refit_allowed.
385 */
386 RefitResult *result = refit_result.Append();
387 result->v = v;
388 result->capacity = amount;
389 result->mail_capacity = mail_capacity;
390 result->subtype = actual_subtype;
391 }
392
393 if (flags & DC_EXEC) {
394 /* Store the result */
395 for (RefitResult *result = refit_result.Begin(); result != refit_result.End(); result++) {
396 Vehicle *u = result->v;
397 u->refit_cap = (u->cargo_type == new_cid) ? min(result->capacity, u->refit_cap) : 0;
398 if (u->cargo.TotalCount() > u->refit_cap) u->cargo.Truncate(u->cargo.TotalCount() - u->refit_cap);
399 u->cargo_type = new_cid;
400 u->cargo_cap = result->capacity;
401 u->cargo_subtype = result->subtype;
402 if (u->type == VEH_AIRCRAFT) {
403 Vehicle *w = u->Next();
404 w->refit_cap = min(w->refit_cap, result->mail_capacity);
405 w->cargo_cap = result->mail_capacity;
406 if (w->cargo.TotalCount() > w->refit_cap) w->cargo.Truncate(w->cargo.TotalCount() - w->refit_cap);
407 }
408 }
409 }
410
411 refit_result.Clear();
412 _returned_refit_capacity = total_capacity;
413 _returned_mail_refit_capacity = total_mail_capacity;
414 return cost;
415 }
416
432 CommandCost CmdRefitVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
433 {
434 Vehicle *v = Vehicle::GetIfValid(p1);
435 if (v == NULL) return CMD_ERROR;
436
437 /* Don't allow disasters and sparks and such to be refitted.
438 * We cannot check for IsPrimaryVehicle as autoreplace also refits in free wagon chains. */
439 if (!IsCompanyBuildableVehicleType(v->type)) return CMD_ERROR;
440
441 Vehicle *front = v->First();
442
443 CommandCost ret = CheckOwnership(front->owner);
444 if (ret.Failed()) return ret;
445
446 bool auto_refit = HasBit(p2, 6);
447 bool free_wagon = v->type == VEH_TRAIN && Train::From(front)->IsFreeWagon(); // used by autoreplace/renew
448
449 /* Don't allow shadows and such to be refitted. */
450 if (v != front && (v->type == VEH_SHIP || v->type == VEH_AIRCRAFT)) return CMD_ERROR;
451
452 /* Allow auto-refitting only during loading and normal refitting only in a depot. */
453 if ((flags & DC_QUERY_COST) == 0 && // used by the refit GUI, including the order refit GUI.
454 !free_wagon && // used by autoreplace/renew
455 (!auto_refit || !front->current_order.IsType(OT_LOADING)) && // refit inside stations
456 !front->IsStoppedInDepot()) { // refit inside depots
457 return_cmd_error(STR_ERROR_TRAIN_MUST_BE_STOPPED_INSIDE_DEPOT + front->type);
458 }
459
460 if (front->vehstatus & VS_CRASHED) return_cmd_error(STR_ERROR_VEHICLE_IS_DESTROYED);
461
462 /* Check cargo */
463 CargoID new_cid = GB(p2, 0, 5);
464 byte new_subtype = GB(p2, 8, 8);
465 if (new_cid >= NUM_CARGO) return CMD_ERROR;
466
467 /* For ships and aircrafts there is always only one. */
468 bool only_this = HasBit(p2, 7) || front->type == VEH_SHIP || front->type == VEH_AIRCRAFT;
469 uint8 num_vehicles = GB(p2, 16, 8);
470
471 CommandCost cost = RefitVehicle(v, only_this, num_vehicles, new_cid, new_subtype, flags, auto_refit);
472
473 if (flags & DC_EXEC) {
474 /* Update the cached variables */
475 switch (v->type) {
476 case VEH_TRAIN:
477 Train::From(front)->ConsistChanged(auto_refit ? CCF_AUTOREFIT : CCF_REFIT);
478 break;
479 case VEH_ROAD:
480 RoadVehUpdateCache(RoadVehicle::From(front), auto_refit);
481 if (_settings_game.vehicle.roadveh_acceleration_model != AM_ORIGINAL) RoadVehicle::From(front)->CargoChanged();
482 break;
483
484 case VEH_SHIP:
485 v->InvalidateNewGRFCacheOfChain();
486 Ship::From(v)->UpdateCache();
487 break;
488
489 case VEH_AIRCRAFT:
490 v->InvalidateNewGRFCacheOfChain();
491 UpdateAircraftCache(Aircraft::From(v), true);
492 break;
493
494 default: NOT_REACHED();
495 }
496 front->MarkDirty();
497
498 if (!free_wagon) {
499 InvalidateWindowData(WC_VEHICLE_DETAILS, front->index);
500 InvalidateWindowClassesData(GetWindowClassForVehicleType(v->type), 0);
501 }
502 SetWindowDirty(WC_VEHICLE_DEPOT, front->tile);
503 } else {
504 /* Always invalidate the cache; querycost might have filled it. */
505 v->InvalidateNewGRFCacheOfChain();
506 }
507
508 return cost;
509 }
510
520 CommandCost CmdStartStopVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
521 {
522 /* Disable the effect of p2 bit 0, when DC_AUTOREPLACE is not set */
523 if ((flags & DC_AUTOREPLACE) == 0) SetBit(p2, 0);
524
525 Vehicle *v = Vehicle::GetIfValid(p1);
526 if (v == NULL || !v->IsPrimaryVehicle()) return CMD_ERROR;
527
528 CommandCost ret = CheckOwnership(v->owner);
529 if (ret.Failed()) return ret;
530
531 if (v->vehstatus & VS_CRASHED) return_cmd_error(STR_ERROR_VEHICLE_IS_DESTROYED);
532
533 switch (v->type) {
534 case VEH_TRAIN:
535 if ((v->vehstatus & VS_STOPPED) && Train::From(v)->gcache.cached_power == 0) return_cmd_error(STR_ERROR_TRAIN_START_NO_POWER);
536 break;
537
538 case VEH_SHIP:
539 case VEH_ROAD:
540 break;
541
542 case VEH_AIRCRAFT: {
543 Aircraft *a = Aircraft::From(v);
544 /* cannot stop airplane when in flight, or when taking off / landing */
545 if (!(v->vehstatus & VS_CRASHED) && a->state >= STARTTAKEOFF && a->state < TERM7) return_cmd_error(STR_ERROR_AIRCRAFT_IS_IN_FLIGHT);
546 break;
547 }
548
549 default: return CMD_ERROR;
550 }
551
552 if (HasBit(p2, 0)) {
553 /* Check if this vehicle can be started/stopped. Failure means 'allow'. */
554 uint16 callback = GetVehicleCallback(CBID_VEHICLE_START_STOP_CHECK, 0, 0, v->engine_type, v);
555 StringID error = STR_NULL;
556 if (callback != CALLBACK_FAILED) {
557 if (v->GetGRF()->grf_version < 8) {
558 /* 8 bit result 0xFF means 'allow' */
559 if (callback < 0x400 && GB(callback, 0, 8) != 0xFF) error = GetGRFStringID(v->GetGRFID(), 0xD000 + callback);
560 } else {
561 if (callback < 0x400) {
562 error = GetGRFStringID(v->GetGRFID(), 0xD000 + callback);
563 } else {
564 switch (callback) {
565 case 0x400: // allow
566 break;
567
568 default: // unknown reason -> disallow
569 error = STR_ERROR_INCOMPATIBLE_RAIL_TYPES;
570 break;
571 }
572 }
573 }
574 }
575 if (error != STR_NULL) return_cmd_error(error);
576 }
577
578 if (flags & DC_EXEC) {
579 if (v->IsStoppedInDepot() && (flags & DC_AUTOREPLACE) == 0) DeleteVehicleNews(p1, STR_NEWS_TRAIN_IS_WAITING + v->type);
580
581 v->vehstatus ^= VS_STOPPED;
582 if (v->type != VEH_TRAIN) v->cur_speed = 0; // trains can stop 'slowly'
583 v->MarkDirty();
584 SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, WID_VV_START_STOP);
585 SetWindowDirty(WC_VEHICLE_DEPOT, v->tile);
586 SetWindowClassesDirty(GetWindowClassForVehicleType(v->type));
587 }
588 return CommandCost();
589 }
590
602 CommandCost CmdMassStartStopVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
603 {
604 VehicleList list;
605 bool do_start = HasBit(p1, 0);
606 bool vehicle_list_window = HasBit(p1, 1);
607
608 VehicleListIdentifier vli;
609 if (!vli.UnpackIfValid(p2)) return CMD_ERROR;
610 if (!IsCompanyBuildableVehicleType(vli.vtype)) return CMD_ERROR;
611
612 if (vehicle_list_window) {
613 if (!GenerateVehicleSortList(&list, vli)) return CMD_ERROR;
614 } else {
615 /* Get the list of vehicles in the depot */
616 BuildDepotVehicleList(vli.vtype, tile, &list, NULL);
617 }
618
619 for (uint i = 0; i < list.Length(); i++) {
620 const Vehicle *v = list[i];
621
622 if (!!(v->vehstatus & VS_STOPPED) != do_start) continue;
623
624 if (!vehicle_list_window && !v->IsChainInDepot()) continue;
625
626 /* Just try and don't care if some vehicle's can't be stopped. */
627 DoCommand(tile, v->index, 0, flags, CMD_START_STOP_VEHICLE);
628 }
629
630 return CommandCost();
631 }
632
642 CommandCost CmdDepotSellAllVehicles(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
643 {
644 VehicleList list;
645
646 CommandCost cost(EXPENSES_NEW_VEHICLES);
647 VehicleType vehicle_type = Extract<VehicleType, 0, 3>(p1);
648
649 if (!IsCompanyBuildableVehicleType(vehicle_type)) return CMD_ERROR;
650
651 uint sell_command = GetCmdSellVeh(vehicle_type);
652
653 /* Get the list of vehicles in the depot */
654 BuildDepotVehicleList(vehicle_type, tile, &list, &list);
655
656 CommandCost last_error = CMD_ERROR;
657 bool had_success = false;
658 for (uint i = 0; i < list.Length(); i++) {
659 CommandCost ret = DoCommand(tile, list[i]->index | (1 << 20), 0, flags, sell_command);
660 if (ret.Succeeded()) {
661 cost.AddCost(ret);
662 had_success = true;
663 } else {
664 last_error = ret;
665 }
666 }
667
668 return had_success ? cost : last_error;
669 }
670
680 CommandCost CmdDepotMassAutoReplace(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
681 {
682 VehicleList list;
683 CommandCost cost = CommandCost(EXPENSES_NEW_VEHICLES);
684 VehicleType vehicle_type = Extract<VehicleType, 0, 3>(p1);
685
686 if (!IsCompanyBuildableVehicleType(vehicle_type)) return CMD_ERROR;
687 if (!IsDepotTile(tile) || !IsTileOwner(tile, _current_company)) return CMD_ERROR;
688
689 /* Get the list of vehicles in the depot */
690 BuildDepotVehicleList(vehicle_type, tile, &list, &list, true);
691
692 for (uint i = 0; i < list.Length(); i++) {
693 const Vehicle *v = list[i];
694
695 /* Ensure that the vehicle completely in the depot */
696 if (!v->IsChainInDepot()) continue;
697
698 CommandCost ret = DoCommand(0, v->index, 0, flags, CMD_AUTOREPLACE_VEHICLE);
699
700 if (ret.Succeeded()) cost.AddCost(ret);
701 }
702 return cost;
703 }
704
710 static bool IsUniqueVehicleName(const char *name)
711 {
712 const Vehicle *v;
713
714 FOR_ALL_VEHICLES(v) {
715 if (v->name != NULL && strcmp(v->name, name) == 0) return false;
716 }
717
718 return true;
719 }
720
726 static void CloneVehicleName(const Vehicle *src, Vehicle *dst)
727 {
728 char buf[256];
729
730 /* Find the position of the first digit in the last group of digits. */
731 size_t number_position;
732 for (number_position = strlen(src->name); number_position > 0; number_position--) {
733 /* The design of UTF-8 lets this work simply without having to check
734 * for UTF-8 sequences. */
735 if (src->name[number_position - 1] < '0' || src->name[number_position - 1] > '9') break;
736 }
737
738 /* Format buffer and determine starting number. */
739 int num;
740 byte padding = 0;
741 if (number_position == strlen(src->name)) {
742 /* No digit at the end, so start at number 2. */
743 strecpy(buf, src->name, lastof(buf));
744 strecat(buf, " ", lastof(buf));
745 number_position = strlen(buf);
746 num = 2;
747 } else {
748 /* Found digits, parse them and start at the next number. */
749 strecpy(buf, src->name, lastof(buf));
750 buf[number_position] = '\0';
751 char *endptr;
752 num = strtol(&src->name[number_position], &endptr, 10) + 1;
753 padding = endptr - &src->name[number_position];
754 }
755
756 /* Check if this name is already taken. */
757 for (int max_iterations = 1000; max_iterations > 0; max_iterations--, num++) {
758 /* Attach the number to the temporary name. */
759 seprintf(&buf[number_position], lastof(buf), "%0*d", padding, num);
760
761 /* Check the name is unique. */
762 if (IsUniqueVehicleName(buf)) {
763 dst->name = stredup(buf);
764 break;
765 }
766 }
767
768 /* All done. If we didn't find a name, it'll just use its default. */
769 }
770
780 CommandCost CmdCloneVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
781 {
782 CommandCost total_cost(EXPENSES_NEW_VEHICLES);
783
784 Vehicle *v = Vehicle::GetIfValid(p1);
785 if (v == NULL || !v->IsPrimaryVehicle()) return CMD_ERROR;
786 Vehicle *v_front = v;
787 Vehicle *w = NULL;
788 Vehicle *w_front = NULL;
789 Vehicle *w_rear = NULL;
790
791 /*
792 * v_front is the front engine in the original vehicle
793 * v is the car/vehicle of the original vehicle that is currently being copied
794 * w_front is the front engine of the cloned vehicle
795 * w is the car/vehicle currently being cloned
796 * w_rear is the rear end of the cloned train. It's used to add more cars and is only used by trains
797 */
798
799 CommandCost ret = CheckOwnership(v->owner);
800 if (ret.Failed()) return ret;
801
802 if (v->type == VEH_TRAIN && (!v->IsFrontEngine() || Train::From(v)->crash_anim_pos >= 4400)) return CMD_ERROR;
803
804 /* check that we can allocate enough vehicles */
805 if (!(flags & DC_EXEC)) {
806 int veh_counter = 0;
807 do {
808 veh_counter++;
809 } while ((v = v->Next()) != NULL);
810
811 if (!Vehicle::CanAllocateItem(veh_counter)) {
812 return_cmd_error(STR_ERROR_TOO_MANY_VEHICLES_IN_GAME);
813 }
814 }
815
816 v = v_front;
817
818 do {
819 if (v->type == VEH_TRAIN && Train::From(v)->IsRearDualheaded()) {
820 /* we build the rear ends of multiheaded trains with the front ones */
821 continue;
822 }
823
824 /* In case we're building a multi headed vehicle and the maximum number of
825 * vehicles is almost reached (e.g. max trains - 1) not all vehicles would
826 * be cloned. When the non-primary engines were build they were seen as
827 * 'new' vehicles whereas they would immediately be joined with a primary
828 * engine. This caused the vehicle to be not build as 'the limit' had been
829 * reached, resulting in partially build vehicles and such. */
830 DoCommandFlag build_flags = flags;
831 if ((flags & DC_EXEC) && !v->IsPrimaryVehicle()) build_flags |= DC_AUTOREPLACE;
832
833 CommandCost cost = DoCommand(tile, v->engine_type | (1 << 16), 0, build_flags, GetCmdBuildVeh(v));
834
835 if (cost.Failed()) {
836 /* Can't build a part, then sell the stuff we already made; clear up the mess */
837 if (w_front != NULL) DoCommand(w_front->tile, w_front->index | (1 << 20), 0, flags, GetCmdSellVeh(w_front));
838 return cost;
839 }
840
841 total_cost.AddCost(cost);
842
843 if (flags & DC_EXEC) {
844 w = Vehicle::Get(_new_vehicle_id);
845
846 if (v->type == VEH_TRAIN && HasBit(Train::From(v)->flags, VRF_REVERSE_DIRECTION)) {
847 SetBit(Train::From(w)->flags, VRF_REVERSE_DIRECTION);
848 }
849
850 if (v->type == VEH_TRAIN && !v->IsFrontEngine()) {
851 /* this s a train car
852 * add this unit to the end of the train */
853 CommandCost result = DoCommand(0, w->index | 1 << 20, w_rear->index, flags, CMD_MOVE_RAIL_VEHICLE);
854 if (result.Failed()) {
855 /* The train can't be joined to make the same consist as the original.
856 * Sell what we already made (clean up) and return an error. */
857 DoCommand(w_front->tile, w_front->index | 1 << 20, 0, flags, GetCmdSellVeh(w_front));
858 DoCommand(w_front->tile, w->index | 1 << 20, 0, flags, GetCmdSellVeh(w));
859 return result; // return error and the message returned from CMD_MOVE_RAIL_VEHICLE
860 }
861 } else {
862 /* this is a front engine or not a train. */
863 w_front = w;
864 w->service_interval = v->service_interval;
865 w->SetServiceIntervalIsCustom(v->ServiceIntervalIsCustom());
866 w->SetServiceIntervalIsPercent(v->ServiceIntervalIsPercent());
867 }
868 w_rear = w; // trains needs to know the last car in the train, so they can add more in next loop
869 }
870 } while (v->type == VEH_TRAIN && (v = v->GetNextVehicle()) != NULL);
871
872 if ((flags & DC_EXEC) && v_front->type == VEH_TRAIN) {
873 /* for trains this needs to be the front engine due to the callback function */
874 _new_vehicle_id = w_front->index;
875 }
876
877 if (flags & DC_EXEC) {
878 /* Cloned vehicles belong to the same group */
879 DoCommand(0, v_front->group_id, w_front->index, flags, CMD_ADD_VEHICLE_GROUP);
880 }
881
882
883 /* Take care of refitting. */
884 w = w_front;
885 v = v_front;
886
887 /* Both building and refitting are influenced by newgrf callbacks, which
888 * makes it impossible to accurately estimate the cloning costs. In
889 * particular, it is possible for engines of the same type to be built with
890 * different numbers of articulated parts, so when refitting we have to
891 * loop over real vehicles first, and then the articulated parts of those
892 * vehicles in a different loop. */
893 do {
894 do {
895 if (flags & DC_EXEC) {
896 assert(w != NULL);
897
898 /* Find out what's the best sub type */
899 byte subtype = GetBestFittingSubType(v, w, v->cargo_type);
900 if (w->cargo_type != v->cargo_type || w->cargo_subtype != subtype) {
901 CommandCost cost = DoCommand(0, w->index, v->cargo_type | 1U << 7 | (subtype << 8), flags, GetCmdRefitVeh(v));
902 if (cost.Succeeded()) total_cost.AddCost(cost);
903 }
904
905 if (w->IsGroundVehicle() && w->HasArticulatedPart()) {
906 w = w->GetNextArticulatedPart();
907 } else {
908 break;
909 }
910 } else {
911 const Engine *e = v->GetEngine();
912 CargoID initial_cargo = (e->CanCarryCargo() ? e->GetDefaultCargoType() : (CargoID)CT_INVALID);
913
914 if (v->cargo_type != initial_cargo && initial_cargo != CT_INVALID) {
915 bool dummy;
916 total_cost.AddCost(GetRefitCost(NULL, v->engine_type, v->cargo_type, v->cargo_subtype, &dummy));
917 }
918 }
919
920 if (v->IsGroundVehicle() && v->HasArticulatedPart()) {
921 v = v->GetNextArticulatedPart();
922 } else {
923 break;
924 }
925 } while (v != NULL);
926
927 if ((flags & DC_EXEC) && v->type == VEH_TRAIN) w = w->GetNextVehicle();
928 } while (v->type == VEH_TRAIN && (v = v->GetNextVehicle()) != NULL);
929
930 if (flags & DC_EXEC) {
931 /*
932 * Set the orders of the vehicle. Cannot do it earlier as we need
933 * the vehicle refitted before doing this, otherwise the moved
934 * cargo types might not match (passenger vs non-passenger)
935 */
936 DoCommand(0, w_front->index | (p2 & 1 ? CO_SHARE : CO_COPY) << 30, v_front->index, flags, CMD_CLONE_ORDER);
937
938 /* Now clone the vehicle's name, if it has one. */
939 if (v_front->name != NULL) CloneVehicleName(v_front, w_front);
940 }
941
942 /* Since we can't estimate the cost of cloning a vehicle accurately we must
943 * check whether the company has enough money manually. */
944 if (!CheckCompanyHasMoney(total_cost)) {
945 if (flags & DC_EXEC) {
946 /* The vehicle has already been bought, so now it must be sold again. */
947 DoCommand(w_front->tile, w_front->index | 1 << 20, 0, flags, GetCmdSellVeh(w_front));
948 }
949 return total_cost;
950 }
951
952 return total_cost;
953 }
954
962 static CommandCost SendAllVehiclesToDepot(DoCommandFlag flags, bool service, const VehicleListIdentifier &vli)
963 {
964 VehicleList list;
965
966 if (!GenerateVehicleSortList(&list, vli)) return CMD_ERROR;
967
968 /* Send all the vehicles to a depot */
969 bool had_success = false;
970 for (uint i = 0; i < list.Length(); i++) {
971 const Vehicle *v = list[i];
972 CommandCost ret = DoCommand(v->tile, v->index | (service ? DEPOT_SERVICE : 0U) | DEPOT_DONT_CANCEL, 0, flags, GetCmdSendToDepot(vli.vtype));
973
974 if (ret.Succeeded()) {
975 had_success = true;
976
977 /* Return 0 if DC_EXEC is not set this is a valid goto depot command)
978 * In this case we know that at least one vehicle can be sent to a depot
979 * and we will issue the command. We can now safely quit the loop, knowing
980 * it will succeed at least once. With DC_EXEC we really need to send them to the depot */
981 if (!(flags & DC_EXEC)) break;
982 }
983 }
984
985 return had_success ? CommandCost() : CMD_ERROR;
986 }
987
999 CommandCost CmdSendVehicleToDepot(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
1000 {
1001 if (p1 & DEPOT_MASS_SEND) {
1002 /* Mass goto depot requested */
1003 VehicleListIdentifier vli;
1004 if (!vli.UnpackIfValid(p2)) return CMD_ERROR;
1005 return SendAllVehiclesToDepot(flags, (p1 & DEPOT_SERVICE) != 0, vli);
1006 }
1007
1008 Vehicle *v = Vehicle::GetIfValid(GB(p1, 0, 20));
1009 if (v == NULL) return CMD_ERROR;
1010 if (!v->IsPrimaryVehicle()) return CMD_ERROR;
1011
1012 return v->SendToDepot(flags, (DepotCommand)(p1 & DEPOT_COMMAND_MASK));
1013 }
1014
1024 CommandCost CmdRenameVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
1025 {
1026 Vehicle *v = Vehicle::GetIfValid(p1);
1027 if (v == NULL || !v->IsPrimaryVehicle()) return CMD_ERROR;
1028
1029 CommandCost ret = CheckOwnership(v->owner);
1030 if (ret.Failed()) return ret;
1031
1032 bool reset = StrEmpty(text);
1033
1034 if (!reset) {
1035 if (Utf8StringLength(text) >= MAX_LENGTH_VEHICLE_NAME_CHARS) return CMD_ERROR;
1036 if (!(flags & DC_AUTOREPLACE) && !IsUniqueVehicleName(text)) return_cmd_error(STR_ERROR_NAME_MUST_BE_UNIQUE);
1037 }
1038
1039 if (flags & DC_EXEC) {
1040 free(v->name);
1041 v->name = reset ? NULL : stredup(text);
1042 InvalidateWindowClassesData(GetWindowClassForVehicleType(v->type), 1);
1043 MarkWholeScreenDirty();
1044 }
1045
1046 return CommandCost();
1047 }
1048
1049
1062 CommandCost CmdChangeServiceInt(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
1063 {
1064 Vehicle *v = Vehicle::GetIfValid(p1);
1065 if (v == NULL || !v->IsPrimaryVehicle()) return CMD_ERROR;
1066
1067 CommandCost ret = CheckOwnership(v->owner);
1068 if (ret.Failed()) return ret;
1069
1070 const Company *company = Company::Get(v->owner);
1071 bool iscustom = HasBit(p2, 16);
1072 bool ispercent = iscustom ? HasBit(p2, 17) : company->settings.vehicle.servint_ispercent;
1073
1074 uint16 serv_int;
1075 if (iscustom) {
1076 serv_int = GB(p2, 0, 16);
1077 if (serv_int != GetServiceIntervalClamped(serv_int, ispercent)) return CMD_ERROR;
1078 } else {
1079 serv_int = CompanyServiceInterval(company, v->type);
1080 }
1081
1082 if (flags & DC_EXEC) {
1083 v->SetServiceInterval(serv_int);
1084 v->SetServiceIntervalIsCustom(iscustom);
1085 v->SetServiceIntervalIsPercent(ispercent);
1086 SetWindowDirty(WC_VEHICLE_DETAILS, v->index);
1087 }
1088
1089 return CommandCost();
1090 }