OpenTTD/src/engine_type.h

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

/** @file engine_type.h Types related to engines. */

#ifndef ENGINE_TYPE_H
#define ENGINE_TYPE_H

#include "core/pool_type.hpp"
#include "economy_type.h"
#include "landscape_type.h"
#include "newgrf_callbacks.h"
#include "rail_type.h"
#include "road_type.h"
#include "cargo_type.h"
#include "timer/timer_game_calendar.h"
#include "sound_type.h"
#include "strings_type.h"
#include "newgrf_badge_type.h"

/** Unique identification number of an engine. */
using EngineID = PoolID<uint16_t, struct EngineIDTag, 64000, 0xFFFF>;

class Engine;

/** Available types of rail vehicles. */
enum class RailVehicleType : uint8_t {
	Singlehead, ///< indicates a "standalone" locomotive
	Multihead, ///< indicates a combination of two locomotives
	Wagon, ///< simple wagon, not motorized
};

/** Type of rail engine. */
enum class EngineClass : uint8_t {
	Steam, ///< Steam rail engine.
	Diesel, ///< Diesel rail engine.
	Electric, ///< Electric rail engine.
	Monorail, ///< Mono rail engine.
	Maglev, ///< Maglev engine.
};

/** Acceleration model of a vehicle. */
enum class VehicleAccelerationModel : uint8_t {
	Normal,   ///< Default acceleration model.
	Monorail, ///< Monorail acceleration model.
	Maglev,   ///< Maglev acceleration model.
};

/** Meaning of the various bits of the visual effect. */
enum VisualEffect : uint8_t {
	VE_OFFSET_START        = 0, ///< First bit that contains the offset (0 = front, 8 = centre, 15 = rear)
	VE_OFFSET_COUNT        = 4, ///< Number of bits used for the offset
	VE_OFFSET_CENTRE       = 8, ///< Value of offset corresponding to a position above the centre of the vehicle

	VE_TYPE_START          = 4, ///< First bit used for the type of effect
	VE_TYPE_COUNT          = 2, ///< Number of bits used for the effect type
	VE_TYPE_DEFAULT        = 0, ///< Use default from engine class
	VE_TYPE_STEAM          = 1, ///< Steam plumes
	VE_TYPE_DIESEL         = 2, ///< Diesel fumes
	VE_TYPE_ELECTRIC       = 3, ///< Electric sparks

	VE_DISABLE_EFFECT      = 6, ///< Flag to disable visual effect
	VE_ADVANCED_EFFECT     = VE_DISABLE_EFFECT, ///< Flag for advanced effects
	VE_DISABLE_WAGON_POWER = 7, ///< Flag to disable wagon power

	VE_DEFAULT = 0xFF,          ///< Default value to indicate that visual effect should be based on engine class
};

/** Information about a rail vehicle. */
struct RailVehicleInfo {
	uint8_t image_index = 0;
	RailVehicleType railveh_type = RailVehicleType::Wagon; ///< Type of rail vehicle.
	uint8_t cost_factor = 0; ///< Purchase cost factor;      For multiheaded engines the sum of both engine prices.
	RailTypes railtypes{RAILTYPE_RAIL}; ///< Railtypes, mangled if elrail is disabled.
	RailTypes intended_railtypes{RAILTYPE_RAIL}; ///< Intended railtypes, regardless of elrail being enabled or disabled.
	uint8_t ai_passenger_only = 0; ///< Bit value to tell AI that this engine is for passenger use only
	uint16_t max_speed = 0; ///< Maximum speed (1 unit = 1/1.6 mph = 1 km-ish/h)
	uint16_t power = 0; ///< Power of engine (hp);      For multiheaded engines the sum of both engine powers.
	uint16_t weight = 0; ///< Weight of vehicle (tons);  For multiheaded engines the weight of each single engine.
	uint8_t running_cost = 0; ///< Running cost of engine;    For multiheaded engines the sum of both running costs.
	Price running_cost_class{};
	EngineClass engclass{}; ///< Class of engine for this vehicle
	uint8_t capacity = 0; ///< Cargo capacity of vehicle; For multiheaded engines the capacity of each single engine.
	uint16_t pow_wag_power = 0; ///< Extra power applied to consist if wagon should be powered
	uint8_t pow_wag_weight = 0; ///< Extra weight applied to consist if wagon should be powered
	uint8_t visual_effect = VE_DEFAULT; ///< Bitstuffed NewGRF visual effect data
	uint8_t shorten_factor = 0; ///< length on main map for this type is 8 - shorten_factor
	uint8_t tractive_effort = 0; ///< Tractive effort coefficient
	uint8_t air_drag = 0; ///< Coefficient of air drag
	uint8_t user_def_data = 0; ///< Property 0x25: "User-defined bit mask" Used only for (very few) NewGRF vehicles
	int16_t curve_speed_mod = 0; ///< Modifier to maximum speed in curves (fixed-point binary with 8 fractional bits)
};

