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 More...

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. More...

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

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

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

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

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

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

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

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

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(). More...

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(). More...

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(). More...

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(). More...

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(). More...

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(). More...

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. More...

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. More...

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

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

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

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

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

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

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

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. More...

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

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

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

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

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

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

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

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

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

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

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

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) More...

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

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. More...

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

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

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

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

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

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

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

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

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

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

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

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

◆ AircraftModel

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().

◆ AircraftTitle

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().

◆ AircraftType

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().

◆ Airline

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().

◆ AltitudeDifferenceFeet

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.

◆ AltitudeDifferenceMetres

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.

◆ AltitudeFeet

double AltitudeFeet

get

The altitude of this plane in Feet

◆ AltitudeMetres

double AltitudeMetres

get

The altitude of this plane in Metres

◆ 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.

◆ ArrivalICAO

string ArrivalICAO

get

ICAO code of the destination airport of the plane

◆ 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.

◆ Bank

short Bank

get

The bank of the plane in raw FSUIPC units (degrees * 65536 / 360)

◆ BankDegrees

double BankDegrees

get

The bank of the plane in degrees

◆ BearingFrom

double BearingFrom

get

The bearing from this AI plane to the player in degrees TRUE.

◆ BearingFromMag

double BearingFromMag

get

The bearing from this AI plane to the player in degrees MAGNETIC.

◆ BearingTo

double BearingTo

get

The bearing to this AI plane from the player in degrees TRUE.

◆ BearingToMagnetic

double BearingToMagnetic

get

The bearing to this AI plane from the player in degrees magnetic.

◆ 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.

◆ DepartureICAO

string DepartureICAO

get

ICAO code of the departure airport of this plane

◆ DistanceFeet

double DistanceFeet

get

The distance between this AI plane and the player in Feet. This value is always positive.

◆ DistanceMetres

double DistanceMetres

get

The distance between this AI plane and the player in Metres. This value is always positive.

◆ DistanceNM

double DistanceNM

get

The distance between this AI plane and the player in Nautical Miles. This value is always positive.

◆ 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!]

◆ FlightNumber

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().

◆ 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.

◆ GateNumber

short GateNumber

get

FSX ONLY! This is the gate number, if it is actually numbered.

◆ 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.

◆ GroundSpeed

short GroundSpeed

get

The ground speed of this plane in Knots.

◆ Heading

ushort Heading

get

The TRUE heading of this plane (Not magnetic heading). Usual FSUIPC format: 360 degrees == 65536

◆ HeadingDegrees

double HeadingDegrees

get

The heading of this plane in degrees TRUE.

◆ HeadingDegreesMag

double HeadingDegreesMag

get

The heading of this plane in degrees MAGNETIC.

◆ ID

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.

◆ IsAtGate

bool IsAtGate

get

True if the plane is currently at a Gate. Get the gate information from the GateInfo property.

◆ IsOnGround

bool IsOnGround

get

Tells you if this plane is on the ground (true) or airborne (false)

◆ IsOnRunway

bool IsOnRunway

get

True if the plane is currently on its assigned Runway.

◆ 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!]

◆ Location

FsLatLonPoint Location

get

The location of this plane

◆ Pitch

short Pitch

get

The pitch of the plane in raw FSUIPC units (degrees * 65536 / 360)

◆ PitchDegrees

double PitchDegrees

get

The pitch of the plane in degrees

◆ RunwayAssigned

FsRunwayID RunwayAssigned

get

The assigned runway for this plane. Number will be 0 if not assigned for take-off or landing.

◆ 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.

◆ State

AITrafficStatus State

get

The current state of this plane (e.g. taking off, en route etc)

◆ TailNumber

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().

◆ VirticalSpeedFeet

short VirticalSpeedFeet

get

The vertical speed of this plane in Feet per Minute

◆ VirticalSpeedMetres

short VirticalSpeedMetres

get

The vertical speed of this plane in Metres per Minute

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ GetExtendedPlaneIndentifiers()

◆ ToString()

Property Documentation

◆ AircraftModel

◆ AircraftTitle

◆ AircraftType

◆ Airline

◆ AltitudeDifferenceFeet

◆ AltitudeDifferenceMetres

◆ AltitudeFeet

◆ AltitudeMetres

◆ ArrivalAirportInfo

◆ ArrivalICAO

◆ ATCIdentifier

◆ Bank

◆ BankDegrees

◆ BearingFrom

◆ BearingFromMag

◆ BearingTo

◆ BearingToMagnetic

◆ Com1

◆ Com1String

◆ CurrentAirportInfo

◆ DepartureAirportInfo

◆ DepartureICAO

◆ DistanceFeet

◆ DistanceMetres

◆ DistanceNM

◆ File

◆ FlightNumber

◆ GateInfo

◆ GateName

◆ GateNumber

◆ GateType

◆ GroundSpeed

◆ Heading

◆ HeadingDegrees

◆ HeadingDegreesMag

◆ ID

◆ IsAtGate

◆ IsOnGround

◆ IsOnRunway

◆ Key

◆ Location

◆ Pitch

◆ PitchDegrees

◆ RunwayAssigned

◆ RunwayAssignedInfo

◆ State

◆ TailNumber

◆ VirticalSpeedFeet

◆ VirticalSpeedMetres