src/script/api/script_cargo.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_cargo.cpp Implementation of ScriptCargo. */
  11
  12 #include "../../stdafx.h"
  13 #include "script_cargo.hpp"
  14 #include "../../economy_func.h"
  15 #include "../../core/bitmath_func.hpp"
  16 #include "../../settings_type.h"
  17
  18 #include "../../safeguards.h"
  19
  20 /* static */ bool ScriptCargo::IsValidCargo(CargoID cargo_type)
  21 {
  22         return (cargo_type < NUM_CARGO && ::CargoSpec::Get(cargo_type)->IsValid());
  23 }
  24
  25 /* static */ bool ScriptCargo::IsValidTownEffect(TownEffect towneffect_type)
  26 {
  27         return (towneffect_type >= (TownEffect)TE_BEGIN && towneffect_type < (TownEffect)TE_END);
  28 }
  29
  30 /* static */ char *ScriptCargo::GetCargoLabel(CargoID cargo_type)
  31 {
  32         if (!IsValidCargo(cargo_type)) return NULL;
  33         const CargoSpec *cargo = ::CargoSpec::Get(cargo_type);
  34
  35         /* cargo->label is a uint32 packing a 4 character non-terminated string,
  36          * like "PASS", "COAL", "OIL_". New ones can be defined by NewGRFs */
  37         char *cargo_label = MallocT<char>(sizeof(cargo->label) + 1);
  38         for (uint i = 0; i < sizeof(cargo->label); i++) {
  39                 cargo_label[i] = GB(cargo->label, (uint8)(sizeof(cargo->label) - i - 1) * 8, 8);
  40         }
  41         cargo_label[sizeof(cargo->label)] = '\0';
  42         return cargo_label;
  43 }
  44
  45 /* static */ bool ScriptCargo::IsFreight(CargoID cargo_type)
  46 {
  47         if (!IsValidCargo(cargo_type)) return false;
  48         const CargoSpec *cargo = ::CargoSpec::Get(cargo_type);
  49         return cargo->is_freight;
  50 }
  51
  52 /* static */ bool ScriptCargo::HasCargoClass(CargoID cargo_type, CargoClass cargo_class)
  53 {
  54         if (!IsValidCargo(cargo_type)) return false;
  55         return ::IsCargoInClass(cargo_type, (::CargoClass)cargo_class);
  56 }
  57
  58 /* static */ ScriptCargo::TownEffect ScriptCargo::GetTownEffect(CargoID cargo_type)
  59 {
  60         if (!IsValidCargo(cargo_type)) return TE_NONE;
  61
  62         return (ScriptCargo::TownEffect)::CargoSpec::Get(cargo_type)->town_effect;
  63 }
  64
  65 /* static */ Money ScriptCargo::GetCargoIncome(CargoID cargo_type, uint32 distance, uint32 days_in_transit)
  66 {
  67         if (!IsValidCargo(cargo_type)) return -1;
  68         return ::GetTransportedGoodsIncome(1, distance, Clamp(days_in_transit * 2 / 5, 0, 255), cargo_type);
  69 }
  70
  71 /* static */ ScriptCargo::DistributionType ScriptCargo::GetDistributionType(CargoID cargo_type)
  72 {
  73         if (!ScriptCargo::IsValidCargo(cargo_type)) return INVALID_DISTRIBUTION_TYPE;
  74         return (ScriptCargo::DistributionType)_settings_game.linkgraph.GetDistributionType(cargo_type);
  75 }