/** Information about a ship vehicle. */
struct ShipVehicleInfo {
	uint8_t image_index = 0;
	uint8_t cost_factor = 0;
	uint8_t running_cost = 0;
	uint8_t acceleration = 1; ///< Acceleration (1 unit = 1/3.2 mph per tick = 0.5 km-ish/h per tick)
	uint16_t max_speed = 0; ///< Maximum speed (1 unit = 1/3.2 mph = 0.5 km-ish/h)
	uint16_t capacity = 0;
	SoundID sfx{};
	bool old_refittable = 0; ///< Is ship refittable; only used during initialisation. Later use EngineInfo::refit_mask.
	uint8_t visual_effect = VE_DEFAULT; ///< Bitstuffed NewGRF visual effect data
	uint8_t ocean_speed_frac = 0; ///< Fraction of maximum speed for ocean tiles.
	uint8_t canal_speed_frac = 0; ///< Fraction of maximum speed for canal/river tiles.

	/**
	 * Apply ocean/canal speed fraction to a velocity.
	 * @param raw_speed The original speed.
	 * @param is_ocean Whether to apply the ocean or canal/river speed fraction.
	 * @return The actual maximum speed of the ship.
	 */
	uint ApplyWaterClassSpeedFrac(uint raw_speed, bool is_ocean) const
	{
		/* speed_frac == 0 means no reduction while 0xFF means reduction to 1/256. */
		return raw_speed * (256 - (is_ocean ? this->ocean_speed_frac : this->canal_speed_frac)) / 256;
	}
};

/**
 * AircraftVehicleInfo subtypes, bitmask type.
 * If bit 0 is 0 then it is a helicopter, otherwise it is a plane
 * in which case bit 1 tells us whether it's a big(fast) plane or not.
 */
enum AircraftSubTypeBits : uint8_t {
	AIR_HELI = 0,
	AIR_CTOL = 1, ///< Conventional Take Off and Landing, i.e. planes
	AIR_FAST = 2
};

/** Information about a aircraft vehicle. */
struct AircraftVehicleInfo {
	uint8_t image_index = 0;
	uint8_t cost_factor = 0;
	uint8_t running_cost = 0;
	uint8_t subtype = 0; ///< Type of aircraft. @see AircraftSubTypeBits
	SoundID sfx{};
	uint16_t max_speed = 0; ///< Maximum speed (1 unit = 8 mph = 12.8 km-ish/h)
	uint8_t acceleration = 0;
	uint8_t mail_capacity = 0; ///< Mail capacity (bags).
	uint16_t passenger_capacity = 0; ///< Passenger capacity (persons).
	uint16_t max_range = 0; ///< Maximum range of this aircraft.
};

/** Information about a road vehicle. */
struct RoadVehicleInfo {
	uint8_t image_index = 0;
	uint8_t cost_factor = 0;
	uint8_t running_cost = 0;
	Price running_cost_class{};
	SoundID sfx{};
	uint16_t max_speed = 0; ///< Maximum speed (1 unit = 1/3.2 mph = 0.5 km-ish/h)
	uint8_t capacity = 0;
	uint8_t weight = 0; ///< Weight in 1/4t units
	uint8_t power = 0; ///< Power in 10hp units
	uint8_t tractive_effort = 0x4C; ///< Coefficient of tractive effort
	uint8_t air_drag = 0; ///< Coefficient of air drag
	uint8_t visual_effect = VE_DEFAULT; ///< Bitstuffed NewGRF visual effect data
	uint8_t shorten_factor = 0; ///< length on main map for this type is 8 - shorten_factor
	RoadType roadtype{}; ///< Road type
};

/**
 * Extra engine flags for NewGRF features.
 * This is defined in the specification a 32 bit value, but most bits are not currently used.
 */
enum class ExtraEngineFlag : uint8_t {
	NoNews          = 0, ///< No 'new vehicle' news will be generated.
	NoPreview       = 1, ///< No exclusive preview will be offered.
	JoinPreview     = 2, ///< Engine will join exclusive preview with variant parent.
	SyncReliability = 3, ///< Engine reliability will be synced with variant parent.
	HasCab          = 4, ///< Train wagon has a cab and can lead a train when backing up, without any speed reduction.
};

