AirRefuelSupplier
(For high level concepts about how to use Lua to write scripted tasks, please see VR-Forces User's Guide.)
The AirRefuelSupplier is a class of Lua object that controls the refuel points. The functions defined below are methods available for this class of object.
The name of the object in the Lua environment is the name of the component, found in the data file (e.g. a .sysdef file).
Example: in the fixed-wing-fighter-jet.sysdef file describing a fixed-wing movement system, there is a landing gear actuator with component-type = "air-refuel-supplier-controller". The name of this component in the system is "airRefuelSupplier." Thus a Lua script could call
airRefuelSupplier:enable()
to enable the refuel point.
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