rubidium@7139: /* $Id$ */ rubidium@7139: rubidium@7139: /** @file group_cmd.cpp Handling of the engine groups */ rubidium@7139: rubidium@7139: #include "stdafx.h" rubidium@7139: #include "openttd.h" peter1138@7593: #include "variables.h" rubidium@8612: #include "command_func.h" rubidium@7139: #include "saveload.h" rubidium@7139: #include "debug.h" rubidium@7139: #include "group.h" rubidium@7139: #include "train.h" rubidium@7139: #include "aircraft.h" peter1138@7163: #include "vehicle_gui.h" rubidium@7878: #include "misc/autoptr.hpp" rubidium@8610: #include "strings_func.h" rubidium@8627: #include "functions.h" rubidium@8627: #include "window_func.h" rubidium@8640: #include "vehicle_func.h" rubidium@8708: #include "autoreplace_base.h" rubidium@8708: #include "autoreplace_func.h" rubidium@8710: #include "string_func.h" rubidium@8750: #include "player_func.h" rubidium@9280: #include "order_func.h" smatz@9343: #include "oldpool_func.h" rubidium@7139: rubidium@8760: #include "table/strings.h" rubidium@8760: rubidium@7139: /** rubidium@7139: * Update the num engines of a groupID. Decrease the old one and increase the new one rubidium@7139: * @note called in SetTrainGroupID and UpdateTrainGroupID rubidium@7139: * @param i EngineID we have to update rubidium@7139: * @param old_g index of the old group rubidium@7139: * @param new_g index of the new group rubidium@7139: */ rubidium@7139: static inline void UpdateNumEngineGroup(EngineID i, GroupID old_g, GroupID new_g) rubidium@7139: { rubidium@7139: if (old_g != new_g) { rubidium@7139: /* Decrease the num engines of EngineID i of the old group if it's not the default one */ rubidium@7139: if (!IsDefaultGroupID(old_g) && IsValidGroupID(old_g)) GetGroup(old_g)->num_engines[i]--; rubidium@7139: rubidium@7139: /* Increase the num engines of EngineID i of the new group if it's not the new one */ rubidium@7139: if (!IsDefaultGroupID(new_g) && IsValidGroupID(new_g)) GetGroup(new_g)->num_engines[i]++; rubidium@7139: } rubidium@7139: } rubidium@7139: rubidium@7139: rubidium@7878: DEFINE_OLD_POOL_GENERIC(Group, Group) rubidium@7878: rubidium@7878: peter1138@8749: Group::Group(PlayerID owner) rubidium@7139: { peter1138@8749: this->owner = owner; rubidium@7139: } rubidium@7139: rubidium@7878: Group::~Group() rubidium@7139: { peter1138@8754: free(this->name); peter1138@8749: this->owner = INVALID_PLAYER; rubidium@7878: } rubidium@7139: rubidium@7878: bool Group::IsValid() const rubidium@7878: { peter1138@8749: return this->owner != INVALID_PLAYER; rubidium@7139: } rubidium@7139: rubidium@7139: void InitializeGroup(void) rubidium@7139: { rubidium@7878: _Group_pool.CleanPool(); rubidium@7878: _Group_pool.AddBlockToPool(); rubidium@7139: } rubidium@7139: rubidium@7139: peter1138@7163: static WindowClass GetWCForVT(VehicleType vt) peter1138@7163: { peter1138@7163: switch (vt) { peter1138@7163: default: peter1138@7163: case VEH_TRAIN: return WC_TRAINS_LIST; peter1138@7163: case VEH_ROAD: return WC_ROADVEH_LIST; peter1138@7163: case VEH_SHIP: return WC_SHIPS_LIST; peter1138@7163: case VEH_AIRCRAFT: return WC_AIRCRAFT_LIST; peter1138@7163: } peter1138@7163: } peter1138@7163: peter1138@7163: rubidium@7139: /** rubidium@7693: * Create a new vehicle group. rubidium@7139: * @param tile unused rubidium@7139: * @param p1 vehicle type rubidium@7139: * @param p2 unused rubidium@7139: */ rubidium@7439: CommandCost CmdCreateGroup(TileIndex tile, uint32 flags, uint32 p1, uint32 p2) rubidium@7139: { rubidium@7139: VehicleType vt = (VehicleType)p1; rubidium@7139: if (!IsPlayerBuildableVehicleType(vt)) return CMD_ERROR; rubidium@7139: rubidium@7878: AutoPtrT g_auto_delete; rubidium@7878: peter1138@8749: Group *g = new Group(_current_player); rubidium@7139: if (g == NULL) return CMD_ERROR; rubidium@7139: rubidium@7878: g_auto_delete = g; rubidium@7878: rubidium@7139: if (flags & DC_EXEC) { rubidium@7139: g->replace_protection = false; rubidium@7139: g->vehicle_type = vt; peter1138@7163: peter1138@7163: InvalidateWindowData(GetWCForVT(vt), (vt << 11) | VLW_GROUP_LIST | _current_player); rubidium@7878: rubidium@7878: g_auto_delete.Detach(); rubidium@7139: } rubidium@7139: rubidium@7446: return CommandCost(); rubidium@7139: } rubidium@7139: rubidium@7139: rubidium@7139: /** rubidium@7693: * Add all vehicles in the given group to the default group and then deletes the group. rubidium@7139: * @param tile unused rubidium@7139: * @param p1 index of array group rubidium@7139: * - p1 bit 0-15 : GroupID rubidium@7139: * @param p2 unused rubidium@7139: */ rubidium@7439: CommandCost CmdDeleteGroup(TileIndex tile, uint32 flags, uint32 p1, uint32 p2) rubidium@7139: { rubidium@7139: if (!IsValidGroupID(p1)) return CMD_ERROR; rubidium@7139: rubidium@7139: Group *g = GetGroup(p1); rubidium@7139: if (g->owner != _current_player) return CMD_ERROR; rubidium@7139: rubidium@7139: if (flags & DC_EXEC) { rubidium@7139: Vehicle *v; rubidium@7139: rubidium@7139: /* Add all vehicles belong to the group to the default group */ rubidium@7139: FOR_ALL_VEHICLES(v) { rubidium@7139: if (v->group_id == g->index && v->type == g->vehicle_type) v->group_id = DEFAULT_GROUP; rubidium@7139: } rubidium@7139: glx@9146: /* Update backupped orders if needed */ glx@9146: if (_backup_orders_data.group == g->index) _backup_orders_data.group = DEFAULT_GROUP; glx@9146: rubidium@7139: /* If we set an autoreplace for the group we delete, remove it. */ rubidium@7139: if (_current_player < MAX_PLAYERS) { rubidium@7139: Player *p; rubidium@7139: EngineRenew *er; rubidium@7139: rubidium@7139: p = GetPlayer(_current_player); rubidium@7139: FOR_ALL_ENGINE_RENEWS(er) { rubidium@7139: if (er->group_id == g->index) RemoveEngineReplacementForPlayer(p, er->from, g->index, flags); rubidium@7139: } rubidium@7139: } rubidium@7139: peter1138@7163: VehicleType vt = g->vehicle_type; peter1138@7163: rubidium@7139: /* Delete the Replace Vehicle Windows */ rubidium@7139: DeleteWindowById(WC_REPLACE_VEHICLE, g->vehicle_type); rubidium@7878: delete g; peter1138@7163: peter1138@7163: InvalidateWindowData(GetWCForVT(vt), (vt << 11) | VLW_GROUP_LIST | _current_player); rubidium@7139: } rubidium@7139: rubidium@7446: return CommandCost(); rubidium@7139: } rubidium@7139: peter1138@7593: static bool IsUniqueGroupName(const char *name) peter1138@7593: { peter1138@7593: const Group *g; peter1138@7593: char buf[512]; peter1138@7593: peter1138@7593: FOR_ALL_GROUPS(g) { peter1138@7593: SetDParam(0, g->index); peter1138@7593: GetString(buf, STR_GROUP_NAME, lastof(buf)); peter1138@7593: if (strcmp(buf, name) == 0) return false; peter1138@7593: } peter1138@7593: peter1138@7593: return true; peter1138@7593: } rubidium@7139: rubidium@7139: /** rubidium@7139: * Rename a group rubidium@7139: * @param tile unused rubidium@7139: * @param p1 index of array group rubidium@7139: * - p1 bit 0-15 : GroupID rubidium@7139: * @param p2 unused rubidium@7139: */ rubidium@7439: CommandCost CmdRenameGroup(TileIndex tile, uint32 flags, uint32 p1, uint32 p2) rubidium@7139: { rubidium@7139: if (!IsValidGroupID(p1) || StrEmpty(_cmd_text)) return CMD_ERROR; rubidium@7139: peter1138@7163: Group *g = GetGroup(p1); peter1138@7163: if (g->owner != _current_player) return CMD_ERROR; peter1138@7163: peter1138@7593: if (!IsUniqueGroupName(_cmd_text)) return_cmd_error(STR_NAME_MUST_BE_UNIQUE); peter1138@7593: rubidium@7139: if (flags & DC_EXEC) { rubidium@7139: /* Delete the old name */ peter1138@8754: free(g->name); rubidium@7139: /* Assign the new one */ peter1138@8754: g->name = strdup(_cmd_text); peter1138@7163: peter1138@7163: InvalidateWindowData(GetWCForVT(g->vehicle_type), (g->vehicle_type << 11) | VLW_GROUP_LIST | _current_player); rubidium@7139: } rubidium@7139: rubidium@7446: return CommandCost(); rubidium@7139: } rubidium@7139: rubidium@7139: rubidium@7139: /** rubidium@7139: * Add a vehicle to a group rubidium@7139: * @param tile unused rubidium@7139: * @param p1 index of array group rubidium@7139: * - p1 bit 0-15 : GroupID rubidium@7139: * @param p2 vehicle to add to a group rubidium@7139: * - p2 bit 0-15 : VehicleID rubidium@7139: */ rubidium@7439: CommandCost CmdAddVehicleGroup(TileIndex tile, uint32 flags, uint32 p1, uint32 p2) rubidium@7139: { rubidium@7139: GroupID new_g = p1; rubidium@7139: rubidium@7147: if (!IsValidVehicleID(p2) || (!IsValidGroupID(new_g) && !IsDefaultGroupID(new_g))) return CMD_ERROR; rubidium@7139: rubidium@8000: Vehicle *v = GetVehicle(p2); rubidium@8000: peter1138@7167: if (IsValidGroupID(new_g)) { peter1138@7167: Group *g = GetGroup(new_g); rubidium@8000: if (g->owner != _current_player || g->vehicle_type != v->type) return CMD_ERROR; peter1138@7167: } peter1138@7163: maedhros@7269: if (v->owner != _current_player || !v->IsPrimaryVehicle()) return CMD_ERROR; rubidium@7139: rubidium@7139: if (flags & DC_EXEC) { rubidium@7139: DecreaseGroupNumVehicle(v->group_id); rubidium@7139: IncreaseGroupNumVehicle(new_g); rubidium@7139: rubidium@7139: switch (v->type) { rubidium@7139: default: NOT_REACHED(); rubidium@7139: case VEH_TRAIN: rubidium@7139: SetTrainGroupID(v, new_g); rubidium@7139: break; rubidium@7139: case VEH_ROAD: rubidium@7139: case VEH_SHIP: rubidium@7139: case VEH_AIRCRAFT: rubidium@7139: if (IsEngineCountable(v)) UpdateNumEngineGroup(v->engine_type, v->group_id, new_g); rubidium@7139: v->group_id = new_g; rubidium@7139: break; rubidium@7139: } rubidium@7139: rubidium@7139: /* Update the Replace Vehicle Windows */ rubidium@7139: InvalidateWindow(WC_REPLACE_VEHICLE, v->type); peter1138@7163: InvalidateWindowData(GetWCForVT(v->type), (v->type << 11) | VLW_GROUP_LIST | _current_player); rubidium@7139: } rubidium@7139: rubidium@7446: return CommandCost(); rubidium@7139: } rubidium@7139: rubidium@7139: /** rubidium@7139: * Add all shared vehicles of all vehicles from a group rubidium@7139: * @param tile unused rubidium@7139: * @param p1 index of group array rubidium@7139: * - p1 bit 0-15 : GroupID rubidium@7139: * @param p2 type of vehicles rubidium@7139: */ rubidium@7439: CommandCost CmdAddSharedVehicleGroup(TileIndex tile, uint32 flags, uint32 p1, uint32 p2) rubidium@7139: { rubidium@7139: VehicleType type = (VehicleType)p2; rubidium@7139: if (!IsValidGroupID(p1) || !IsPlayerBuildableVehicleType(type)) return CMD_ERROR; rubidium@7139: rubidium@7139: if (flags & DC_EXEC) { rubidium@7139: Vehicle *v; rubidium@7139: VehicleType type = (VehicleType)p2; rubidium@7139: GroupID id_g = p1; rubidium@7139: rubidium@7139: /* Find the first front engine which belong to the group id_g rubidium@7139: * then add all shared vehicles of this front engine to the group id_g */ rubidium@7139: FOR_ALL_VEHICLES(v) { maedhros@7269: if (v->type == type && v->IsPrimaryVehicle()) { rubidium@7139: if (v->group_id != id_g) continue; rubidium@7139: rubidium@7139: /* For each shared vehicles add it to the group */ rubidium@7139: for (Vehicle *v2 = GetFirstVehicleFromSharedList(v); v2 != NULL; v2 = v2->next_shared) { rubidium@7139: if (v2->group_id != id_g) CmdAddVehicleGroup(tile, flags, id_g, v2->index); rubidium@7139: } rubidium@7139: } rubidium@7139: } peter1138@7163: peter1138@7163: InvalidateWindowData(GetWCForVT(type), (type << 11) | VLW_GROUP_LIST | _current_player); rubidium@7139: } rubidium@7139: rubidium@7446: return CommandCost(); rubidium@7139: } rubidium@7139: rubidium@7139: rubidium@7139: /** rubidium@7139: * Remove all vehicles from a group rubidium@7139: * @param tile unused rubidium@7139: * @param p1 index of group array rubidium@7139: * - p1 bit 0-15 : GroupID rubidium@7139: * @param p2 type of vehicles rubidium@7139: */ rubidium@7439: CommandCost CmdRemoveAllVehiclesGroup(TileIndex tile, uint32 flags, uint32 p1, uint32 p2) rubidium@7139: { rubidium@7139: VehicleType type = (VehicleType)p2; rubidium@7139: if (!IsValidGroupID(p1) || !IsPlayerBuildableVehicleType(type)) return CMD_ERROR; rubidium@7139: peter1138@7163: Group *g = GetGroup(p1); peter1138@7163: if (g->owner != _current_player) return CMD_ERROR; peter1138@7163: rubidium@7139: if (flags & DC_EXEC) { rubidium@7139: GroupID old_g = p1; rubidium@7139: Vehicle *v; rubidium@7139: rubidium@7139: /* Find each Vehicle that belongs to the group old_g and add it to the default group */ rubidium@7139: FOR_ALL_VEHICLES(v) { maedhros@7269: if (v->type == type && v->IsPrimaryVehicle()) { rubidium@7139: if (v->group_id != old_g) continue; rubidium@7139: rubidium@7139: /* Add The Vehicle to the default group */ rubidium@7139: CmdAddVehicleGroup(tile, flags, DEFAULT_GROUP, v->index); rubidium@7139: } rubidium@7139: } peter1138@7163: peter1138@7163: InvalidateWindowData(GetWCForVT(type), (type << 11) | VLW_GROUP_LIST | _current_player); peter1138@7163: } peter1138@7163: rubidium@7446: return CommandCost(); peter1138@7163: } peter1138@7163: peter1138@7163: peter1138@7163: /** peter1138@7163: * (Un)set global replace protection from a group peter1138@7163: * @param tile unused peter1138@7163: * @param p1 index of group array peter1138@7163: * - p1 bit 0-15 : GroupID peter1138@7163: * @param p2 peter1138@7163: * - p2 bit 0 : 1 to set or 0 to clear protection. peter1138@7163: */ rubidium@7439: CommandCost CmdSetGroupReplaceProtection(TileIndex tile, uint32 flags, uint32 p1, uint32 p2) peter1138@7163: { peter1138@7163: if (!IsValidGroupID(p1)) return CMD_ERROR; peter1138@7163: peter1138@7163: Group *g = GetGroup(p1); peter1138@7163: if (g->owner != _current_player) return CMD_ERROR; peter1138@7163: peter1138@7163: if (flags & DC_EXEC) { skidd13@8424: g->replace_protection = HasBit(p2, 0); peter1138@7163: peter1138@7163: InvalidateWindowData(GetWCForVT(g->vehicle_type), (g->vehicle_type << 11) | VLW_GROUP_LIST | _current_player); rubidium@7139: } rubidium@7139: rubidium@7446: return CommandCost(); rubidium@7139: } rubidium@7139: rubidium@7139: /** rubidium@7139: * Decrease the num_vehicle variable before delete an front engine from a group rubidium@7139: * @note Called in CmdSellRailWagon and DeleteLasWagon, rubidium@7139: * @param v FrontEngine of the train we want to remove. rubidium@7139: */ rubidium@7139: void RemoveVehicleFromGroup(const Vehicle *v) rubidium@7139: { rubidium@8044: if (!v->IsValid() || !v->IsPrimaryVehicle()) return; rubidium@7139: rubidium@7139: if (!IsDefaultGroupID(v->group_id)) DecreaseGroupNumVehicle(v->group_id); rubidium@7139: } rubidium@7139: rubidium@7139: rubidium@7139: /** rubidium@7139: * Affect the groupID of a train to new_g. rubidium@7139: * @note called in CmdAddVehicleGroup and CmdMoveRailVehicle rubidium@7139: * @param v First vehicle of the chain. rubidium@7139: * @param new_g index of array group rubidium@7139: */ rubidium@7139: void SetTrainGroupID(Vehicle *v, GroupID new_g) rubidium@7139: { rubidium@7139: if (!IsValidGroupID(new_g) && !IsDefaultGroupID(new_g)) return; rubidium@7139: rubidium@7883: assert(v->IsValid() && v->type == VEH_TRAIN && IsFrontEngine(v)); rubidium@7139: rubidium@7988: for (Vehicle *u = v; u != NULL; u = u->Next()) { rubidium@7139: if (IsEngineCountable(u)) UpdateNumEngineGroup(u->engine_type, u->group_id, new_g); rubidium@7139: rubidium@7139: u->group_id = new_g; rubidium@7139: } rubidium@7139: rubidium@7139: /* Update the Replace Vehicle Windows */ rubidium@7139: InvalidateWindow(WC_REPLACE_VEHICLE, VEH_TRAIN); rubidium@7139: } rubidium@7139: rubidium@7139: rubidium@7139: /** rubidium@7139: * Recalculates the groupID of a train. Should be called each time a vehicle is added rubidium@7139: * to/removed from the chain,. rubidium@7139: * @note this needs to be called too for 'wagon chains' (in the depot, without an engine) rubidium@7139: * @note Called in CmdBuildRailVehicle, CmdBuildRailWagon, CmdMoveRailVehicle, CmdSellRailWagon rubidium@7139: * @param v First vehicle of the chain. rubidium@7139: */ rubidium@7139: void UpdateTrainGroupID(Vehicle *v) rubidium@7139: { rubidium@7883: assert(v->IsValid() && v->type == VEH_TRAIN && (IsFrontEngine(v) || IsFreeWagon(v))); rubidium@7139: rubidium@7139: GroupID new_g = IsFrontEngine(v) ? v->group_id : (GroupID)DEFAULT_GROUP; rubidium@7988: for (Vehicle *u = v; u != NULL; u = u->Next()) { rubidium@7139: if (IsEngineCountable(u)) UpdateNumEngineGroup(u->engine_type, u->group_id, new_g); rubidium@7139: rubidium@7139: u->group_id = new_g; rubidium@7139: } rubidium@7139: rubidium@7139: /* Update the Replace Vehicle Windows */ rubidium@7139: InvalidateWindow(WC_REPLACE_VEHICLE, VEH_TRAIN); rubidium@7139: } rubidium@7139: rubidium@8733: uint GetGroupNumEngines(PlayerID p, GroupID id_g, EngineID id_e) rubidium@8733: { rubidium@8733: if (IsValidGroupID(id_g)) return GetGroup(id_g)->num_engines[id_e]; rubidium@7139: rubidium@8733: uint num = GetPlayer(p)->num_engines[id_e]; rubidium@8733: if (!IsDefaultGroupID(id_g)) return num; rubidium@8733: rubidium@8733: const Group *g; rubidium@8733: FOR_ALL_GROUPS(g) { rubidium@8733: if (g->owner == p) num -= g->num_engines[id_e]; rubidium@8733: } rubidium@8733: return num; rubidium@8733: } rubidium@8733: rubidium@8733: void RemoveAllGroupsForPlayer(const PlayerID p) rubidium@7139: { rubidium@7139: Group *g; rubidium@7139: rubidium@7139: FOR_ALL_GROUPS(g) { rubidium@8733: if (p == g->owner) delete g; rubidium@7139: } rubidium@7139: } rubidium@7139: rubidium@7139: rubidium@7139: static const SaveLoad _group_desc[] = { peter1138@8754: SLE_CONDVAR(Group, name, SLE_NAME, 0, 83), peter1138@8754: SLE_CONDSTR(Group, name, SLE_STR, 0, 84, SL_MAX_VERSION), rubidium@7139: SLE_VAR(Group, num_vehicle, SLE_UINT16), rubidium@7139: SLE_VAR(Group, owner, SLE_UINT8), rubidium@7139: SLE_VAR(Group, vehicle_type, SLE_UINT8), rubidium@7139: SLE_VAR(Group, replace_protection, SLE_BOOL), rubidium@7139: SLE_END() rubidium@7139: }; rubidium@7139: rubidium@7139: rubidium@7139: static void Save_GROUP(void) rubidium@7139: { rubidium@7139: Group *g; rubidium@7139: rubidium@7139: FOR_ALL_GROUPS(g) { rubidium@7139: SlSetArrayIndex(g->index); rubidium@7139: SlObject(g, _group_desc); rubidium@7139: } rubidium@7139: } rubidium@7139: rubidium@7139: rubidium@7139: static void Load_GROUP(void) rubidium@7139: { rubidium@7139: int index; rubidium@7139: rubidium@7139: while ((index = SlIterateArray()) != -1) { rubidium@7878: Group *g = new (index) Group(); rubidium@7139: SlObject(g, _group_desc); rubidium@7139: } rubidium@7139: } rubidium@7139: rubidium@7139: extern const ChunkHandler _group_chunk_handlers[] = { rubidium@7139: { 'GRPS', Save_GROUP, Load_GROUP, CH_ARRAY | CH_LAST}, rubidium@7139: };