AirplaneScriptApi Class Reference

This class is available under a global airplane_api variable. More...

Public Member Functions
string	GetPilot (uint airplaneId)
	Get pilot assigned to an airplane.
float	GetAirplaneHealth (uint airplaneId)
	Get the health value of an airplane.
void	SetAirplaneHealth (uint airplaneId, int healthValue)
	Set the health value of an airplane.
void	AddAirplaneHealth (uint airplaneId, int healthValue)
	Add a value the health value of an airplane.
float	GetAirplaneIntegrity (uint airplaneId)
	Get the integrity value of an airplane.
uint	GetAirplaneParkingLot (uint airplaneId)
	Get the parking lot assigned to an airplane.
void	ReduceAirplaneFuel (uint airplaneId, int fuel)
	Reduce the fuel level of an airplane.

Detailed Description

This class is available under a global airplane_api variable.

Member Function Documentation

AddAirplaneHealth()

void AddAirplaneHealth ( uint airplaneId, int healthValue )

inline

Add a value the health value of an airplane.

Parameters

airplaneId	ID of the airplane
healthValue	Value to add to the airplane health

Returns

Add a value the health value of the airplane

GetAirplaneHealth()

float GetAirplaneHealth ( uint airplaneId )

inline

Get the health value of an airplane.

Parameters

airplaneId

ID of the airplane

Returns

Returns the health value of the airplane

GetAirplaneIntegrity()

float GetAirplaneIntegrity ( uint airplaneId )

inline

Get the integrity value of an airplane.

Parameters

airplaneId

ID of the airplane

Returns

Returns the integrity value of an airplane

GetAirplaneParkingLot()

uint GetAirplaneParkingLot ( uint airplaneId )

inline

Get the parking lot assigned to an airplane.

Parameters

airplaneId

ID of the airplane

Returns

Entity ID of the parking lot

Exceptions

Exception

No parking lot found

GetPilot()

string GetPilot ( uint airplaneId )

inline

Get pilot assigned to an airplane.

Parameters

airplaneId

ID of the airplane

Returns

ID of the pilot assigned to the airplane

ReduceAirplaneFuel()

void ReduceAirplaneFuel ( uint airplaneId, int fuel )

inline

Reduce the fuel level of an airplane.

Parameters

airplaneId	ID of the airplane
fuel	amount of fuel reduction

SetAirplaneHealth()

void SetAirplaneHealth ( uint airplaneId, int healthValue )

inline

Set the health value of an airplane.

Parameters

airplaneId	ID of the airplane
healthValue	New health value of airplane

Returns

Sets the health value of the airplane