Oolite Bulletins

Code: Select all

this.oxpcSettings = {
  Info: {
    Name:this.name,
    Display:"GGIndustries LRS",
    Notify: true,
    InfoB:"Setup how to access the LRS configuration screen. If alwaysPrimable=true, the specials can be ignored. If not, they are used and default to F6-F6-F7.",
    InfoS:"Current Setting: "+$getKeyComboAsString()+"\nSetup which key combo you want to use to open the LRS configuration screen.\nValues: 0->F5, 1->F6, 2->F7, 3->F8.\nKeys1-3 have to be set, Key4 is optional
  },
  Bool0: {Name:"$alwaysPrimable",Def:false,Desc:"access LRS configScreen through priming?"},
  SInt0: {Name:"$key1st", Def:0x01, Max:0x03, Desc:"1st key of key combo."},
  SInt1: {Name:"$key2nd", Def:0x01, Max:0x03, Desc:"2nd key of key combo."},
  SInt2: {Name:"$key3rd", Def:0x02, Max:0x03, Desc:"3rd key of key combo."},
  SInt3: {Name:"$key4th", Def:0x04, Max:0x04, Desc:"4th key of key combo."}
};

Code: Select all

this.$getKeyComboAsString = function() {
  var last = "";
  if ($key4th <= 3) { last = "-F"+($key4th+5); }
  return "F"+($key1st+5)+"-F"+($key2nd+5)+"-F"+($key3rd+5)+last
}

Code: Select all

this.name           = "GGIndustries_LongRangeScanner_MainScript.js";
this.author         = "GGShinobi";
this.copyright      = "© 2013 GGShinobi, Creative Commons: attribution, non-commercial, sharealike.";
this.description    = "Main Script for the GGIndustries Long Range Scanner.";
this.version        = "0.0.1";
"use strict";


// =============================================================================
// local global variables / switches, configure as desired:

this.$showDebug = true;

// configuration / declare OXPConfig-variables:
this.$alwaysPrimable = false; // if true, keyCombos will be ignored, enter setup screen through priming instead

// the keys for key combination to open LRS config screen. 0=F5, 1=F6, 2=F7, 3=F8
this.$key1st = 2; // 1 => F7                  }\
this.$key2nd = 1; // 1 => F6                  } => default combo: 
this.$key3rd = 2; // 2 => F7                  } =>   F7-F6-F7
this.$key4th = 4; // 4 => disabled by default }/


// =============================================================================
// OXPConfig:

this.$getKeyComboAsString = function() {
  var last = "";
  if ($key4th <= 3) { last = "-F"+($key4th+5); }
  return "F"+($key1st+5)+"-F"+($key2nd+5)+"-F"+($key3rd+5)+last
}

this.oxpcSettings = {
  Info: {
    Name:this.name,
    Display:"GGIndustries LRS",
    LeaveData: true,
    Notify: false, // seems to have no effect if DynamicNotify is true
    DynamicNotify: true,
    InfoB:"Setup how to access the LRS configuration screen. If alwaysPrimable=true, the specials can be ignored. If not, they are used and default to F7-F6-F7.",
    InfoS:"Current Setting: "+$getKeyComboAsString()+"\nSetup which key combo you want to use to open the LRS configuration screen.\nValues: 0->F5, 1->F6, 2->F7, 3->F8.\nKeys1-3 have to be set, Key4 is optional. Set it to 4 to deactivate."
  },
  Bool0: {Name:"$alwaysPrimable",Def:false,Desc:"access LRS configScreen through priming?"},
  SInt0: {Name:"$key1st", Def:0x01, Max:0x03, Desc:"1st key of key combo."},
  SInt1: {Name:"$key2nd", Def:0x01, Max:0x03, Desc:"2nd key of key combo."},
  SInt2: {Name:"$key3rd", Def:0x02, Max:0x03, Desc:"3rd key of key combo."},
  SInt3: {Name:"$key4th", Def:0x04, Max:0x04, Desc:"4th key of key combo."}
};

this.oxpcNotifyOnChange = this.$setupKeyArrays = function(n) {
  // TODO: make use of n for more efficency
  // prepare vars used for configuration screen access:
  this.$guiStage = 0;             // remembers pos of key combo. Always between 0 and 3.
  this.$keyCombo = [$key1st, $key2nd, $key3rd, $key4th];

  var key1 = "F-" + ($key1st+5); var key2 = "F-" + ($key2nd+5); var key3 = "F-" + ($key3rd+5);
  var key4; if ($key4th <= 3) key4 = "F-" + ($key4th+5); else key4 = "disabled";
  this.oxpcSettings.SInt0.Desc = "1. key: " + key1;
  this.oxpcSettings.SInt1.Desc = "2. key: " + key2;
  this.oxpcSettings.SInt2.Desc = "3. key: " + key3;
  this.oxpcSettings.SInt3.Desc = "4. key: " + key4;
  if ($key4th <= 3) key4 = "-" + key4; else key4 = "";
  // the following line doesn't update / use the "fresh" values from the variables, but the values they had upon game start.
  this.oxpcSettings.Info.InfoS = "CHANGED: Current Setting: "+key1 + "-" + key2 + "-" + key3 + key4+"\nSetup which key combo you want to use to open the LRS configuration screen.\nValues: 0->F5, 1->F6, 2->F7, 3->F8.\nKeys1-3 have to be set, Key4 is optional. Set it to 4 to deactivate.";
}

