A class holding information about an AI traffic plane. More...

Public Member Functions
override string	ToString ()
	Gets a string containing the plane's ATCid, departure and arrival airports.

void	GetExtendedPlaneIndentifiers (bool TailNumber, bool AirlineAndFlightNumber, bool AircraftTypeAndModel, bool AircraftTitle)
	Immediately updates the specified extended plane identifier properties for this plane. This does not wait for the next refresh of the AI traffic.

Properties
FsAirport	DepartureAirportInfo `[get]`
	The FsAirport object from the AirportsDatabase which is the departure airport for this plane.

FsAirport	ArrivalAirportInfo `[get]`
	The FsAirport object from the AirportsDatabase which is the arrival airport for this plane.

FsAirport	CurrentAirportInfo `[get]`
	The FsAirport object from the AirportsDatabase that this plane is currently at.

FsRunway	RunwayAssignedInfo `[get]`
	The FsRunway object from the AirportsDatabase to which this plane is assigned.

FsGate	GateInfo `[get]`
	The FsGate object from the AirportsDatabase to which this plane is assigned.

bool	IsAtGate `[get]`
	True if the plane is currently at a Gate. Get the gate information from the GateInfo property.

bool	IsOnRunway `[get]`
	True if the plane is currently on its assigned Runway.

bool	IsOnGround `[get]`
	Tells you if this plane is on the ground (true) or airborne (false)

string	TailNumber `[get]`
	The tail number for this plane. Note that this is blank unless you call the GetExtendedPlaneIdentifiers() method on this plane, or you have set the tail number to update automatically using AITrafficServices.UpdateExtendedPlaneIdentifiers().

string	Airline `[get]`
	The Airline for this plane. Note that this is blank unless you call the GetExtendedPlaneIdentifiers() method on this plane, or you have set the airline to update automatically using AITrafficServices.UpdateExtendedPlaneIdentifiers().

string	FlightNumber `[get]`
	The flight number for this plane if one is assigned. For GA aircraft this is the same as the tail number. Note that this is blank unless you call the GetExtendedPlaneIdentifiers() method on this plane, or you have set the flight number to update automatically using AITrafficServices.UpdateExtendedPlaneIdentifiers().

string	AircraftType `[get]`
	The aircraft type (manufacturer) for this plane. Note that this is blank unless you call the GetExtendedPlaneIdentifiers() method on this plane, or you have set the aircraft type to update automatically using AITrafficServices.UpdateExtendedPlaneIdentifiers().

string	AircraftModel `[get]`
	The model of this plane. Note that this is blank unless you call the GetExtendedPlaneIdentifiers() method on this plane, or you have set the aircraft model to update automatically using AITrafficServices.UpdateExtendedPlaneIdentifiers().

string	AircraftTitle `[get]`
	The title of this plane from the config file. Note that this is blank unless you call the GetExtendedPlaneIdentifiers() method on this plane, or you have set the aircraft title to update automatically using AITrafficServices.UpdateExtendedPlaneIdentifiers().

double	AltitudeDifferenceFeet `[get]`
	The difference between this AI plane and the player in Feet. Positive values are higher than the player, negative values are lower than the player.

double	AltitudeDifferenceMetres `[get]`
	The difference between this AI plane and the player in Metres. Positive values are higher than the player, negative values are lower than the player.

double	DistanceFeet `[get]`
	The distance between this AI plane and the player in Feet. This value is always positive.

double	DistanceNM `[get]`
	The distance between this AI plane and the player in Nautical Miles. This value is always positive.

double	DistanceMetres `[get]`
	The distance between this AI plane and the player in Metres. This value is always positive.

double	BearingToMagnetic `[get]`
	The bearing to this AI plane from the player in degrees magnetic.

double	BearingTo `[get]`
	The bearing to this AI plane from the player in degrees TRUE.

double	BearingFrom `[get]`
	The bearing from this AI plane to the player in degrees TRUE.

double	BearingFromMag `[get]`
	The bearing from this AI plane to the player in degrees MAGNETIC.

int	ID `[get]`
	The ID as specified in the TCAS table in FSUIPC. Negative values are FS AI aircraft. Positive values are third-party injected aircraft. Possibly.

FsLatLonPoint	Location `[get]`
	The location of this plane.

double	AltitudeFeet `[get]`
	The altitude of this plane in Feet.

double	AltitudeMetres `[get]`
	The altitude of this plane in Metres.

ushort	Heading `[get]`
	The TRUE heading of this plane (Not magnetic heading). Usual FSUIPC format: 360 degrees == 65536.

double	HeadingDegrees `[get]`
	The heading of this plane in degrees TRUE.

double	HeadingDegreesMag `[get]`
	The heading of this plane in degrees MAGNETIC.

short	GroundSpeed `[get]`
	The ground speed of this plane in Knots.

short	VirticalSpeedFeet `[get]`
	The vertical speed of this plane in Feet per Minute.

short	VirticalSpeedMetres `[get]`
	The vertical speed of this plane in Metres per Minute.

string	ATCIdentifier `[get]`
	ATC identifier for this plane. By default this is Airline + Flight Number or Tail number.

AITrafficStatus	State `[get]`
	The current state of this plane (e.g. taking off, en route etc)

short	Com1 `[get]`
	The current Com 1 frequency tuned in this plane. This is in the traditional raw FSUIPC BCD format (0Xaabb as in 1aa.bb)

string	Com1String `[get]`
	A string representing the current Com 1 frequency tuned in this plane.