/** Bitset of \c ExtraEngineFlag elements. */
using ExtraEngineFlags = EnumBitSet<ExtraEngineFlag, uint8_t>;

/**
 * EngineInfo.misc_flags is a bitmask, with the following values
 */
enum class EngineMiscFlag : uint8_t {
	RailTilts  = 0, ///< Rail vehicle tilts in curves
	RoadIsTram = 0, ///< Road vehicle is a tram/light rail vehicle

	Uses2CC    = 1, ///< Vehicle uses two company colours

	RailIsMU   = 2, ///< Rail vehicle is a multiple-unit (DMU/EMU)
	RailFlips  = 3, ///< Rail vehicle has old depot-flip handling

	AutoRefit                = 4, ///< Automatic refitting is allowed
	NoDefaultCargoMultiplier = 5, ///< Use the new capacity algorithm. The default cargotype of the vehicle does not affect capacity multipliers. CB 15 is also called in purchase list.
	NoBreakdownSmoke         = 6, ///< Do not show black smoke during a breakdown.
	SpriteStack              = 7, ///< Draw vehicle by stacking multiple sprites.
};

/** Bitset of \c EngineMiscFlag elements. */
using EngineMiscFlags = EnumBitSet<EngineMiscFlag, uint8_t>;

/**
 * Information about a vehicle
 *  @see table/engines.h
 */
struct EngineInfo {
	TimerGameCalendar::Date base_intro{}; ///< Basic date of engine introduction (without random parts).
	TimerGameCalendar::Year lifelength{}; ///< Lifetime of a single vehicle
	TimerGameCalendar::Year base_life{}; ///< Basic duration of engine availability (without random parts). \c 0xFF means infinite life.
	uint8_t decay_speed = 0;
	uint8_t load_amount = 0;
	LandscapeTypes climates{}; ///< Climates supported by the engine.
	CargoType cargo_type{};
	std::variant<CargoLabel, MixedCargoType> cargo_label{};
	CargoTypes refit_mask{};
	uint8_t refit_cost = 0;
	EngineMiscFlags misc_flags{}; ///< Miscellaneous flags. @see EngineMiscFlags
	VehicleCallbackMasks callback_mask{}; ///< Bitmask of vehicle callbacks that have to be called
	int8_t retire_early = 0; ///< Number of years early to retire vehicle
	ExtraEngineFlags extra_flags{};
	StringID string_id = INVALID_STRING_ID; ///< Default name of engine
	uint16_t cargo_age_period = 0; ///< Number of ticks before carried cargo is aged.
	EngineID variant_id{}; ///< Engine variant ID. If set, will be treated specially in purchase lists.
};

/**
 * Engine.flags is a bitmask, with the following values.
 */
enum class EngineFlag : uint8_t {
	Available        = 0, ///< This vehicle is available to everyone.
	ExclusivePreview = 1, ///< This vehicle is in the exclusive preview stage, either being used or being offered to a company.
};

/** Bitset of \c EngineFlag elements. */
using EngineFlags = EnumBitSet<EngineFlag, uint8_t>;

/**
 * Contexts an engine name can be shown in.
 */
enum class EngineNameContext : uint8_t {
	Generic                 = 0x00, ///< No specific context available.
	VehicleDetails          = 0x11, ///< Name is shown in the vehicle details GUI.
	PurchaseList            = 0x20, ///< Name is shown in the purchase list (including autoreplace window 'Available vehicles' panel).
	PreviewNews             = 0x21, ///< Name is shown in exclusive preview or newspaper.
	AutoreplaceVehicleInUse = 0x22, ///< Name is show in the autoreplace window 'Vehicles in use' panel.
};

/**
 * Combine an engine ID and a name context to an engine name StringParameter.
 * @param engine_id The engine's ID.
 * @param context The context for the name.
 * @param extra_data Arbitrary extra data.
 * @return The packed StringParameter.
 */
inline uint64_t PackEngineNameDParam(EngineID engine_id, EngineNameContext context, uint32_t extra_data = 0)
{
	return engine_id.base() | (static_cast<uint64_t>(context) << 32) | (static_cast<uint64_t>(extra_data) << 40);
}

static const uint MAX_LENGTH_ENGINE_NAME_CHARS = 32; ///< The maximum length of an engine name in characters including '\0'

#endif /* ENGINE_TYPE_H */