SERVICE VARIABLES

The tables below indicate the requirements for the Simulation Variables that can be used to get and set the different properties for the available airport service vehicles and personnel. For information on the units listed for each variable, please see here: Simulation Variable Units

NOTE: When Microsoft Flight Simulator is running in multiplayer mode, only a small number of variables are communicated between aircraft. Those variables that are available will say so in the description as being either for "All Aircraft" or for "Shared Cockpit".

You can find a complete index of all available SimVars here: SimVar Index

 

 

Baggage Loader

Simulation Variable Description Units Settable
BAGGAGELOADER ANGLE CURRENT Current angle of the baggage loader ramp, relative to the ground. Degrees
BAGGAGELOADER ANGLE TARGET Target angle of the baggage loader ramp, relative to the ground. Degrees
BAGGAGELOADER END RAMP Y "Y" axis position of the end of the baggage loader ramp, relative to the ground. Meters
BAGGAGELOADER END RAMP Z "Z" axis position of the end of the baggage loader ramp, relative to the ground. Meters
BAGGAGELOADER PIVOT Y "Y" axis position of the baggage loader ramp pivot, relative to the ground. Meters
BAGGAGELOADER PIVOT Z "Z" axis position of the baggage loader ramp pivot, relative to the ground. Meters

 

 

Boarding Ramp

Simulation Variable Description Units Settable
BOARDINGRAMP ELEVATION CURRENT The current altitude AGL of the top of the boarding ramp stairs. Meters
BOARDINGRAMP ELEVATION TARGET The target altitude AGL of the top of the boarding ramp stairs. Meters
BOARDINGRAMP END POSITION Y The "Y" axis position of the top of the boarding ramp stairs when extended at maximal capacity, relative to the ground. Meters
BOARDINGRAMP END POSITION Z The "Z" axis position of the top of the boarding ramp stairs when extended at maximal capacity, relative to the ground. Meters
BOARDINGRAMP ORIENTATION CURRENT The current orientation of the boarding ramp stairs, where 0 is at rest and 1 is suited for boarding. Percent Over 100
BOARDINGRAMP ORIENTATION TARGET The target orientation of of the boarding ramp stairs, where 0 is at rest and 1 is suited for boarding. Percent Over 100
BOARDINGRAMP START POSITION Y The "Y" axis position of the top of the boarding ramp stairs when at minimal extension, relative to the ground. Meters
BOARDINGRAMP START POSITION Z The "Z" axis position of the top of the boarding ramp stairs when at minimal extension, relative to the ground. Meters

 

 

Catering Truck

Simulation Variable Description Units Settable
CATERINGTRUCK AIRCRAFT DOOR CONTACT OFFSET Z The "Z" axis position of the point of contact between the catering truck and the bottom of the aircraft door, relative to the ground. Meters
CATERINGTRUCK ELEVATION CURRENT The current altitude AGL of the bottom of the catering truck container. Meters
CATERINGTRUCK ELEVATION TARGET The target altitude AGL of the bottom of the catering truck container. Meters
CATERINGTRUCK OPENING CURRENT The current state of the catering truck when opening the container and deploying the bridge, where 0 is fully closed and 1 is fully opened and deployed. Percent Over 100
CATERINGTRUCK OPENING TARGET The target state of the catering truck the container is opene and the bridge deployed, where 0 is fully closed and 1 is fully opened and deployed. Percent Over 100

 

 

Fuel Truck

Simulation Variable Description Units Settable
FUELTRUCK HOSE DEPLOYED The current deployment amount of the fuel truck hose. Currently can only be set to 0 (not deployed) and 1 (deployed). Percent Over 100
FUELTRUCK HOSE END POSX The "X" axis position of the end of the fuel truck hose when fully deployed, relative to the ground. Meters
FUELTRUCK HOSE END POSZ The "Z" axis position of the end of the fuel truck hose when fully deployed, relative to the ground. Meters
FUELTRUCK HOSE END RELATIVE HEADING The heading of the end of the fuel truck hose, relative to the vehicle heading. Degrees

 

 

Ground Power Units

Simulation Variable Description Units Settable
GROUNDPOWERUNIT HOSE DEPLOYED The current deployment amount of the ground power unit hose. Currently can only be set to 0 (not deployed) and 1 (deployed). Percent Over 100
GROUNDPOWERUNIT HOSE END POSX The "X" axis position of the end of the ground power unit hose when fully deployed, relative to the ground. Meters
GROUNDPOWERUNIT HOSE END POSZ The "Z" axis position of the end of the ground power unit hose when fully deployed, relative to the ground. Meters
GROUNDPOWERUNIT HOSE END RELATIVE HEADING The heading of the end of the ground power unit hose, relative to the vehicle heading. Degrees

 

 