int	Key `[get]`
	This is the flight identifier Key (usually negative, as in 0xFFFFxxxx) which can be used to identify the flight in the Traffic file. It is not guaranteed to be unique except in one traffic File.

int	File `[get]`
	This is a file Id, to distinguish between multiple traffic files. The default FS2004 Traffic File has an Id of 14.

double	PitchDegrees `[get]`
	The pitch of the plane in degrees.

short	Pitch `[get]`
	The pitch of the plane in raw FSUIPC units (degrees * 65536 / 360)

double	BankDegrees `[get]`
	The bank of the plane in degrees.

short	Bank `[get]`
	The bank of the plane in raw FSUIPC units (degrees * 65536 / 360)

string	DepartureICAO `[get]`
	ICAO code of the departure airport of this plane.

string	ArrivalICAO `[get]`
	ICAO code of the destination airport of the plane.

FsRunwayID	RunwayAssigned `[get]`
	The assigned runway for this plane. Number will be 0 if not assigned for take-off or landing.

byte	GateName `[get]`
	FSX ONLY! This is a numeric representation of the gate name, when one is assigned. Otherwise it is zero.

short	GateNumber `[get]`
	FSX ONLY! This is the gate number, if it is actually numbered.

byte	GateType `[get]`
	FSX ONLY! This is a numeric representation of the gate type, when one is assigned. Otherwise it is zero.

Detailed Description

A class holding information about an AI traffic plane.

This class cannot be instantiated. You can only obtain instances of AIPlaneInfo from the active AITrafficServices object.

Member Function Documentation

◆ GetExtendedPlaneIndentifiers()

void GetExtendedPlaneIndentifiers	(	bool	TailNumber,
		bool	AirlineAndFlightNumber,
		bool	AircraftTypeAndModel,
		bool	AircraftTitle )

inline

Immediately updates the specified extended plane identifier properties for this plane. This does not wait for the next refresh of the AI traffic.

Parameters

TailNumber	Set to true to update the TailNumber property of this plane
AirlineAndFlightNumber	Set to true to update the Airline and FlightNumber properties of this plane
AircraftTypeAndModel	Set to true to update the AircraftType and AircraftModel properties of this plane
AircraftTitle	Set to true to update the AircraftTitle property of this plane

◆ ToString()

override string ToString ( )

inline

Gets a string containing the plane's ATCid, departure and arrival airports.

Returns

Property Documentation

◆ ArrivalAirportInfo

FsAirport ArrivalAirportInfo

get

The FsAirport object from the AirportsDatabase which is the arrival airport for this plane.

This will only be filled in if the AirportsDatabase has been loaded.

◆ ATCIdentifier

string ATCIdentifier

get

ATC identifier for this plane. By default this is Airline + Flight Number or Tail number.

For Tail number, if more than 14 chars you get the LAST 14. Airline name is truncated to allow whole flight number to be included

This can be changed by an option in the FSUIPC.ini file. See the FSUIPC programmers guide for details.

◆ Com1

short Com1

get

The current Com 1 frequency tuned in this plane. This is in the traditional raw FSUIPC BCD format (0Xaabb as in 1aa.bb)

NOTE that since FSUIPC 3.60, in FS2004 this is set to 0x9999 whilst the aircraft is in SLEW mode rather than normal flight mode.

◆ Com1String

string Com1String

get

A string representing the current Com 1 frequency tuned in this plane.

NOTE that since FSUIPC 3.60, in FS2004 this is set to 0x9999 whilst the aircraft is in SLEW mode rather than normal flight mode.

◆ CurrentAirportInfo

FsAirport CurrentAirportInfo

get

The FsAirport object from the AirportsDatabase that this plane is currently at.

This will only be filled in if the AirportsDatabase has been loaded.

◆ DepartureAirportInfo

FsAirport DepartureAirportInfo

get

The FsAirport object from the AirportsDatabase which is the departure airport for this plane.

This will only be filled in if the AirportsDatabase has been loaded.

◆ File

int File

get

This is a file Id, to distinguish between multiple traffic files. The default FS2004 Traffic File has an Id of 14.

[Note: this is not available in FSX!]

◆ GateInfo

FsGate GateInfo

get

The FsGate object from the AirportsDatabase to which this plane is assigned.

This will only be filled in if the AirportsDatabase has been loaded.

◆ GateName

byte GateName

get

FSX ONLY! This is a numeric representation of the gate name, when one is assigned. Otherwise it is zero.

See offset D040 in the FSUIPC4 Offsets Status PDF (in the FSUIPC SDK) for what the values mean.

◆ GateType

byte GateType

get

FSX ONLY! This is a numeric representation of the gate type, when one is assigned. Otherwise it is zero.

See offset D040 in the FSUIPC4 Offsets Status PDF (in the FSUIPC SDK) for what the values mean.

◆ Key

int Key

get

This is the flight identifier Key (usually negative, as in 0xFFFFxxxx) which can be used to identify the flight in the Traffic file. It is not guaranteed to be unique except in one traffic File.

[Note: this is not available in FSX!]

◆ RunwayAssignedInfo

FsRunway RunwayAssignedInfo

get

The FsRunway object from the AirportsDatabase to which this plane is assigned.

This will only be filled in if the AirportsDatabase has been loaded and the plane has been assigned a runway.

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ GetExtendedPlaneIndentifiers()

◆ ToString()

Property Documentation

◆ ArrivalAirportInfo

◆ ATCIdentifier

◆ Com1

◆ Com1String

◆ CurrentAirportInfo

◆ DepartureAirportInfo

◆ File

◆ GateInfo

◆ GateName

◆ GateType

◆ Key

◆ RunwayAssignedInfo