src/script/api/script_vehicle.cpp

   1 /* $Id$ */
   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
  10 /** @file script_vehicle.cpp Implementation of ScriptVehicle. */
  11
  12 #include "../../stdafx.h"
  13 #include "script_engine.hpp"
  14 #include "script_cargo.hpp"
  15 #include "script_gamesettings.hpp"
  16 #include "script_group.hpp"
  17 #include "../script_instance.hpp"
  18 #include "../../string_func.h"
  19 #include "../../strings_func.h"
  20 #include "../../command_func.h"
  21 #include "../../roadveh.h"
  22 #include "../../train.h"
  23 #include "../../vehicle_func.h"
  24 #include "../../aircraft.h"
  25 #include "table/strings.h"
  26
  27 #include "../../safeguards.h"
  28
  29 /* static */ bool ScriptVehicle::IsValidVehicle(VehicleID vehicle_id)
  30 {
  31         const Vehicle *v = ::Vehicle::GetIfValid(vehicle_id);
  32         return v != NULL && (v->owner == ScriptObject::GetCompany() || ScriptObject::GetCompany() == OWNER_DEITY) && (v->IsPrimaryVehicle() || (v->type == VEH_TRAIN && ::Train::From(v)->IsFreeWagon()));
  33 }
  34
  35 /* static */ ScriptCompany::CompanyID ScriptVehicle::GetOwner(VehicleID vehicle_id)
  36 {
  37         if (!IsValidVehicle(vehicle_id)) return ScriptCompany::COMPANY_INVALID;
  38
  39         return static_cast<ScriptCompany::CompanyID>((int)::Vehicle::Get(vehicle_id)->owner);
  40 }
  41
  42 /* static */ int32 ScriptVehicle::GetNumWagons(VehicleID vehicle_id)
  43 {
  44         if (!IsValidVehicle(vehicle_id)) return -1;
  45
  46         int num = 1;
  47
  48         const Train *v = ::Train::GetIfValid(vehicle_id);
  49         if (v != NULL) {
  50                 while ((v = v->GetNextUnit()) != NULL) num++;
  51         }
  52
  53         return num;
  54 }
  55
  56 /* static */ int ScriptVehicle::GetLength(VehicleID vehicle_id)
  57 {
  58         if (!IsValidVehicle(vehicle_id)) return -1;
  59
  60         const Vehicle *v = ::Vehicle::Get(vehicle_id);
  61         return v->IsGroundVehicle() ? v->GetGroundVehicleCache()->cached_total_length : -1;
  62 }
  63
  64 /* static */ VehicleID ScriptVehicle::BuildVehicle(TileIndex depot, EngineID engine_id)
  65 {
  66         EnforcePrecondition(false, ScriptObject::GetCompany() != OWNER_DEITY);
  67         EnforcePrecondition(VEHICLE_INVALID, ScriptEngine::IsBuildable(engine_id));
  68
  69         ::VehicleType type = ::Engine::Get(engine_id)->type;
  70
  71         EnforcePreconditionCustomError(VEHICLE_INVALID, !ScriptGameSettings::IsDisabledVehicleType((ScriptVehicle::VehicleType)type), ScriptVehicle::ERR_VEHICLE_BUILD_DISABLED);
  72
  73         if (!ScriptObject::DoCommand(depot, engine_id, 0, ::GetCmdBuildVeh(type), NULL, &ScriptInstance::DoCommandReturnVehicleID)) return VEHICLE_INVALID;
  74
  75         /* In case of test-mode, we return VehicleID 0 */
  76         return 0;
  77 }
  78
  79 /* static */ VehicleID ScriptVehicle::CloneVehicle(TileIndex depot, VehicleID vehicle_id, bool share_orders)
  80 {
  81         EnforcePrecondition(false, ScriptObject::GetCompany() != OWNER_DEITY);
  82         EnforcePrecondition(false, IsValidVehicle(vehicle_id));
  83
  84         if (!ScriptObject::DoCommand(depot, vehicle_id, share_orders, CMD_CLONE_VEHICLE, NULL, &ScriptInstance::DoCommandReturnVehicleID)) return VEHICLE_INVALID;
  85
  86         /* In case of test-mode, we return VehicleID 0 */
  87         return 0;
  88 }
  89
  90 /* static */ bool ScriptVehicle::_MoveWagonInternal(VehicleID source_vehicle_id, int source_wagon, bool move_attached_wagons, int dest_vehicle_id, int dest_wagon)
  91 {
  92         EnforcePrecondition(false, ScriptObject::GetCompany() != OWNER_DEITY);
  93         EnforcePrecondition(false, IsValidVehicle(source_vehicle_id) && source_wagon < GetNumWagons(source_vehicle_id));
  94         EnforcePrecondition(false, dest_vehicle_id == -1 || (IsValidVehicle(dest_vehicle_id) && dest_wagon < GetNumWagons(dest_vehicle_id)));
  95         EnforcePrecondition(false, ::Vehicle::Get(source_vehicle_id)->type == VEH_TRAIN);
  96         EnforcePrecondition(false, dest_vehicle_id == -1 || ::Vehicle::Get(dest_vehicle_id)->type == VEH_TRAIN);
  97
  98         const Train *v = ::Train::Get(source_vehicle_id);
  99         while (source_wagon-- > 0) v = v->GetNextUnit();
 100         const Train *w = NULL;
 101         if (dest_vehicle_id != -1) {
 102                 w = ::Train::Get(dest_vehicle_id);
 103                 while (dest_wagon-- > 0) w = w->GetNextUnit();
 104         }
 105
 106         return ScriptObject::DoCommand(0, v->index | (move_attached_wagons ? 1 : 0) << 20, w == NULL ? ::INVALID_VEHICLE : w->index, CMD_MOVE_RAIL_VEHICLE);
 107 }
 108
 109 /* static */ bool ScriptVehicle::MoveWagon(VehicleID source_vehicle_id, int source_wagon, int dest_vehicle_id, int dest_wagon)
 110 {
 111         return _MoveWagonInternal(source_vehicle_id, source_wagon, false, dest_vehicle_id, dest_wagon);
 112 }
 113
 114 /* static */ bool ScriptVehicle::MoveWagonChain(VehicleID source_vehicle_id, int source_wagon, int dest_vehicle_id, int dest_wagon)
 115 {
 116         return _MoveWagonInternal(source_vehicle_id, source_wagon, true, dest_vehicle_id, dest_wagon);
 117 }
 118
 119 /* static */ int ScriptVehicle::GetRefitCapacity(VehicleID vehicle_id, CargoID cargo)
 120 {
 121         if (!IsValidVehicle(vehicle_id)) return -1;
 122         if (!ScriptCargo::IsValidCargo(cargo)) return -1;
 123
 124         CommandCost res = ::DoCommand(0, vehicle_id, cargo, DC_QUERY_COST, GetCmdRefitVeh(::Vehicle::Get(vehicle_id)));
 125         return res.Succeeded() ? _returned_refit_capacity : -1;
 126 }
 127
 128 /* static */ bool ScriptVehicle::RefitVehicle(VehicleID vehicle_id, CargoID cargo)
 129 {
 130         EnforcePrecondition(false, ScriptObject::GetCompany() != OWNER_DEITY);
 131         EnforcePrecondition(false, IsValidVehicle(vehicle_id) && ScriptCargo::IsValidCargo(cargo));
 132
 133         return ScriptObject::DoCommand(0, vehicle_id, cargo, GetCmdRefitVeh(::Vehicle::Get(vehicle_id)));
 134 }
 135
 136
 137 /* static */ bool ScriptVehicle::SellVehicle(VehicleID vehicle_id)
 138 {
 139         EnforcePrecondition(false, ScriptObject::GetCompany() != OWNER_DEITY);
 140         EnforcePrecondition(false, IsValidVehicle(vehicle_id));
 141
 142         const Vehicle *v = ::Vehicle::Get(vehicle_id);
 143         return ScriptObject::DoCommand(0, vehicle_id | (v->type == VEH_TRAIN ? 1 : 0) << 20, 0, GetCmdSellVeh(v));
 144 }
 145
 146 /* static */ bool ScriptVehicle::_SellWagonInternal(VehicleID vehicle_id, int wagon, bool sell_attached_wagons)
 147 {
 148         EnforcePrecondition(false, ScriptObject::GetCompany() != OWNER_DEITY);
 149         EnforcePrecondition(false, IsValidVehicle(vehicle_id) && wagon < GetNumWagons(vehicle_id));
 150         EnforcePrecondition(false, ::Vehicle::Get(vehicle_id)->type == VEH_TRAIN);
 151
 152         const Train *v = ::Train::Get(vehicle_id);
 153         while (wagon-- > 0) v = v->GetNextUnit();
 154
 155         return ScriptObject::DoCommand(0, v->index | (sell_attached_wagons ? 1 : 0) << 20, 0, CMD_SELL_VEHICLE);
 156 }
 157
 158 /* static */ bool ScriptVehicle::SellWagon(VehicleID vehicle_id, int wagon)
 159 {
 160         return _SellWagonInternal(vehicle_id, wagon, false);
 161 }
 162
 163 /* static */ bool ScriptVehicle::SellWagonChain(VehicleID vehicle_id, int wagon)
 164 {
 165         return _SellWagonInternal(vehicle_id, wagon, true);
 166 }
 167
 168 /* static */ bool ScriptVehicle::SendVehicleToDepot(VehicleID vehicle_id)
 169 {
 170         EnforcePrecondition(false, ScriptObject::GetCompany() != OWNER_DEITY);
 171         EnforcePrecondition(false, IsValidVehicle(vehicle_id));
 172
 173         return ScriptObject::DoCommand(0, vehicle_id, 0, GetCmdSendToDepot(::Vehicle::Get(vehicle_id)));
 174 }
 175
 176 /* static */ bool ScriptVehicle::SendVehicleToDepotForServicing(VehicleID vehicle_id)
 177 {
 178         EnforcePrecondition(false, ScriptObject::GetCompany() != OWNER_DEITY);
 179         EnforcePrecondition(false, IsValidVehicle(vehicle_id));
 180
 181         return ScriptObject::DoCommand(0, vehicle_id | DEPOT_SERVICE, 0, GetCmdSendToDepot(::Vehicle::Get(vehicle_id)));
 182 }
 183
 184 /* static */ bool ScriptVehicle::IsInDepot(VehicleID vehicle_id)
 185 {
 186         if (!IsValidVehicle(vehicle_id)) return false;
 187         return ::Vehicle::Get(vehicle_id)->IsChainInDepot();
 188 }
 189
 190 /* static */ bool ScriptVehicle::IsStoppedInDepot(VehicleID vehicle_id)
 191 {
 192         if (!IsValidVehicle(vehicle_id)) return false;
 193         return ::Vehicle::Get(vehicle_id)->IsStoppedInDepot();
 194 }
 195
 196 /* static */ bool ScriptVehicle::StartStopVehicle(VehicleID vehicle_id)
 197 {
 198         EnforcePrecondition(false, ScriptObject::GetCompany() != OWNER_DEITY);
 199         EnforcePrecondition(false, IsValidVehicle(vehicle_id));
 200
 201         return ScriptObject::DoCommand(0, vehicle_id, 0, CMD_START_STOP_VEHICLE);
 202 }
 203
 204 /* static */ bool ScriptVehicle::ReverseVehicle(VehicleID vehicle_id)
 205 {
 206         EnforcePrecondition(false, ScriptObject::GetCompany() != OWNER_DEITY);
 207         EnforcePrecondition(false, IsValidVehicle(vehicle_id));
 208         EnforcePrecondition(false, ::Vehicle::Get(vehicle_id)->type == VEH_ROAD || ::Vehicle::Get(vehicle_id)->type == VEH_TRAIN);
 209
 210         switch (::Vehicle::Get(vehicle_id)->type) {
 211                 case VEH_ROAD: return ScriptObject::DoCommand(0, vehicle_id, 0, CMD_TURN_ROADVEH);
 212                 case VEH_TRAIN: return ScriptObject::DoCommand(0, vehicle_id, 0, CMD_REVERSE_TRAIN_DIRECTION);
 213                 default: NOT_REACHED();
 214         }
 215 }
 216
 217 /* static */ bool ScriptVehicle::SetName(VehicleID vehicle_id, Text *name)
 218 {
 219         CCountedPtr<Text> counter(name);
 220
 221         EnforcePrecondition(false, ScriptObject::GetCompany() != OWNER_DEITY);
 222         EnforcePrecondition(false, IsValidVehicle(vehicle_id));
 223         EnforcePrecondition(false, name != NULL);
 224         const char *text = name->GetDecodedText();
 225         EnforcePreconditionEncodedText(false, text);
 226         EnforcePreconditionCustomError(false, ::Utf8StringLength(text) < MAX_LENGTH_VEHICLE_NAME_CHARS, ScriptError::ERR_PRECONDITION_STRING_TOO_LONG);
 227
 228         return ScriptObject::DoCommand(0, vehicle_id, 0, CMD_RENAME_VEHICLE, text);
 229 }
 230
 231 /* static */ TileIndex ScriptVehicle::GetLocation(VehicleID vehicle_id)
 232 {
 233         if (!IsValidVehicle(vehicle_id)) return INVALID_TILE;
 234
 235         const Vehicle *v = ::Vehicle::Get(vehicle_id);
 236         if (v->type == VEH_AIRCRAFT) {
 237                 uint x = Clamp(v->x_pos / TILE_SIZE, 0, ::MapSizeX() - 2);
 238                 uint y = Clamp(v->y_pos / TILE_SIZE, 0, ::MapSizeY() - 2);
 239                 return ::TileXY(x, y);
 240         }
 241
 242         return v->tile;
 243 }
 244
 245 /* static */ EngineID ScriptVehicle::GetEngineType(VehicleID vehicle_id)
 246 {
 247         if (!IsValidVehicle(vehicle_id)) return INVALID_ENGINE;
 248
 249         return ::Vehicle::Get(vehicle_id)->engine_type;
 250 }
 251
 252 /* static */ EngineID ScriptVehicle::GetWagonEngineType(VehicleID vehicle_id, int wagon)
 253 {
 254         if (!IsValidVehicle(vehicle_id)) return INVALID_ENGINE;
 255         if (wagon >= GetNumWagons(vehicle_id)) return INVALID_ENGINE;
 256
 257         const Vehicle *v = ::Vehicle::Get(vehicle_id);
 258         if (v->type == VEH_TRAIN) {
 259                 while (wagon-- > 0) v = ::Train::From(v)->GetNextUnit();
 260         }
 261         return v->engine_type;
 262 }
 263
 264 /* static */ int32 ScriptVehicle::GetUnitNumber(VehicleID vehicle_id)
 265 {
 266         if (!IsValidVehicle(vehicle_id)) return -1;
 267
 268         return ::Vehicle::Get(vehicle_id)->unitnumber;
 269 }
 270
 271 /* static */ char *ScriptVehicle::GetName(VehicleID vehicle_id)
 272 {
 273         if (!IsValidVehicle(vehicle_id)) return NULL;
 274
 275         ::SetDParam(0, vehicle_id);
 276         return GetString(STR_VEHICLE_NAME);
 277 }
 278
 279 /* static */ int32 ScriptVehicle::GetAge(VehicleID vehicle_id)
 280 {
 281         if (!IsValidVehicle(vehicle_id)) return -1;
 282
 283         return ::Vehicle::Get(vehicle_id)->age;
 284 }
 285
 286 /* static */ int32 ScriptVehicle::GetWagonAge(VehicleID vehicle_id, int wagon)
 287 {
 288         if (!IsValidVehicle(vehicle_id)) return -1;
 289         if (wagon >= GetNumWagons(vehicle_id)) return -1;
 290
 291         const Vehicle *v = ::Vehicle::Get(vehicle_id);
 292         if (v->type == VEH_TRAIN) {
 293                 while (wagon-- > 0) v = ::Train::From(v)->GetNextUnit();
 294         }
 295         return v->age;
 296 }
 297
 298 /* static */ int32 ScriptVehicle::GetMaxAge(VehicleID vehicle_id)
 299 {
 300         if (!IsValidVehicle(vehicle_id)) return -1;
 301
 302         return ::Vehicle::Get(vehicle_id)->max_age;
 303 }
 304
 305 /* static */ int32 ScriptVehicle::GetAgeLeft(VehicleID vehicle_id)
 306 {
 307         if (!IsValidVehicle(vehicle_id)) return -1;
 308
 309         return ::Vehicle::Get(vehicle_id)->max_age - ::Vehicle::Get(vehicle_id)->age;
 310 }
 311
 312 /* static */ int32 ScriptVehicle::GetCurrentSpeed(VehicleID vehicle_id)
 313 {
 314         if (!IsValidVehicle(vehicle_id)) return -1;
 315
 316         const ::Vehicle *v = ::Vehicle::Get(vehicle_id);
 317         return (v->vehstatus & (::VS_STOPPED | ::VS_CRASHED)) == 0 ? v->GetDisplaySpeed() : 0; // km-ish/h
 318 }
 319
 320 /* static */ ScriptVehicle::VehicleState ScriptVehicle::GetState(VehicleID vehicle_id)
 321 {
 322         if (!IsValidVehicle(vehicle_id)) return ScriptVehicle::VS_INVALID;
 323
 324         const Vehicle *v = ::Vehicle::Get(vehicle_id);
 325         byte vehstatus = v->vehstatus;
 326
 327         if (vehstatus & ::VS_CRASHED) return ScriptVehicle::VS_CRASHED;
 328         if (v->breakdown_ctr != 0) return ScriptVehicle::VS_BROKEN;
 329         if (v->IsStoppedInDepot()) return ScriptVehicle::VS_IN_DEPOT;
 330         if (vehstatus & ::VS_STOPPED) return ScriptVehicle::VS_STOPPED;
 331         if (v->current_order.IsType(OT_LOADING)) return ScriptVehicle::VS_AT_STATION;
 332         return ScriptVehicle::VS_RUNNING;
 333 }
 334
 335 /* static */ Money ScriptVehicle::GetRunningCost(VehicleID vehicle_id)
 336 {
 337         if (!IsValidVehicle(vehicle_id)) return -1;
 338
 339         return ::Vehicle::Get(vehicle_id)->GetRunningCost() >> 8;
 340 }
 341
 342 /* static */ Money ScriptVehicle::GetProfitThisYear(VehicleID vehicle_id)
 343 {
 344         if (!IsValidVehicle(vehicle_id)) return -1;
 345
 346         return ::Vehicle::Get(vehicle_id)->GetDisplayProfitThisYear();
 347 }
 348
 349 /* static */ Money ScriptVehicle::GetProfitLastYear(VehicleID vehicle_id)
 350 {
 351         if (!IsValidVehicle(vehicle_id)) return -1;
 352
 353         return ::Vehicle::Get(vehicle_id)->GetDisplayProfitLastYear();
 354 }
 355
 356 /* static */ Money ScriptVehicle::GetCurrentValue(VehicleID vehicle_id)
 357 {
 358         if (!IsValidVehicle(vehicle_id)) return -1;
 359
 360         return ::Vehicle::Get(vehicle_id)->value;
 361 }
 362
 363 /* static */ ScriptVehicle::VehicleType ScriptVehicle::GetVehicleType(VehicleID vehicle_id)
 364 {
 365         if (!IsValidVehicle(vehicle_id)) return VT_INVALID;
 366
 367         switch (::Vehicle::Get(vehicle_id)->type) {
 368                 case VEH_ROAD:     return VT_ROAD;
 369                 case VEH_TRAIN:    return VT_RAIL;
 370                 case VEH_SHIP:     return VT_WATER;
 371                 case VEH_AIRCRAFT: return VT_AIR;
 372                 default:           return VT_INVALID;
 373         }
 374 }
 375
 376 /* static */ ScriptRoad::RoadType ScriptVehicle::GetRoadType(VehicleID vehicle_id)
 377 {
 378         if (!IsValidVehicle(vehicle_id)) return ScriptRoad::ROADTYPE_INVALID;
 379         if (GetVehicleType(vehicle_id) != VT_ROAD) return ScriptRoad::ROADTYPE_INVALID;
 380
 381         return (ScriptRoad::RoadType)(::RoadVehicle::Get(vehicle_id))->roadtype;
 382 }
 383
 384 /* static */ int32 ScriptVehicle::GetCapacity(VehicleID vehicle_id, CargoID cargo)
 385 {
 386         if (!IsValidVehicle(vehicle_id)) return -1;
 387         if (!ScriptCargo::IsValidCargo(cargo)) return -1;
 388
 389         uint32 amount = 0;
 390         for (const Vehicle *v = ::Vehicle::Get(vehicle_id); v != NULL; v = v->Next()) {
 391                 if (v->cargo_type == cargo) amount += v->cargo_cap;
 392         }
 393
 394         return amount;
 395 }
 396
 397 /* static */ int32 ScriptVehicle::GetCargoLoad(VehicleID vehicle_id, CargoID cargo)
 398 {
 399         if (!IsValidVehicle(vehicle_id)) return -1;
 400         if (!ScriptCargo::IsValidCargo(cargo)) return -1;
 401
 402         uint32 amount = 0;
 403         for (const Vehicle *v = ::Vehicle::Get(vehicle_id); v != NULL; v = v->Next()) {
 404                 if (v->cargo_type == cargo) amount += v->cargo.StoredCount();
 405         }
 406
 407         return amount;
 408 }
 409
 410 /* static */ GroupID ScriptVehicle::GetGroupID(VehicleID vehicle_id)
 411 {
 412         if (!IsValidVehicle(vehicle_id)) return ScriptGroup::GROUP_INVALID;
 413
 414         return ::Vehicle::Get(vehicle_id)->group_id;
 415 }
 416
 417 /* static */ bool ScriptVehicle::IsArticulated(VehicleID vehicle_id)
 418 {
 419         if (!IsValidVehicle(vehicle_id)) return false;
 420         if (GetVehicleType(vehicle_id) != VT_ROAD && GetVehicleType(vehicle_id) != VT_RAIL) return false;
 421
 422         const Vehicle *v = ::Vehicle::Get(vehicle_id);
 423         switch (v->type) {
 424                 case VEH_ROAD: return ::RoadVehicle::From(v)->HasArticulatedPart();
 425                 case VEH_TRAIN: return ::Train::From(v)->HasArticulatedPart();
 426                 default: NOT_REACHED();
 427         }
 428 }
 429
 430 /* static */ bool ScriptVehicle::HasSharedOrders(VehicleID vehicle_id)
 431 {
 432         if (!IsValidVehicle(vehicle_id)) return false;
 433
 434         Vehicle *v = ::Vehicle::Get(vehicle_id);
 435         return v->orders.list != NULL && v->orders.list->GetNumVehicles() > 1;
 436 }
 437
 438 /* static */ int ScriptVehicle::GetReliability(VehicleID vehicle_id)
 439 {
 440         if (!IsValidVehicle(vehicle_id)) return -1;
 441
 442         const Vehicle *v = ::Vehicle::Get(vehicle_id);
 443         return ::ToPercent16(v->reliability);
 444 }
 445
 446 /* static */ uint ScriptVehicle::GetMaximumOrderDistance(VehicleID vehicle_id)
 447 {
 448         if (!IsValidVehicle(vehicle_id)) return 0;
 449
 450         const ::Vehicle *v = ::Vehicle::Get(vehicle_id);
 451         switch (v->type) {
 452                 case VEH_SHIP:
 453                         return _settings_game.pf.pathfinder_for_ships != VPF_NPF ? 129 : 0;
 454
 455                 case VEH_AIRCRAFT:
 456                         return ::Aircraft::From(v)->acache.cached_max_range_sqr;
 457
 458                 default:
 459                         return 0;
 460         }
 461 }