// =============================================================================
// Helpers:

// show message on destination
// dest: 0 none, 1 logfile, 2 console
this.$showDebugInfo = function(message, dest) {
  if ($showDebug) {
    if ((dest&1)) { log("SmellyDebug", message); }
    if ((dest&2)) { player.consoleMessage(message); }
  }
}

// =============================================================================
// startup - called when OXP is loaded (on game start, load game,...)
this.startUp = function () {
  // setup key combo catcher:
  // GUI_SCREEN_MAIN, GUI_SCREEN_STATUS F5, GUI_SCREEN_MANIFEST F5-F5,
  // GUI_SCREEN_SYSTEM_DATA F7, GUI_SCREEN_OPTIONS, GUI_SCREEN_EQUIP_SHIP,
  // GUI_SCREEN_SHIPYARD, GUI_SCREEN_SHORT_RANGE_CHART F6,  GUI_SCREEN_REPORT,
  // GUI_SCREEN_LONG_RANGE_CHART F6-F6, GUI_SCREEN_MARKET F8, GUI_SCREEN_CONTRACTS
  this.$F5    = ["GUI_SCREEN_STATUS", "GUI_SCREEN_MANIFEST"];
  this.$F6    = ["GUI_SCREEN_SHORT_RANGE_CHART", "GUI_SCREEN_LONG_RANGE_CHART"];
  this.$F7    = ["GUI_SCREEN_SYSTEM_DATA"];
  this.$F8    = ["GUI_SCREEN_MARKET"];
  this.$FKeys = [$F5, $F6, $F7, $F8];
  $setupKeyArrays();
}

// =============================================================================
// show the GGIndustries LRS configuration screen:

this.$showLRSConfigScreen = function() {
  var LRSConfigScreen = new Object();
  LRSConfigScreen.title = "GGIndustries Long Range Scanner Configuration";
  LRSConfigScreen.screenID = "GGIndustries-LRS-configuration-screen"
  LRSConfigScreen.allowInterrupt = true;
  //LRSConfigScreen.model = "GGIndustries-LRS";
  //LRSConfigScreen.model = "flying-dutchman";
  // LRSConfigScreen.model = "thargoid";
  // LRSConfigScreen.spinModel = true; // false;
  // LRSConfigScreen.backgroundSpecial = "SHORT_RANGE_CHART";
  LRSConfigScreen.choicesKey = "activate_LRS_Scanner?";
  LRSConfigScreen.message = "spawn the dutchman scanner?";

  function $callback(choice) {
    if (choice === "1_YES") player.commsMessage("Yay!");
    else if (choice === "2_NO")  player.commsMessage("Boo.");
    else  player.commsMessage("Whut?");
  }

  // mission.runScreen(LRSConfigScreen);
  mission.runScreen(LRSConfigScreen, $callback);
}

// =============================================================================
// key combo catcher:

// check if given guiScreen (either to or from from guiScreenChanged()) can be reached by pressing
// the given key. Key is intended to be $keyCombo[$guiStage].
this.$guiScreenMatchesKey = function(guiScreen, key) {
  for (var i = 0; i < $FKeys[key].length; i++) {
//  $showDebugInfo("  Comparing: "+guiScreen+" <-> "+$FKeys[key][i], 1);
    if (guiScreen == $FKeys[key][i]) {
//    $showDebugInfo("FKeys["+key+"]["+i+"] match: "+guiScreen, 1);
      return true;
    } 
  }
  return false;
}

this.$guiScreenChangeMatchesStage = function(to, from, stage) {
//$showDebugInfo(from + "->"+to+"@$keyCombo["+stage+"]="+$keyCombo[stage], 3);
  if ($guiScreenMatchesKey(to, $keyCombo[stage])) {
    // combo button pressed => check if previous button was correct, too:
    if (stage == 0 || $guiScreenMatchesKey(from,$keyCombo[stage - 1])) { // WARNING: order of tests is important here! (or else (stage - 1) could be negative)
//    $showDebugInfo("stage match: " + stage, 3);
      return true;
    }
  }
  return false;
}

this.$isFinalGUIStage = function() {
  return ($guiStage == 4 || ($guiStage == 3 && $key4th >= 4));
}

this.guiScreenChanged = function(to, from) {
  if ($alwaysPrimable) { return; } // key combo not used anyway
  // if (player.ship.docked) { return; } // only in-flight
  // if (player.ship.equipmentStatus("EQ_GGINDUSTRIES_LONG_RANGE_SCANNER") !== "EQUIPMENT_OK") { return; } // TODO: activate when equipment exists
  if ($guiScreenChangeMatchesStage(to, from, $guiStage)) {
    // yep, we've entered the next stage! increase stage, then check if this is the final stage:
    $guiStage++;
    if ($isFinalGUIStage()) {
      $guiStage = 0; // reset
      $showDebugInfo("entering GGIndustries LRS configuration menu...", 3);
      $showLRSConfigScreen()
    }
  } else {
    $guiStage = 0; // reset
  }
}