Event Engine Preview, indicating a manufacturer offer you to test a new engine. More...
#include <script_event_types.hpp>
Public Member Functions | |
ScriptEventEnginePreview (EngineID engine) | |
char * | GetName () |
Get the name of the offered engine. | |
CargoID | GetCargoType () |
Get the cargo-type of the offered engine. | |
int32 | GetCapacity () |
Get the capacity of the offered engine. | |
int32 | GetMaxSpeed () |
Get the maximum speed of the offered engine. | |
Money | GetPrice () |
Get the new cost of the offered engine. | |
Money | GetRunningCost () |
Get the running cost of the offered engine. | |
int32 | GetVehicleType () |
Get the type of the offered engine. | |
bool | AcceptPreview () |
Accept the engine preview. | |
Static Public Member Functions | |
static ScriptEventEnginePreview * | Convert (ScriptEvent *instance) |
Convert an ScriptEvent to the real instance. | |
Private Member Functions | |
bool | IsEngineValid () const |
Check whether the engine from this preview is still valid. | |
Private Attributes | |
EngineID | engine |
The engine the preview is for. |
Event Engine Preview, indicating a manufacturer offer you to test a new engine.
You can get the same information about the offered engine as a real user would see in the offer window. And you can also accept the offer. ai
Definition at line 210 of file script_event_types.hpp.
ScriptEventEnginePreview::ScriptEventEnginePreview | ( | EngineID | engine | ) | [inline] |
engine | The engine offered to test. |
Definition at line 215 of file script_event_types.hpp.
bool ScriptEventEnginePreview::AcceptPreview | ( | ) |
Accept the engine preview.
Definition at line 112 of file script_event_types.cpp.
References CMD_WANT_ENGINE_PREVIEW, ScriptObject::DoCommand(), engine, and IsEngineValid().
static ScriptEventEnginePreview* ScriptEventEnginePreview::Convert | ( | ScriptEvent * | instance | ) | [inline, static] |
Convert an ScriptEvent to the real instance.
instance | The instance to convert. |
Definition at line 225 of file script_event_types.hpp.
int32 ScriptEventEnginePreview::GetCapacity | ( | ) |
Get the capacity of the offered engine.
In case it can transport multiple cargos, it returns the first/main.
Definition at line 56 of file script_event_types.cpp.
References engine, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_engine_pool >::Get(), GetCapacityOfArticulatedParts(), Engine::GetDisplayDefaultCapacity(), IsEngineValid(), Engine::type, VEH_AIRCRAFT, VEH_ROAD, VEH_SHIP, and VEH_TRAIN.
CargoID ScriptEventEnginePreview::GetCargoType | ( | ) |
Get the cargo-type of the offered engine.
In case it can transport multiple cargos, it returns the first/main.
Definition at line 39 of file script_event_types.cpp.
References engine, GetCapacityOfArticulatedParts(), and IsEngineValid().
int32 ScriptEventEnginePreview::GetMaxSpeed | ( | ) |
Get the maximum speed of the offered engine.
Definition at line 79 of file script_event_types.cpp.
References _settings_game, engine, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_engine_pool >::Get(), Engine::GetDisplayMaxSpeed(), IsEngineValid(), VehicleSettings::plane_speed, Engine::type, VEH_AIRCRAFT, and GameSettings::vehicle.
char * ScriptEventEnginePreview::GetName | ( | ) |
Get the name of the offered engine.
Definition at line 28 of file script_event_types.cpp.
References engine, IsEngineValid(), and SetDParam().
Money ScriptEventEnginePreview::GetPrice | ( | ) |
Get the new cost of the offered engine.
Definition at line 88 of file script_event_types.cpp.
References engine, and IsEngineValid().
Money ScriptEventEnginePreview::GetRunningCost | ( | ) |
Get the running cost of the offered engine.
Definition at line 94 of file script_event_types.cpp.
References engine, and IsEngineValid().
int32 ScriptEventEnginePreview::GetVehicleType | ( | ) |
Get the type of the offered engine.
Definition at line 100 of file script_event_types.cpp.
References engine, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_engine_pool >::Get(), IsEngineValid(), ScriptEvent::type, VEH_AIRCRAFT, VEH_ROAD, VEH_SHIP, and VEH_TRAIN.
bool ScriptEventEnginePreview::IsEngineValid | ( | ) | const [private] |
Check whether the engine from this preview is still valid.
Definition at line 22 of file script_event_types.cpp.
References engine, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_engine_pool >::GetIfValid(), and Engine::IsEnabled().
Referenced by AcceptPreview(), GetCapacity(), GetCargoType(), GetMaxSpeed(), GetName(), GetPrice(), GetRunningCost(), and GetVehicleType().