Jetway

Simulation Variable Description Units Settable
JETWAY HOOD LEFT BEND The target position for the left bend animation of the jetway hood. Percent
JETWAY HOOD LEFT DEPLOYMENT The target angle for the left deployment animation of the jetway hood, where 0 is considered vertical. Degrees
JETWAY HOOD RIGHT BEND The target position for the right bend animation of the jetway hood. Percent
JETWAY HOOD RIGHT DEPLOYMENT The target angle for the right deployment animation of the jetway hood, where 0 is considered vertical. Degrees
JETWAY HOOD TOP HORIZONTAL Target position for the top horizontal animation of the jetway hood. Values can be between -100% and 100%. Percent
JETWAY HOOD TOP VERTICAL Target position for the top vertical animation of the jetway hood. Values can be between -100% and 100%. Percent
JETWAY MOVING This will be 1 (TRUE) id the jetway body is currently moving (it will not include checks on hood animation). Bool
JETWAY WHEEL ORIENTATION CURRENT The current angle of the jetway wheels. Degrees
JETWAY WHEEL ORIENTATION TARGET The (approximate) target angle for the jetway wheels. Degrees
JETWAY WHEEL SPEED The current speed of the jetway wheels. Meters per second

 

 

Marshaller

Simulation Variable Description Units Settable
MARSHALLER AIRCRAFT DIRECTION PARKINGSPACE Currently not used in the simulation. Degrees
MARSHALLER AIRCRAFT DISTANCE The distance between the Marshaller and the aircraft. Meters
MARSHALLER AIRCRAFT DISTANCE DIRECTION X PARKINGSPACE Position on the X axis of the aircraft in the parking space (negative means the aircraft is on the left side and positive the right side). Meters
MARSHALLER AIRCRAFT DISTANCE DIRECTION Z PARKINGSPACE Position on the Z axis of the aircraft in the parking space (negative means the aircraft is behind the parking space and positive is in front of the parking space). Meters
MARSHALLER AIRCRAFT ENGINE SHUTDOWN True if the engine(s) of the aircraft is (are) shut down. Bool
MARSHALLER AIRCRAFT HEADING PARKINGSPACE Angle between the direction of the aircraft and the direction of the parking place. Degrees
MARSHALLER AIRCRAFT PROJECTION POINT PARKINGSPACE

Value in Z axis of the projection from the aircraft position following the heading of the aircraft.

 Meters
MARSHALLER AIRCRAFT VELOCITY The velocity of the aircraft. Knots

 

 

Pushback

Simulation Variable Description Units Settable
PUSHBACK ANGLE Pushback angle (the heading of the tug). Radians
PUSHBACK ATTACHED True if this vehicle is attached to an aircraft. Bool
PUSHBACK AVAILABLE True if a push back is available on the parking space. Bool
PUSHBACK CONTACTX The towpoint position, relative to the aircrafts datum reference point. Feet (ft)
PUSHBACK CONTACTY Pushback contact position in vertical direction. Feet (ft)
PUSHBACK CONTACTZ Pushback contact position in fore/aft direction. Feet (ft)
PUSHBACK STATE:index Type of pushback.

Enum:

  1. 0 = Straight
  2. 1 = Left
  3. 2 = Right
PUSHBACK WAIT True if waiting for pushback. Bool

 

 

Wagons

Simulation Variable Description Units Settable
WAGON BACK LINK LENGTH The length of the link at the back of the vehicle used to attach a wagon behind. Meters
WAGON BACK LINK ORIENTATION The current orientation of the link at the back of the vehicle used to attach a wagon behind. Degrees
WAGON BACK LINK START POSZ The "Z" axis position of the start of the link at the back of the vehicle used to attach a wagon behind, relative to the ground. Meters
WAGON FRONT LINK LENGTH The length of the link at the front of the vehicle used to be attached as wagon. Meters
WAGON FRONT LINK ORIENTATION The current orientation of the link at the front of the vehicle used to be attached as wagon. Degrees
WAGON FRONT LINK START POSZ The "Z" axis position of the start of the link at the front of the vehicle used to be attached as wagon, relative to the ground. Meters