OpenTTD Source  12.0-beta2
group_cmd.cpp
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * 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.
4  * 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.
5  * 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/>.
6  */
7 
10 #include "stdafx.h"
11 #include "cmd_helper.h"
12 #include "command_func.h"
13 #include "train.h"
14 #include "vehiclelist.h"
15 #include "vehicle_func.h"
16 #include "autoreplace_base.h"
17 #include "autoreplace_func.h"
18 #include "string_func.h"
19 #include "company_func.h"
20 #include "core/pool_func.hpp"
21 #include "order_backup.h"
22 
23 #include "table/strings.h"
24 
25 #include "safeguards.h"
26 
27 GroupID _new_group_id;
28 
29 GroupPool _group_pool("Group");
31 
32 GroupStatistics::GroupStatistics()
33 {
34  this->num_engines = CallocT<uint16>(Engine::GetPoolSize());
35 }
36 
37 GroupStatistics::~GroupStatistics()
38 {
39  free(this->num_engines);
40 }
41 
46 {
47  this->num_vehicle = 0;
48  this->num_profit_vehicle = 0;
49  this->profit_last_year = 0;
50 
51  /* This is also called when NewGRF change. So the number of engines might have changed. Reallocate. */
52  free(this->num_engines);
53  this->num_engines = CallocT<uint16>(Engine::GetPoolSize());
54 }
55 
64 {
65  if (Group::IsValidID(id_g)) {
66  Group *g = Group::Get(id_g);
67  assert(g->owner == company);
68  assert(g->vehicle_type == type);
69  return g->statistics;
70  }
71 
72  if (IsDefaultGroupID(id_g)) return Company::Get(company)->group_default[type];
73  if (IsAllGroupID(id_g)) return Company::Get(company)->group_all[type];
74 
75  NOT_REACHED();
76 }
77 
84 {
85  return GroupStatistics::Get(v->owner, v->group_id, v->type);
86 }
87 
94 {
95  return GroupStatistics::Get(v->owner, ALL_GROUP, v->type);
96 }
97 
102 {
103  /* Set up the engine count for all companies */
104  for (Company *c : Company::Iterate()) {
105  for (VehicleType type = VEH_BEGIN; type < VEH_COMPANY_END; type++) {
106  c->group_all[type].Clear();
107  c->group_default[type].Clear();
108  }
109  }
110 
111  /* Recalculate */
112  for (Group *g : Group::Iterate()) {
113  g->statistics.Clear();
114  }
115 
116  for (const Vehicle *v : Vehicle::Iterate()) {
117  if (!v->IsEngineCountable()) continue;
118 
120  if (v->IsPrimaryVehicle()) GroupStatistics::CountVehicle(v, 1);
121  }
122 
123  for (const Company *c : Company::Iterate()) {
125  }
126 }
127 
133 /* static */ void GroupStatistics::CountVehicle(const Vehicle *v, int delta)
134 {
135  assert(delta == 1 || delta == -1);
136 
139 
140  stats_all.num_vehicle += delta;
141  stats.num_vehicle += delta;
142 
143  if (v->age > VEHICLE_PROFIT_MIN_AGE) {
144  stats_all.num_profit_vehicle += delta;
145  stats_all.profit_last_year += v->GetDisplayProfitLastYear() * delta;
146  stats.num_profit_vehicle += delta;
147  stats.profit_last_year += v->GetDisplayProfitLastYear() * delta;
148  }
149 }
150 
156 /* static */ void GroupStatistics::CountEngine(const Vehicle *v, int delta)
157 {
158  assert(delta == 1 || delta == -1);
161 }
162 
167 {
170 
171  stats_all.num_profit_vehicle++;
172  stats_all.profit_last_year += v->GetDisplayProfitLastYear();
173  stats.num_profit_vehicle++;
175 }
176 
181 {
182  /* Set up the engine count for all companies */
183  for (Company *c : Company::Iterate()) {
184  for (VehicleType type = VEH_BEGIN; type < VEH_COMPANY_END; type++) {
185  c->group_all[type].ClearProfits();
186  c->group_default[type].ClearProfits();
187  }
188  }
189 
190  /* Recalculate */
191  for (Group *g : Group::Iterate()) {
192  g->statistics.ClearProfits();
193  }
194 
195  for (const Vehicle *v : Vehicle::Iterate()) {
196  if (v->IsPrimaryVehicle() && v->age > VEHICLE_PROFIT_MIN_AGE) GroupStatistics::VehicleReachedProfitAge(v);
197  }
198 }
199 
205 {
206  /* Set up the engine count for all companies */
207  Company *c = Company::Get(company);
208  for (VehicleType type = VEH_BEGIN; type < VEH_COMPANY_END; type++) {
209  c->group_all[type].ClearAutoreplace();
210  c->group_default[type].ClearAutoreplace();
211  }
212 
213  /* Recalculate */
214  for (Group *g : Group::Iterate()) {
215  if (g->owner != company) continue;
216  g->statistics.ClearAutoreplace();
217  }
218 
219  for (EngineRenewList erl = c->engine_renew_list; erl != nullptr; erl = erl->next) {
220  const Engine *e = Engine::Get(erl->from);
221  GroupStatistics &stats = GroupStatistics::Get(company, erl->group_id, e->type);
222  if (!stats.autoreplace_defined) {
223  stats.autoreplace_defined = true;
224  stats.autoreplace_finished = true;
225  }
226  if (GetGroupNumEngines(company, erl->group_id, erl->from) > 0) stats.autoreplace_finished = false;
227  }
228 }
229 
237 static inline void UpdateNumEngineGroup(const Vehicle *v, GroupID old_g, GroupID new_g)
238 {
239  if (old_g != new_g) {
240  /* Decrease the num engines in the old group */
242 
243  /* Increase the num engines in the new group */
245  }
246 }
247 
248 
249 const Livery *GetParentLivery(const Group *g)
250 {
251  if (g->parent == INVALID_GROUP) {
252  const Company *c = Company::Get(g->owner);
253  return &c->livery[LS_DEFAULT];
254  }
255 
256  const Group *pg = Group::Get(g->parent);
257  return &pg->livery;
258 }
259 
260 
266 {
267  /* Company colour data is indirectly cached. */
268  for (Vehicle *v : Vehicle::Iterate()) {
269  if (v->group_id == g->index && (!v->IsGroundVehicle() || v->IsFrontEngine())) {
270  for (Vehicle *u = v; u != nullptr; u = u->Next()) {
271  u->colourmap = PAL_NONE;
272  u->InvalidateNewGRFCache();
273  }
274  }
275  }
276 
277  for (Group *cg : Group::Iterate()) {
278  if (cg->parent == g->index) {
279  if (!HasBit(cg->livery.in_use, 0)) cg->livery.colour1 = g->livery.colour1;
280  if (!HasBit(cg->livery.in_use, 1)) cg->livery.colour2 = g->livery.colour2;
282  }
283  }
284 }
285 
286 
287 Group::Group(Owner owner)
288 {
289  this->owner = owner;
290  this->folded = false;
291 }
292 
293 
303 CommandCost CmdCreateGroup(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
304 {
305  VehicleType vt = Extract<VehicleType, 0, 3>(p1);
306  if (!IsCompanyBuildableVehicleType(vt)) return CMD_ERROR;
307 
308  if (!Group::CanAllocateItem()) return CMD_ERROR;
309 
310  const Group *pg = Group::GetIfValid(GB(p2, 0, 16));
311  if (pg != nullptr) {
312  if (pg->owner != _current_company) return CMD_ERROR;
313  if (pg->vehicle_type != vt) return CMD_ERROR;
314  }
315 
316  if (flags & DC_EXEC) {
317  Group *g = new Group(_current_company);
318  g->vehicle_type = vt;
319  g->parent = INVALID_GROUP;
320 
321  if (pg == nullptr) {
323  g->livery.colour1 = c->livery[LS_DEFAULT].colour1;
324  g->livery.colour2 = c->livery[LS_DEFAULT].colour2;
326  } else {
327  g->parent = pg->index;
328  g->livery.colour1 = pg->livery.colour1;
329  g->livery.colour2 = pg->livery.colour2;
330  g->flags = pg->flags;
331  }
332 
333  _new_group_id = g->index;
334 
337  }
338 
339  return CommandCost();
340 }
341 
342 
353 CommandCost CmdDeleteGroup(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
354 {
355  Group *g = Group::GetIfValid(p1);
356  if (g == nullptr || g->owner != _current_company) return CMD_ERROR;
357 
358  /* Remove all vehicles from the group */
359  DoCommand(0, p1, 0, flags, CMD_REMOVE_ALL_VEHICLES_GROUP);
360 
361  /* Delete sub-groups */
362  for (const Group *gp : Group::Iterate()) {
363  if (gp->parent == g->index) {
364  DoCommand(0, gp->index, 0, flags, CMD_DELETE_GROUP);
365  }
366  }
367 
368  if (flags & DC_EXEC) {
369  /* Update backupped orders if needed */
371 
372  /* If we set an autoreplace for the group we delete, remove it. */
374  Company *c;
375 
377  for (EngineRenew *er : EngineRenew::Iterate()) {
378  if (er->group_id == g->index) RemoveEngineReplacementForCompany(c, er->from, g->index, flags);
379  }
380  }
381 
382  VehicleType vt = g->vehicle_type;
383 
384  /* Delete the Replace Vehicle Windows */
386  delete g;
387 
390  }
391 
392  return CommandCost();
393 }
394 
407 CommandCost CmdAlterGroup(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
408 {
409  Group *g = Group::GetIfValid(GB(p1, 0, 16));
410  if (g == nullptr || g->owner != _current_company) return CMD_ERROR;
411 
412  if (!HasBit(p1, 16)) {
413  /* Rename group */
414  bool reset = text.empty();
415 
416  if (!reset) {
418  }
419 
420  if (flags & DC_EXEC) {
421  /* Assign the new one */
422  if (reset) {
423  g->name.clear();
424  } else {
425  g->name = text;
426  }
427  }
428  } else {
429  /* Set group parent */
430  const Group *pg = Group::GetIfValid(GB(p2, 0, 16));
431 
432  if (pg != nullptr) {
433  if (pg->owner != _current_company) return CMD_ERROR;
434  if (pg->vehicle_type != g->vehicle_type) return CMD_ERROR;
435 
436  /* Ensure request parent isn't child of group.
437  * This is the only place that infinite loops are prevented. */
438  if (GroupIsInGroup(pg->index, g->index)) return_cmd_error(STR_ERROR_GROUP_CAN_T_SET_PARENT_RECURSION);
439  }
440 
441  if (flags & DC_EXEC) {
442  g->parent = (pg == nullptr) ? INVALID_GROUP : pg->index;
444 
445  if (g->livery.in_use == 0) {
446  const Livery *livery = GetParentLivery(g);
447  g->livery.colour1 = livery->colour1;
448  g->livery.colour2 = livery->colour2;
449 
452  }
453  }
454  }
455 
456  if (flags & DC_EXEC) {
462  }
463 
464  return CommandCost();
465 }
466 
467 
473 static void AddVehicleToGroup(Vehicle *v, GroupID new_g)
474 {
476 
477  switch (v->type) {
478  default: NOT_REACHED();
479  case VEH_TRAIN:
480  SetTrainGroupID(Train::From(v), new_g);
481  break;
482 
483  case VEH_ROAD:
484  case VEH_SHIP:
485  case VEH_AIRCRAFT:
486  if (v->IsEngineCountable()) UpdateNumEngineGroup(v, v->group_id, new_g);
487  v->group_id = new_g;
488  for (Vehicle *u = v; u != nullptr; u = u->Next()) {
489  u->colourmap = PAL_NONE;
490  u->InvalidateNewGRFCache();
491  u->UpdateViewport(true);
492  }
493  break;
494  }
495 
497 }
498 
511 CommandCost CmdAddVehicleGroup(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
512 {
513  Vehicle *v = Vehicle::GetIfValid(GB(p2, 0, 20));
514  GroupID new_g = p1;
515 
516  if (v == nullptr || (!Group::IsValidID(new_g) && !IsDefaultGroupID(new_g) && new_g != NEW_GROUP)) return CMD_ERROR;
517 
518  if (Group::IsValidID(new_g)) {
519  Group *g = Group::Get(new_g);
520  if (g->owner != _current_company || g->vehicle_type != v->type) return CMD_ERROR;
521  }
522 
523  if (v->owner != _current_company || !v->IsPrimaryVehicle()) return CMD_ERROR;
524 
525  if (new_g == NEW_GROUP) {
526  /* Create new group. */
527  CommandCost ret = CmdCreateGroup(0, flags, v->type, INVALID_GROUP, {});
528  if (ret.Failed()) return ret;
529 
530  new_g = _new_group_id;
531  }
532 
533  if (flags & DC_EXEC) {
534  AddVehicleToGroup(v, new_g);
535 
536  if (HasBit(p2, 31)) {
537  /* Add vehicles in the shared order list as well. */
538  for (Vehicle *v2 = v->FirstShared(); v2 != nullptr; v2 = v2->NextShared()) {
539  if (v2->group_id != new_g) AddVehicleToGroup(v2, new_g);
540  }
541  }
542 
544 
545  /* Update the Replace Vehicle Windows */
553  }
554 
555  return CommandCost();
556 }
557 
568 CommandCost CmdAddSharedVehicleGroup(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
569 {
570  VehicleType type = Extract<VehicleType, 0, 3>(p2);
571  GroupID id_g = p1;
572  if (!Group::IsValidID(id_g) || !IsCompanyBuildableVehicleType(type)) return CMD_ERROR;
573 
574  if (flags & DC_EXEC) {
575  /* Find the first front engine which belong to the group id_g
576  * then add all shared vehicles of this front engine to the group id_g */
577  for (const Vehicle *v : Vehicle::Iterate()) {
578  if (v->type == type && v->IsPrimaryVehicle()) {
579  if (v->group_id != id_g) continue;
580 
581  /* For each shared vehicles add it to the group */
582  for (Vehicle *v2 = v->FirstShared(); v2 != nullptr; v2 = v2->NextShared()) {
583  if (v2->group_id != id_g) DoCommand(tile, id_g, v2->index, flags, CMD_ADD_VEHICLE_GROUP, text);
584  }
585  }
586  }
587 
589  }
590 
591  return CommandCost();
592 }
593 
594 
605 CommandCost CmdRemoveAllVehiclesGroup(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
606 {
607  GroupID old_g = p1;
608  Group *g = Group::GetIfValid(old_g);
609 
610  if (g == nullptr || g->owner != _current_company) return CMD_ERROR;
611 
612  if (flags & DC_EXEC) {
613  /* Find each Vehicle that belongs to the group old_g and add it to the default group */
614  for (const Vehicle *v : Vehicle::Iterate()) {
615  if (v->IsPrimaryVehicle()) {
616  if (v->group_id != old_g) continue;
617 
618  /* Add The Vehicle to the default group */
619  DoCommand(tile, DEFAULT_GROUP, v->index, flags, CMD_ADD_VEHICLE_GROUP, text);
620  }
621  }
622 
624  }
625 
626  return CommandCost();
627 }
628 
639 CommandCost CmdSetGroupLivery(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
640 {
641  Group *g = Group::GetIfValid(p1);
642  bool primary = !HasBit(p2, 8);
643  Colours colour = Extract<Colours, 16, 8>(p2);
644 
645  if (g == nullptr || g->owner != _current_company) return CMD_ERROR;
646 
647  if (colour >= COLOUR_END && colour != INVALID_COLOUR) return CMD_ERROR;
648 
649  if (flags & DC_EXEC) {
650  if (primary) {
651  SB(g->livery.in_use, 0, 1, colour != INVALID_COLOUR);
652  if (colour == INVALID_COLOUR) colour = (Colours)GetParentLivery(g)->colour1;
653  g->livery.colour1 = colour;
654  } else {
655  SB(g->livery.in_use, 1, 1, colour != INVALID_COLOUR);
656  if (colour == INVALID_COLOUR) colour = (Colours)GetParentLivery(g)->colour2;
657  g->livery.colour2 = colour;
658  }
659 
662  }
663 
664  return CommandCost();
665 }
666 
672 static void SetGroupFlag(Group *g, GroupFlags flag, bool set, bool children)
673 {
674  if (set) {
675  SetBit(g->flags, flag);
676  } else {
677  ClrBit(g->flags, flag);
678  }
679 
680  if (!children) return;
681 
682  for (Group *pg : Group::Iterate()) {
683  if (pg->parent == g->index) SetGroupFlag(pg, flag, set, true);
684  }
685 }
686 
700 CommandCost CmdSetGroupFlag(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
701 {
702  Group *g = Group::GetIfValid(GB(p1, 0, 16));
703  if (g == nullptr || g->owner != _current_company) return CMD_ERROR;
704 
705  /* GroupFlags are stored in as an 8 bit bitfield but passed here by value,
706  * so 3 bits is sufficient to cover each possible value. */
707  GroupFlags flag = (GroupFlags)GB(p1, 16, 3);
708  if (flag >= GroupFlags::GF_END) return CMD_ERROR;
709 
710  if (flags & DC_EXEC) {
711  SetGroupFlag(g, flag, HasBit(p2, 0), HasBit(p2, 1));
712 
715  }
716 
717  return CommandCost();
718 }
719 
726 {
727  if (!v->IsPrimaryVehicle()) return;
728 
729  if (!IsDefaultGroupID(v->group_id)) GroupStatistics::CountVehicle(v, -1);
730 }
731 
732 
740 {
741  if (!Group::IsValidID(new_g) && !IsDefaultGroupID(new_g)) return;
742 
743  assert(v->IsFrontEngine() || IsDefaultGroupID(new_g));
744 
745  for (Vehicle *u = v; u != nullptr; u = u->Next()) {
746  if (u->IsEngineCountable()) UpdateNumEngineGroup(u, u->group_id, new_g);
747 
748  u->group_id = new_g;
749  u->colourmap = PAL_NONE;
750  u->InvalidateNewGRFCache();
751  u->UpdateViewport(true);
752  }
753 
754  /* Update the Replace Vehicle Windows */
757 }
758 
759 
768 {
769  assert(v->IsFrontEngine() || v->IsFreeWagon());
770 
771  GroupID new_g = v->IsFrontEngine() ? v->group_id : (GroupID)DEFAULT_GROUP;
772  for (Vehicle *u = v; u != nullptr; u = u->Next()) {
773  if (u->IsEngineCountable()) UpdateNumEngineGroup(u, u->group_id, new_g);
774 
775  u->group_id = new_g;
776  u->colourmap = PAL_NONE;
777  u->InvalidateNewGRFCache();
778  }
779 
780  /* Update the Replace Vehicle Windows */
783 }
784 
793 uint GetGroupNumEngines(CompanyID company, GroupID id_g, EngineID id_e)
794 {
795  uint count = 0;
796  const Engine *e = Engine::Get(id_e);
797  for (const Group *g : Group::Iterate()) {
798  if (g->parent == id_g) count += GetGroupNumEngines(company, g->index, id_e);
799  }
800  return count + GroupStatistics::Get(company, id_g, e->type).num_engines[id_e];
801 }
802 
812 {
813  uint count = 0;
814  for (const Group *g : Group::Iterate()) {
815  if (g->parent == id_g) count += GetGroupNumVehicle(company, g->index, type);
816  }
817  return count + GroupStatistics::Get(company, id_g, type).num_vehicle;
818 }
819 
829 {
830  uint count = 0;
831  for (const Group *g : Group::Iterate()) {
832  if (g->parent == id_g) count += GetGroupNumProfitVehicle(company, g->index, type);
833  }
834  return count + GroupStatistics::Get(company, id_g, type).num_profit_vehicle;
835 }
836 
846 {
847  Money sum = 0;
848  for (const Group *g : Group::Iterate()) {
849  if (g->parent == id_g) sum += GetGroupProfitLastYear(company, g->index, type);
850  }
851  return sum + GroupStatistics::Get(company, id_g, type).profit_last_year;
852 }
853 
854 void RemoveAllGroupsForCompany(const CompanyID company)
855 {
856  for (Group *g : Group::Iterate()) {
857  if (company == g->owner) delete g;
858  }
859 }
860 
861 
868 bool GroupIsInGroup(GroupID search, GroupID group)
869 {
870  if (!Group::IsValidID(search)) return search == group;
871 
872  do {
873  if (search == group) return true;
874  search = Group::Get(search)->parent;
875  } while (search != INVALID_GROUP);
876 
877  return false;
878 }
VEH_AIRCRAFT
@ VEH_AIRCRAFT
Aircraft vehicle type.
Definition: vehicle_type.h:27
IsCompanyBuildableVehicleType
static bool IsCompanyBuildableVehicleType(VehicleType type)
Is the given vehicle type buildable by a company?
Definition: vehicle_func.h:89
TileIndex
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:83
InvalidateWindowData
void InvalidateWindowData(WindowClass cls, WindowNumber number, int data, bool gui_scope)
Mark window data of the window of a given class and specific window number as invalid (in need of re-...
Definition: window.cpp:3218
DoCommand
CommandCost DoCommand(const CommandContainer *container, DoCommandFlag flags)
Shorthand for calling the long DoCommand with a container.
Definition: command.cpp:450
autoreplace_base.h
Pool::PoolItem<&_group_pool >::Get
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:337
CmdSetGroupFlag
CommandCost CmdSetGroupFlag(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
(Un)set group flag from a group
Definition: group_cmd.cpp:700
SetWindowDirty
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
Definition: window.cpp:3120
GroupStatistics::CountEngine
static void CountEngine(const Vehicle *v, int delta)
Update num_engines when adding/removing an engine.
Definition: group_cmd.cpp:156
Company::group_all
GroupStatistics group_all[VEH_COMPANY_END]
NOSAVE: Statistics for the ALL_GROUP group.
Definition: company_base.h:125
GB
static uint GB(const T x, const uint8 s, const uint8 n)
Fetch n bits from x, started at bit s.
Definition: bitmath_func.hpp:32
CMD_ADD_VEHICLE_GROUP
@ CMD_ADD_VEHICLE_GROUP
add a vehicle to a group
Definition: command_type.h:324
train.h
command_func.h
Pool::PoolItem<&_group_pool >::GetIfValid
static Titem * GetIfValid(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:348
CMD_ERROR
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
Definition: command_func.h:23
Vehicle::IsEngineCountable
bool IsEngineCountable() const
Check if a vehicle is counted in num_engines in each company struct.
Definition: vehicle.cpp:708
VehicleListIdentifier
The information about a vehicle list.
Definition: vehiclelist.h:29
Vehicle::Next
Vehicle * Next() const
Get the next vehicle of this vehicle.
Definition: vehicle_base.h:594
SpecializedVehicle::Next
T * Next() const
Get next vehicle in the chain.
Definition: vehicle_base.h:1079
WC_COMPANY_COLOUR
@ WC_COMPANY_COLOUR
Company colour selection; Window numbers:
Definition: window_type.h:222
CMD_REMOVE_ALL_VEHICLES_GROUP
@ CMD_REMOVE_ALL_VEHICLES_GROUP
remove all vehicles from a group
Definition: command_type.h:326
vehiclelist.h
GetGroupNumProfitVehicle
uint GetGroupNumProfitVehicle(CompanyID company, GroupID id_g, VehicleType type)
Get the number of vehicles above profit minimum age in the group with GroupID id_g and its sub-groups...
Definition: group_cmd.cpp:828
Group::parent
GroupID parent
Parent group.
Definition: group.h:83
Pool::PoolItem::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:235
Vehicle::group_id
GroupID group_id
Index of group Pool array.
Definition: vehicle_base.h:337
UpdateNumEngineGroup
static void UpdateNumEngineGroup(const Vehicle *v, GroupID old_g, GroupID new_g)
Update the num engines of a groupID.
Definition: group_cmd.cpp:237
HasBit
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:103
GroupStatistics::CountVehicle
static void CountVehicle(const Vehicle *v, int delta)
Update num_vehicle when adding or removing a vehicle.
Definition: group_cmd.cpp:133
ClrBit
static T ClrBit(T &x, const uint8 y)
Clears a bit in a variable.
Definition: bitmath_func.hpp:151
GroupStatistics::autoreplace_finished
bool autoreplace_finished
Have all autoreplacement finished?
Definition: group.h:30
CmdAlterGroup
CommandCost CmdAlterGroup(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
Alter a group.
Definition: group_cmd.cpp:407
Group::livery
Livery livery
Custom colour scheme for vehicles in this group.
Definition: group.h:78
MAX_LENGTH_GROUP_NAME_CHARS
static const uint MAX_LENGTH_GROUP_NAME_CHARS
The maximum length of a group name in characters including '\0'.
Definition: group_type.h:20
CmdCreateGroup
CommandCost CmdCreateGroup(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
Create a new vehicle group.
Definition: group_cmd.cpp:303
Engine
Definition: engine_base.h:27
VEH_ROAD
@ VEH_ROAD
Road vehicle type.
Definition: vehicle_type.h:25
Vehicle
Vehicle data structure.
Definition: vehicle_base.h:221
GroupStatistics::profit_last_year
Money profit_last_year
Sum of profits for all vehicles.
Definition: group.h:33
Vehicle::IsPrimaryVehicle
virtual bool IsPrimaryVehicle() const
Whether this is the primary vehicle in the chain.
Definition: vehicle_base.h:446
Vehicle::owner
Owner owner
Which company owns the vehicle?
Definition: vehicle_base.h:285
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
DC_EXEC
@ DC_EXEC
execute the given command
Definition: command_type.h:348
Group::vehicle_type
VehicleType vehicle_type
Vehicle type of the group.
Definition: group.h:75
NEW_GROUP
static const GroupID NEW_GROUP
Sentinel for a to-be-created group.
Definition: group_type.h:15
DoCommandFlag
DoCommandFlag
List of flags for a command.
Definition: command_type.h:346
CmdDeleteGroup
CommandCost CmdDeleteGroup(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
Add all vehicles in the given group to the default group and then deletes the group.
Definition: group_cmd.cpp:353
GroupStatistics::num_vehicle
uint16 num_vehicle
Number of vehicles.
Definition: group.h:26
SetTrainGroupID
void SetTrainGroupID(Train *v, GroupID new_g)
Affect the groupID of a train to new_g.
Definition: group_cmd.cpp:739
UpdateTrainGroupID
void UpdateTrainGroupID(Train *v)
Recalculates the groupID of a train.
Definition: group_cmd.cpp:767
ALL_GROUP
static const GroupID ALL_GROUP
All vehicles are in this group.
Definition: group_type.h:16
Group
Group data.
Definition: group.h:72
CompanySettings::renew_keep_length
bool renew_keep_length
sell some wagons if after autoreplace the train is longer than before
Definition: settings_type.h:569
Utf8StringLength
size_t Utf8StringLength(const char *s)
Get the length of an UTF-8 encoded string in number of characters and thus not the number of bytes th...
Definition: string.cpp:417
Pool::PoolItem<&_engine_pool >::GetPoolSize
static size_t GetPoolSize()
Returns first unused index.
Definition: pool_type.hpp:358
GroupStatistics
Statistics and caches on the vehicles in a group.
Definition: group.h:25
EngineID
uint16 EngineID
Unique identification number of an engine.
Definition: engine_type.h:21
return_cmd_error
#define return_cmd_error(errcode)
Returns from a function with a specific StringID as error.
Definition: command_func.h:33
INVALID_GROUP
static const GroupID INVALID_GROUP
Sentinel for invalid groups.
Definition: group_type.h:18
CommandCost
Common return value for all commands.
Definition: command_type.h:23
cmd_helper.h
WC_VEHICLE_VIEW
@ WC_VEHICLE_VIEW
Vehicle view; Window numbers:
Definition: window_type.h:331
GroupFlags
GroupFlags
Definition: group.h:65
VEH_COMPANY_END
@ VEH_COMPANY_END
Last company-ownable type.
Definition: vehicle_type.h:29
Group::statistics
GroupStatistics statistics
NOSAVE: Statistics and caches on the vehicles in the group.
Definition: group.h:79
Company::group_default
GroupStatistics group_default[VEH_COMPANY_END]
NOSAVE: Statistics for the DEFAULT_GROUP group.
Definition: company_base.h:126
Vehicle::tile
TileIndex tile
Current tile index.
Definition: vehicle_base.h:242
Vehicle::engine_type
EngineID engine_type
The type of engine used for this vehicle.
Definition: vehicle_base.h:299
GetGroupNumVehicle
uint GetGroupNumVehicle(CompanyID company, GroupID id_g, VehicleType type)
Get the number of vehicles in the group with GroupID id_g and its sub-groups.
Definition: group_cmd.cpp:811
SB
static T SB(T &x, const uint8 s, const uint8 n, const U d)
Set n bits in x starting at bit s to d.
Definition: bitmath_func.hpp:58
GetGroupProfitLastYear
Money GetGroupProfitLastYear(CompanyID company, GroupID id_g, VehicleType type)
Get last year's profit for the group with GroupID id_g and its sub-groups.
Definition: group_cmd.cpp:845
CommandCost::Failed
bool Failed() const
Did this command fail?
Definition: command_type.h:159
CmdAddSharedVehicleGroup
CommandCost CmdAddSharedVehicleGroup(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
Add all shared vehicles of all vehicles from a group.
Definition: group_cmd.cpp:568
WC_REPLACE_VEHICLE
@ WC_REPLACE_VEHICLE
Replace vehicle window; Window numbers:
Definition: window_type.h:210
Group::owner
Owner owner
Group Owner.
Definition: group.h:74
VehicleListIdentifier::Pack
uint32 Pack() const
Pack a VehicleListIdentifier in a single uint32.
Definition: vehiclelist.cpp:21
Vehicle::IsFrontEngine
bool IsFrontEngine() const
Check if the vehicle is a front engine.
Definition: vehicle_base.h:897
Livery::in_use
byte in_use
Bit 0 set if this livery should override the default livery first colour, Bit 1 for the second colour...
Definition: livery.h:79
CompanyProperties::settings
CompanySettings settings
settings specific for each company
Definition: company_base.h:104
PropagateChildLivery
void PropagateChildLivery(const Group *g)
Propagate a livery change to a group's children.
Definition: group_cmd.cpp:265
WC_VEHICLE_DETAILS
@ WC_VEHICLE_DETAILS
Vehicle details; Window numbers:
Definition: window_type.h:192
MAX_COMPANIES
@ MAX_COMPANIES
Maximum number of companies.
Definition: company_type.h:23
safeguards.h
GroupStatistics::UpdateAutoreplace
static void UpdateAutoreplace(CompanyID company)
Update autoreplace_defined and autoreplace_finished of all statistics of a company.
Definition: group_cmd.cpp:204
Train
'Train' is either a loco or a wagon.
Definition: train.h:86
GroupStatistics::Get
static GroupStatistics & Get(CompanyID company, GroupID id_g, VehicleType type)
Returns the GroupStatistics for a specific group.
Definition: group_cmd.cpp:63
DEFAULT_GROUP
static const GroupID DEFAULT_GROUP
Ungrouped vehicles are in this group.
Definition: group_type.h:17
GroupStatistics::num_engines
uint16 * num_engines
Caches the number of engines of each type the company owns.
Definition: group.h:27
GroupStatistics::GetAllGroup
static GroupStatistics & GetAllGroup(const Vehicle *v)
Returns the GroupStatistic for the ALL_GROUPO of a vehicle type.
Definition: group_cmd.cpp:93
GroupStatistics::VehicleReachedProfitAge
static void VehicleReachedProfitAge(const Vehicle *v)
Add a vehicle to the profit sum of its group.
Definition: group_cmd.cpp:166
IsAllGroupID
static bool IsAllGroupID(GroupID id_g)
Checks if a GroupID stands for all vehicles of a company.
Definition: group.h:99
_group_pool
GroupPool _group_pool("Group")
Pool of groups.
Group::flags
uint8 flags
Group flags.
Definition: group.h:77
EngineRenew
Struct to store engine replacements.
Definition: autoreplace_base.h:33
CmdSetGroupLivery
CommandCost CmdSetGroupLivery(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
Set the livery for a vehicle group.
Definition: group_cmd.cpp:639
stdafx.h
CMD_DELETE_GROUP
@ CMD_DELETE_GROUP
delete a group
Definition: command_type.h:322
VehicleType
VehicleType
Available vehicle types.
Definition: vehicle_type.h:21
RemoveEngineReplacementForCompany
static CommandCost RemoveEngineReplacementForCompany(Company *c, EngineID engine, GroupID group, DoCommandFlag flags)
Remove an engine replacement for the company.
Definition: autoreplace_func.h:93
GroupStatistics::autoreplace_defined
bool autoreplace_defined
Are any autoreplace rules set?
Definition: group.h:29
GetWindowClassForVehicleType
static WindowClass GetWindowClassForVehicleType(VehicleType vt)
Get WindowClass for vehicle list of given vehicle type.
Definition: vehicle_gui.h:91
string_func.h
RemoveVehicleFromGroup
void RemoveVehicleFromGroup(const Vehicle *v)
Decrease the num_vehicle variable before delete an front engine from a group.
Definition: group_cmd.cpp:725
Vehicle::FirstShared
Vehicle * FirstShared() const
Get the first vehicle of this vehicle chain.
Definition: vehicle_base.h:688
_current_company
CompanyID _current_company
Company currently doing an action.
Definition: company_cmd.cpp:47
vehicle_func.h
Pool::PoolItem<&_company_pool >::Iterate
static Pool::IterateWrapper< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
Definition: pool_type.hpp:386
Pool
Base class for all pools.
Definition: pool_type.hpp:81
GroupID
uint16 GroupID
Type for all group identifiers.
Definition: group_type.h:13
GroupStatistics::UpdateProfits
static void UpdateProfits()
Recompute the profits for all groups.
Definition: group_cmd.cpp:180
SetGroupFlag
static void SetGroupFlag(Group *g, GroupFlags flag, bool set, bool children)
Set group flag for a group and its sub-groups.
Definition: group_cmd.cpp:672
SpecializedVehicle< Train, Type >::From
static Train * From(Vehicle *v)
Converts a Vehicle to SpecializedVehicle with type checking.
Definition: vehicle_base.h:1164
CmdAddVehicleGroup
CommandCost CmdAddVehicleGroup(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
Add a vehicle to a group.
Definition: group_cmd.cpp:511
GetGroupNumEngines
uint GetGroupNumEngines(CompanyID company, GroupID id_g, EngineID id_e)
Get the number of engines with EngineID id_e in the group with GroupID id_g and its sub-groups.
Definition: group_cmd.cpp:793
InvalidateWindowClassesData
void InvalidateWindowClassesData(WindowClass cls, int data, bool gui_scope)
Mark window data of all windows of a given class as invalid (in need of re-computing) Note that by de...
Definition: window.cpp:3235
Vehicle::NextShared
Vehicle * NextShared() const
Get the next vehicle of the shared vehicle chain.
Definition: vehicle_base.h:676
GroupIsInGroup
bool GroupIsInGroup(GroupID search, GroupID group)
Test if GroupID group is a descendant of (or is) GroupID search.
Definition: group_cmd.cpp:868
WC_VEHICLE_DEPOT
@ WC_VEHICLE_DEPOT
Depot view; Window numbers:
Definition: window_type.h:343
Vehicle::age
Date age
Age in days.
Definition: vehicle_base.h:270
Pool::PoolItem<&_group_pool >::CanAllocateItem
static bool CanAllocateItem(size_t n=1)
Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function()
Definition: pool_type.hpp:307
OrderBackup::ClearGroup
static void ClearGroup(GroupID group)
Clear the group of all backups having this group ID.
Definition: order_backup.cpp:214
Group::name
std::string name
Group Name.
Definition: group.h:73
company_func.h
INSTANTIATE_POOL_METHODS
#define INSTANTIATE_POOL_METHODS(name)
Force instantiation of pool methods so we don't get linker errors.
Definition: pool_func.hpp:224
GroupStatistics::Clear
void Clear()
Clear all caches.
Definition: group_cmd.cpp:45
SetBit
static T SetBit(T &x, const uint8 y)
Set a bit in a variable.
Definition: bitmath_func.hpp:121
MarkWholeScreenDirty
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition: gfx.cpp:1689
OverflowSafeInt< int64 >
CloseWindowById
void CloseWindowById(WindowClass cls, WindowNumber number, bool force)
Close a window by its class and window number (if it is open).
Definition: window.cpp:1176
Group::folded
bool folded
NOSAVE: Is this group folded in the group view?
Definition: group.h:81
CmdRemoveAllVehiclesGroup
CommandCost CmdRemoveAllVehiclesGroup(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
Remove all vehicles from a group.
Definition: group_cmd.cpp:605
GroundVehicle::IsFreeWagon
bool IsFreeWagon() const
Check if the vehicle is a free wagon (got no engine in front of it).
Definition: ground_vehicle.hpp:310
VEH_TRAIN
@ VEH_TRAIN
Train vehicle type.
Definition: vehicle_type.h:24
Pool::PoolItem<&_group_pool >::IsValidID
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
Definition: pool_type.hpp:326
BaseVehicle::type
VehicleType type
Type of vehicle.
Definition: vehicle_type.h:52
CompanyProperties::engine_renew_list
EngineRenewList engine_renew_list
Engine renewals of this company.
Definition: company_base.h:103
autoreplace_func.h
pool_func.hpp
order_backup.h
free
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
Definition: stdafx.h:460
GF_REPLACE_WAGON_REMOVAL
@ GF_REPLACE_WAGON_REMOVAL
If set, autoreplace will perform wagon removal on vehicles in this group.
Definition: group.h:67
VEH_SHIP
@ VEH_SHIP
Ship vehicle type.
Definition: vehicle_type.h:26
Company
Definition: company_base.h:115
AddVehicleToGroup
static void AddVehicleToGroup(Vehicle *v, GroupID new_g)
Do add a vehicle to a group.
Definition: group_cmd.cpp:473
Livery
Information about a particular livery.
Definition: livery.h:78
Vehicle::GetDisplayProfitLastYear
Money GetDisplayProfitLastYear() const
Gets the profit vehicle had last year.
Definition: vehicle_base.h:585
Engine::type
VehicleType type
Vehicle type, ie VEH_ROAD, VEH_TRAIN, etc.
Definition: engine_base.h:46
GroupStatistics::UpdateAfterLoad
static void UpdateAfterLoad()
Update all caches after loading a game, changing NewGRF, etc.
Definition: group_cmd.cpp:101
VEHICLE_PROFIT_MIN_AGE
static const int VEHICLE_PROFIT_MIN_AGE
Only vehicles older than this have a meaningful profit.
Definition: vehicle_func.h:27
GroupStatistics::num_profit_vehicle
uint16 num_profit_vehicle
Number of vehicles considered for profit statistics;.
Definition: group.h:32
Livery::colour2
byte colour2
Second colour, for vehicles with 2CC support.
Definition: livery.h:81
Livery::colour1
byte colour1
First colour, for all vehicles.
Definition: livery.h:80