1
0
Fork 0
fgdata/Nasal/tanker.nas
Richard Harrison 88ff80737f Tanker compatibility for models with unspecified refuel offsets.
Ensure that the offset properties are created and fix a nilptr reference
2019-06-11 14:41:12 +02:00

454 lines
15 KiB
Text

#--------------------------------------------------------------------------------------------------
var oclock = func(bearing) int(0.5 + geo.normdeg(bearing) / 30) or 12;
var tanker_msg = func setprop("sim/messages/ai-plane", call(sprintf, arg));
var pilot_msg = func setprop("/sim/messages/pilot", call(sprintf, arg));
var atc_msg = func setprop("sim/messages/atc", call(sprintf, arg));
var skip_cloud_layer = func(alt) {
var c = [];
foreach (var layer; props.globals.getNode("/environment/clouds").getChildren("layer")) {
var elev = (layer.getNode("elevation-ft", 1).getValue() or -9999) * FT2M;
var thck = (layer.getNode("thickness-ft", 1).getValue() or 0) * FT2M;
if (elev > -1000)
append(c, { bottom: elev - thck * 0.5 - 100, top: elev + thck * 0.5 + 100 });
}
while (check; 1) {
foreach (var layer; c) {
if (alt > layer.bottom and alt < layer.top) {
alt += 1000;
continue check;
}
}
return alt;
}
}
var identity = {
get: func {
# return free AI id number and least used, free callsign/channel pair
var data = {}; # copy of me.pool
var revdata = {}; # channel->callsign
foreach (var k; keys(me.pool)) {
data[k] = me.pool[k];
revdata[me.pool[k][0]] = k;
}
var id_used = {};
foreach (var t; props.globals.getNode("ai/models", 1).getChildren()) {
if ((var c = t.getNode("callsign")) != nil)
delete(data, c.getValue() or "");
if ((var c = t.getNode("navaids/tacan/channel-ID")) != nil)
delete(data, revdata[c.getValue() or ""]);
if ((var c = t.getNode("id")) != nil and c.getValue() != ""){
var v = c.getValue();
if (v != nil and v != "")
id_used[v] = 1;
}
}
for (var aiid = -2; aiid; aiid -= 1)
if (!id_used[aiid])
break;
if (!size(data))
return [aiid, "MOBIL3", "062X"];
var d = sort(keys(data), func(a, b) data[a][1] - data[b][1])[0];
me.pool[d][1] += 1;
return [aiid, d, data[d][0]];
},
pool: {
ESSO1: ["040X", rand()], ESSO2: ["041X", rand()], ESSO3: ["042X", rand()],
TEXACO1: ["050X", rand()], TEXACO2: ["051X", rand()], TEXACO3: ["052X", rand()],
MOBIL1: ["060X", rand()], MOBIL2: ["061X", rand()], MOBIL3: ["062X", rand()],
},
};
var replayTime = props.globals.getNode("sim/replay/time",1);
var simTimeElapsedSec = props.globals.getNode("sim/time/elapsed-sec",1);
var simTimeDeltaSec = props.globals.getNode("sim/time/delta-sec",1);
var acHeading = props.globals.getNode("/orientation/heading-deg");
var acPitch = props.globals.getNode("/orientation/pitch-deg");
var acContactDist = props.globals.getNode("/systems/refuel/contact-radius-m");
var refuelOffsetX = props.globals.getNode("/systems/refuel/offset-x-m",1);
var refuelOffsetY = props.globals.getNode("/systems/refuel/offset-y-m",1);
var refuelOffsetZ = props.globals.getNode("/systems/refuel/offset-z-m",1);
var acRoll = props.globals.getNode("/orientation/roll-deg");
var Tanker = {
new: func(aiid, callsign, tacan, type, model, kias, maxfuel, pattern, contacts, heading, coord) {
var m = { parents: [Tanker] };
m.callsign = callsign;
m.tacan = tacan;
m.kias = kias;
m.heading = m.course = m.track_course = heading;
m.out_of_range_time = 0;
m.interval = 10;
m.length = pattern;
m.contacts = contacts;
m.roll = 0;
m.coord = geo.Coord.new(coord);
m.anchor = geo.Coord.new(coord).apply_course_distance(m.track_course, m.length); # ARCP
m.goal = [nil, m.anchor];
m.lastmode = "none";
m.mode = "leg";
m.rollrate = 2; # deg/s
m.maxbank = 25;
var n = props.globals.getNode("models", 1);
for (var i = 0; 1; i += 1)
if (n.getChild("model", i, 0) == nil)
break;
m.model = n.getChild("model", i, 1);
var n = props.globals.getNode("ai/models", 1);
for (var i = 0; 1; i += 1){
var cn = n.getChild("tanker", i, 0);
if (cn == nil)
break;
if (cn.getNode("id") == nil or cn.getNode("id").getValue() == nil)
break;
}
m.ai = n.getChild("tanker", i, 1);
m.ai.getNode("id", 1).setIntValue(aiid);
m.ai.getNode("callsign", 1).setValue(m.callsign ~ "");
m.ai.getNode("tanker", 1).setBoolValue(1);
m.ai.getNode("valid", 1).setBoolValue(1);
m.ai.getNode("navaids/tacan/channel-ID", 1).setValue(m.tacan);
m.ai.getNode("refuel/type", 1).setValue(type);
m.ai.getNode("refuel/max-fuel-transfer-lbs-min", 1).setValue(maxfuel);
m.ai.getNode("refuel/contact", 1).setBoolValue(0);
m.ai.getNode("radar/in-range", 1).setBoolValue(1);
m.latN = m.ai.getNode("position/latitude-deg", 1);
m.lonN = m.ai.getNode("position/longitude-deg", 1);
m.altN = m.ai.getNode("position/altitude-ft", 1);
m.hdgN = m.ai.getNode("orientation/true-heading-deg", 1);
m.pitchN = m.ai.getNode("orientation/pitch-deg", 1);
m.rollN = m.ai.getNode("orientation/roll-deg", 1);
m.ktasN = m.ai.getNode("velocities/true-airspeed-kt", 1);
m.vertN = m.ai.getNode("velocities/vertical-speed-fps", 1);
m.rangeN = m.ai.getNode("radar/range-nm", 1);
m.brgN = m.ai.getNode("radar/bearing-deg", 1);
m.elevN = m.ai.getNode("radar/elevation-deg", 1);
m.contactN = m.ai.getNode("refuel/contact", 1);
m.hOffsetN = m.ai.getNode("radar/h-offset", 1);
m.vOffsetN = m.ai.getNode("radar/v-offset", 1);
m.update();
m.model.getNode("path", 1).setValue(model);
m.model.getNode("latitude-deg-prop", 1).setValue(m.latN.getPath());
m.model.getNode("longitude-deg-prop", 1).setValue(m.lonN.getPath());
m.model.getNode("elevation-ft-prop", 1).setValue(m.altN.getPath());
m.model.getNode("heading-deg-prop", 1).setValue(m.hdgN.getPath());
m.model.getNode("pitch-deg-prop", 1).setValue(m.pitchN.getPath());
m.model.getNode("roll-deg-prop", 1).setValue(m.rollN.getPath());
m.model.getNode("load", 1).remove();
m.identify();
# notify any listeners that a new model has been added.
setprop("/ai/models/model-added", m.ai.getPath());
return Tanker.active[m.callsign] = m;
},
del: func {
tanker_msg(me.callsign ~ " returns to base");
me.model.remove();
if (me.ai != nil){
me.ai.getChild("id").remove();
}
else
print(me.callsign," has no AI node");
me.ai = nil; # ensure that this tanker stops updating.
delete(Tanker.active, me.callsign);
},
update: func {
if ( replayTime.getValue() > 0 )
return;
var dt = simTimeDeltaSec.getValue();
var alt = me.coord.alt();
if (me.ai == nil){
print("Tamker ", me.callsign," stops updating");
return;
}
if ((me.interval += dt) >= 5) {
me.interval -= 5;
me.headwind = aircraft.wind_speed_from(me.course);
me.ktas = aircraft.kias_to_ktas(me.kias, alt);
}
var distance = dt * (me.ktas - me.headwind) * NM2M / 3600;
var deviation = me.roll ? dt * 1085.941 * math.tan(me.roll * D2R) / me.ktas : 0;
if (me.mode == "leg") {
if (me.lastmode != "leg") {
me.lastmode = "leg";
# swap ARCP anchor and tanker exit point as leg end points
var g = me.goal[0];
me.goal[0] = me.goal[1];
me.goal[1] = g;
me.course = me.coord.course_to(me.goal[0]);
me.leg_remaining = me.coord.distance_to(me.goal[0]);
me.roll_target = 0;
me.leg_warning = 0;
}
if ((me.leg_remaining -= distance) < 0)
me.mode = "turn";
} else { # me.mode == "turn"
if (me.lastmode != "turn") {
me.lastmode = "turn";
me.full_bank_turn_angle = 0;
me.turn_remaining = 180;
me.roll_target = 25;
}
if (!me.full_bank_turn_angle and me.roll >= me.roll_target)
me.full_bank_turn_angle = geo.normdeg(180 - me.turn_remaining);
if (me.turn_remaining < me.full_bank_turn_angle)
me.roll_target = 0;
if ((me.turn_remaining -= deviation) < 0) {
if (me.goal[1] == nil) # define tanker exit point (opposite of anchor point/ARCP)
me.goal[1] = geo.Coord.new(me.coord).apply_course_distance(me.track_course - 180,
me.length);
me.mode = "leg";
}
}
me.coord.apply_course_distance(me.course -= deviation, distance);
me.ac = geo.aircraft_position();
me.distance = me.ac.distance_to(me.coord);
me.bearing = me.ac.course_to(me.coord);
var dalt = alt - me.ac.alt();
var ac_hdg = acHeading.getValue();
var ac_pitch = acPitch.getValue();
var ac_contact_dist = acContactDist.getValue();
var elev = math.atan2(dalt, me.distance) * R2D;
me.latN.setDoubleValue(me.coord.lat());
me.lonN.setDoubleValue(me.coord.lon());
me.altN.setDoubleValue(alt * M2FT);
me.hdgN.setDoubleValue(me.heading = me.course);
me.pitchN.setDoubleValue(0);
me.rollN.setDoubleValue(-me.roll);
me.ktasN.setDoubleValue(me.ktas);
me.vertN.setDoubleValue(0);
me.rangeN.setDoubleValue(me.distance * M2NM);
me.brgN.setDoubleValue(me.bearing);
me.elevN.setDoubleValue(elev);
# Determine if any of the contact points are in contact
var offset_x = refuelOffsetX.getValue() or 0;
var offset_y = refuelOffsetY.getValue() or 0;
var offset_z = refuelOffsetZ.getValue() or 0;
var roll = acRoll.getValue() * globals.D2R;
# Determine contact position
var probe_pos = geo.Coord.new(me.ac);
probe_pos.apply_course_distance(ac_hdg, offset_x);
probe_pos.apply_course_distance(ac_hdg + 90, offset_y * math.cos(roll) + offset_z * math.sin(roll));
probe_pos.set_alt(me.ac.alt() + offset_z * math.cos(roll) - offset_y * math.sin(roll));
me.contactN.setBoolValue(0);
foreach (var c; me.contacts) {
var drogue_pos = geo.Coord.new(me.coord);
# Offset longitudonally
drogue_pos.apply_course_distance(me.course, c.x);
var r = me.roll * globals.D2R;
# Offset laterally, taking into account any roll
drogue_pos.apply_course_distance(me.course +90, c.y * math.cos(r) + c.z * math.sin(r));
# Offset vertically, again, taking into account any roll
drogue_pos.set_alt(drogue_pos.alt() + c.z * math.cos(r) - c.y * math.sin(r));
#print("Distance: " ~ probe_pos.distance_to(drogue_pos) ~ " vs. " ~ me.distance);
if (probe_pos.distance_to(drogue_pos) < ac_contact_dist and
abs(view.normdeg(me.course - ac_hdg)) < 20) {
# Contact!
me.contactN.setBoolValue(1);
}
}
me.hOffsetN.setDoubleValue(view.normdeg(me.bearing - ac_hdg));
me.vOffsetN.setDoubleValue(view.normdeg(elev - ac_pitch));
var droll = me.roll_target - me.roll;
if (droll > 0) {
me.roll += me.rollrate * dt;
if (me.roll > me.roll_target)
me.roll = me.roll_target;
} elsif (droll < 0) {
me.roll -= me.rollrate * dt;
if (me.roll < me.roll_target)
me.roll = me.roll_target;
}
if (!me.leg_warning and me.leg_remaining < NM2M) {
tanker_msg(me.callsign ~ ", turn in one mile");
me.leg_warning = 1;
}
me.now = simTimeElapsedSec.getValue();
if (me.distance < 90000)
me.out_of_range_time = me.now;
elsif (me.now - me.out_of_range_time > 600)
return me.del();
settimer(func me.update(), 0);
},
identify: func {
me.out_of_range_time = me.now;
var alt = int((me.coord.alt() * M2FT + 50) / 100) * 100;
tanker_msg("%s at %.0f, heading %.0f with %.0f knots, TACAN %s",
me.callsign, alt, me.course, me.kias, me.tacan);
},
report: func {
me.out_of_range_time = me.now;
var dist = int(me.distance * M2NM);
var hdg = getprop("orientation/heading-deg");
var diff = (me.coord.alt() - me.ac.alt()) * M2FT;
var qual = diff > 3000 ? " well" : abs(diff) > 1000 ? " slightly" : "";
var rel = diff > 1000 ? " above" : diff < -1000 ? " below" : "";
atc_msg("Tanker %s is at %s o'clock%s",
me.callsign, oclock(me.ac.course_to(me.coord) - hdg),
qual ~ rel);
},
active: {},
};
# Factory methods
# Create a tanker based on a given /sim/ai/tankers/tanker property node
var create_tanker = func(tanker_node, course) {
var (aiid, callsign, tacanid) =_= identity.get();
var model = tanker_node.getNode("model", 1).getValue();
var type = tanker_node.getNode("type", 1).getValue();
var spd = tanker_node.getNode("speed-kts", 1).getValue() or 250;
var pattern = (tanker_node.getNode("pattern-length-nm", 1).getValue() or 50) * NM2M;
var maxfuel = tanker_node.getNode("max-fuel-transfer-lbs-min", 1).getValue() or 6000;
var contacts = [];
foreach (var contact; tanker_node.getChildren("contact")) {
var x = (contact.getNode("x-m") != nil) ? contact.getNode("x-m").getValue() : 0;
var y = (contact.getNode("y-m") != nil) ? contact.getNode("y-m").getValue() : 0;
var z = (contact.getNode("z-m") != nil) ? contact.getNode("z-m").getValue() : 0;
append(contacts, { "x" : x, "y" : y, "z" : z });
}
if (size(contacts) == 0) {
append(contacts, {x: 0, y:0, z:0});
}
var alt = int(10 + rand() * 15) * 1000; # FL100--FL250
alt = skip_cloud_layer(alt * FT2M);
var dist = 6000 + rand() * 4000;
var coord = geo.aircraft_position().apply_course_distance(course, dist).set_alt(alt);
Tanker.new(aiid, callsign, tacanid, type, model, spd, maxfuel, pattern, contacts, course, coord);
}
# Request a new tanker
var request_new = func(tanker_node=nil) {
var tanker = values(Tanker.active);
if (size(tanker)) tanker[0].del();
request(tanker_node);
}
var request = func(tanker_node=nil) {
var tanker = values(Tanker.active);
if (size(tanker))
return tanker[0].identify();
if (tanker_node == nil) {
var type = props.globals.getNode("systems/refuel", 1).getChildren("type");
if (!size(type))
return;
type = type[rand() * size(type)].getValue();
var tankers = props.globals.getNode("/sim/ai/tankers", 1).getChildren("tanker");
foreach (var tanker; tankers) {
if (tanker.getNode("type", 1).getValue() == type) {
tanker_node = tanker;
break;
}
}
}
var hdg = getprop("orientation/heading-deg");
var course = hdg + (rand() - 0.5) * 60;
create_tanker(tanker_node, course);
}
var request_random = func(tanker_node=nil) {
var tanker = values(Tanker.active);
if (size(tanker))
return tanker[0].identify();
if (tanker_node == nil) {
var type = props.globals.getNode("systems/refuel", 1).getChildren("type");
if (!size(type))
return;
type = type[rand() * size(type)].getValue();
var tankers = props.globals.getNode("/sim/ai/tankers", 1).getChildren("tanker");
foreach (var tanker; tankers) {
if (tanker.getNode("type", 1).getValue() == type) {
tanker_node = tanker;
break;
}
}
}
var course = rand() * 360;
create_tanker(tanker_node, course);
}
var report = func {
var tanker = values(Tanker.active);
if (size(tanker))
tanker[0].report();
}
var reinit = func {
foreach (var t; values(Tanker.active))
t.del();
}
_setlistener("/sim/signals/nasal-dir-initialized", func {
var aar_capable = size(props.globals.getNode("systems/refuel", 1).getChildren("type"));
gui.menuEnable("tanker", aar_capable);
if (!aar_capable)
request = func { atc_msg("no tanker in range") }; # braces mandatory
setlistener("/sim/signals/reinit", reinit, 1);
});
if (globals["tanker"] != nil) {
# reload with io.load_nasal(getprop("/sim/fg-root") ~ "/Nasal/tanker.nas");
print("reloading " ~ caller(0)[2]);
var _setlistener = reinit;
reinit();
}