AIEventEnginePreview Class Reference

Event Engine Preview, indicating a manufacturer offer you to test a new engine. More...

Inheritance diagram for AIEventEnginePreview:

Public Member Functions
	AIEventEnginePreview (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.
AIVehicle::VehicleType	GetVehicleType ()
	Get the type of the offered engine.
bool	AcceptPreview ()
	Accept the engine preview.
Static Public Member Functions
static AIEventEnginePreview *	Convert (AIEvent *instance)
	Convert an AIEvent to the real instance.

---

Detailed Description

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.

---

Constructor & Destructor Documentation

AIEventEnginePreview::AIEventEnginePreview

(

EngineID

engine

)

[inline]

Parameters:

engine

The engine offered to test.

---

Member Function Documentation

bool AIEventEnginePreview::AcceptPreview

(

)

Accept the engine preview.

Returns:

True when the accepting succeeded.

static AIEventEnginePreview* AIEventEnginePreview::Convert

(

AIEvent *

instance

)

[inline, static]

Convert an AIEvent to the real instance.

Parameters:

instance

The instance to convert.

Returns:

The converted instance.

int32 AIEventEnginePreview::GetCapacity

(

)

Get the capacity of the offered engine.

In case it can transport multiple cargos, it returns the first/main.

Returns:

The capacity of the engine.

CargoID AIEventEnginePreview::GetCargoType

(

)

Get the cargo-type of the offered engine.

In case it can transport multiple cargos, it returns the first/main.

Returns:

The cargo-type of the engine.

int32 AIEventEnginePreview::GetMaxSpeed

(

)

Get the maximum speed of the offered engine.

Returns:

The maximum speed the engine has.

Note:

The speed is in OpenTTD's internal speed unit. This is mph / 1.6, which is roughly km/h. To get km/h multiply this number by 1.00584.

char* AIEventEnginePreview::GetName

(

)

Get the name of the offered engine.

Returns:

The name the engine has.

Money AIEventEnginePreview::GetPrice

(

)

Get the new cost of the offered engine.

Returns:

The new cost the engine has.

Money AIEventEnginePreview::GetRunningCost

(

)

Get the running cost of the offered engine.

Returns:

The running cost of the vehicle per year.

Note:

Cost is per year; divide by 365 to get per day.

AIVehicle::VehicleType AIEventEnginePreview::GetVehicleType

(

)

Get the type of the offered engine.

Returns:

The type the engine has.