AirRefuelSupplier
(For high level concepts about how to use Lua to write scripted tasks, please see VR-Forces User's Guide.)
The AirRefuelSupplier is an object that controls the refuel points of a tanker aircraft. It is represented in Lua scripts by an object of class air-refuel-supplier-controller. The functions defined below are methods available for this class of object.
Lua scripts cannot create air-refuel-supplier-controller objects, but if an entity uses a air-refuel-supplier-controller in one of its systems (e.g. the Boom Air Refueling Supplier system), then an air-refuel-supplier-controller object is automatically defined for the Lua API for that entity. This object always has the name "airRefuelSupplier". Example: the boow-refueling-supplier.sysdef (whose name in the SOE is Boom Air Refueling Supplier) has an air-refuel-supplier-controller, so entities with this system could call
airRefuelSupplier:enable()
to enable the refuel point on the entity.
Function List
| disable () | Disables the refuel point |
| enable () | Enables the refuel point |
| isBoom () | Returns true if the refuel point type is a boom |
| isDisabled () | Returns true if the refuel point is disabled |
| isDrogue () | Returns true if the refuel point type is a drogue |
| isEnabled () | Returns true if the refuel point is enabled |
| isOccupied () | Returns true if the refuel point is occupied |
| occupied () | Disables the refuel point |
| offset () | Returns the refuel point offset |
| state () | Returns whether the refuel point is disabled(0), enabled(1), or occupied(2) |
| supplyType () | Returns the refuel point offset |
Functions
- disable ()
- Disables the refuel point
- enable ()
- Enables the refuel point
- isBoom ()
- Returns true if the refuel point type is a boom
- isDisabled ()
- Returns true if the refuel point is disabled
- isDrogue ()
- Returns true if the refuel point type is a drogue
- isEnabled ()
- Returns true if the refuel point is enabled
- isOccupied ()
- Returns true if the refuel point is occupied
- occupied ()
- Disables the refuel point
- offset ()
- Returns the refuel point offset
- state ()
- Returns whether the refuel point is disabled(0), enabled(1), or occupied(2)
- supplyType ()
- Returns the refuel point offset