Skip to content

Commit

Permalink
Rollup and integration of framework library updates from Cartographer…
Browse files Browse the repository at this point in the history 
… @AEA7EE
  • Loading branch information
@Earthfiredrake
Earthfiredrake committed Aug 16, 2017
1 parent cdfc761 commit 9052a65
Show file tree
Hide file tree
Showing 4 changed files with 81 additions and 43 deletions.
10 changes: 2 additions & 8 deletions efd/LoreHound/LoreHound.as
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,8 @@ class efd.LoreHound.LoreHound extends Mod {
var arConfig:ConfigWrapper = AutoReport.Initialize(ModName, Version, DevName);

InitializeConfig(arConfig);
LoadLoreCategories();

IndexFile = LoadXmlAsynch("CategoryIndex", Delegate.create(this, CategoryIndexLoaded));

TraceMsg("Initialized");
}
Expand Down Expand Up @@ -166,13 +167,6 @@ class efd.LoreHound.LoreHound extends Mod {
}
}

private function LoadLoreCategories():Void {
IndexFile = new XML();
IndexFile.ignoreWhite = true;
IndexFile.onLoad = Delegate.create(this, CategoryIndexLoaded);
IndexFile.load("LoreHound\\CategoryIndex.xml");
}

private function CategoryIndexLoaded(success:Boolean):Void {
if (success) {
CategoryIndex = new Array();
Expand Down
2 changes: 1 addition & 1 deletion efd/LoreHound/lib/ConfigWrapper.as
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ class efd.LoreHound.lib.ConfigWrapper {
if (value instanceof Point) { return value.clone(); }
if (value instanceof Array) {
var clone = new Array();
for (var i:Number; i < value.length; ++i) {
for (var i:Number = 0; i < value.length; ++i) {
clone[i] = CloneValue(value[i]);
}
return clone;
Expand Down
13 changes: 7 additions & 6 deletions efd/LoreHound/lib/LocaleManager.as
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,7 @@ class efd.LoreHound.lib.LocaleManager {

SignalStringsLoaded = new Signal();

StringFile = new XML();
StringFile.ignoreWhite = true;
StringFile.onLoad = StringsLoaded;
StringFile.load(fileName);
StringFile = Mod.LoadXmlAsynch(fileName, StringsLoaded);
}

public static function GetString(category:String, tag:String):String { return StringDict[category][tag]; }
Expand All @@ -49,10 +46,9 @@ class efd.LoreHound.lib.LocaleManager {
var category:Object = new Object;
for (var j:Number = 0; j < categoryXML.childNodes.length; ++j) {
var entry:XMLNode = categoryXML.childNodes[j];
var localeStr:String = entry.attributes[CurrentLocale];
// Load the localized string if available, or default to English
// English being the most likely to be both available and understood
category[entry.attributes.tag] = localeStr != undefined ? localeStr : entry.attributes.en;
category[entry.attributes.tag] = GetLocaleString(entry);
}
StringDict[categoryXML.attributes.name] = category;
}
Expand All @@ -64,6 +60,11 @@ class efd.LoreHound.lib.LocaleManager {
SignalStringsLoaded.Emit(success);
}

public static function GetLocaleString(xml:XMLNode):String {
var localeStr:String = xml.attributes[CurrentLocale];
return localeStr ? localeStr : xml.attributes.en;
}

private static var StringFile:XML;
public static var SignalStringsLoaded:Signal; // (success:Boolean):Void

Expand Down
99 changes: 71 additions & 28 deletions efd/LoreHound/lib/Mod.as
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,10 @@ class efd.LoreHound.lib.Mod {
// Any overiden functions are wrapped in a Delegate(this) before being passed along
// They unfortunately cannot be wrapped in delegates in advance, as initialization requires compile constants
// Remaining values are applied as initializers prior to construction
// The following values are added to it and should not be overriden or conflicted with:
// The following values are added to it and should not be overriden or conflicted with:
// ModName, DevName, HostMovie, Config
// Values which may be overriden by the mod:
// UpdateState:Function Sets the icon frame to be displayed based on current mod state
// UpdateState:Function Sets the icon frame to be displayed based on current mod state
// LeftMouseInfo:Object Mouse handler as described below
// RightMouseInfo:Object Mouse handler as described below
// A mouse handler object defines two functions, neither of which should specify which mouse button was involved:
Expand All @@ -100,6 +100,8 @@ class efd.LoreHound.lib.Mod {
TraceMsg = Delegate.create(this, _TraceMsg);
LogMsg = Delegate.create(this, _LogMsg);

LoadXmlAsynch = Delegate.create(this, _LoadXmlAsynch);

GlobalDebugDV = DistributedValue.Create(DVPrefix + "DebugMode");
GlobalDebugDV.SignalChanged.Connect(SetDebugMode, this);
DebugTrace = modInfo.Trace || GlobalDebugDV.GetValue();
Expand All @@ -126,7 +128,7 @@ class efd.LoreHound.lib.Mod {
ModEnabledDV.SignalChanged.Connect(ChangeModEnabled, this);
}

LocaleManager.Initialize(ModName + "/Strings.xml");
LocaleManager.Initialize("Strings");
LocaleManager.SignalStringsLoaded.Connect(StringsLoaded, this);

if ((modInfo.GuiFlags & ef_ModGui_Console) != ef_ModGui_Console) {
Expand All @@ -139,12 +141,14 @@ class efd.LoreHound.lib.Mod {
ConfigWindowEscTrigger = new EscapeStackNode();
ShowConfigDV = DistributedValue.Create(ConfigWindowVarName);
ShowConfigDV.SetValue(false);
ShowConfigDV.SignalChanged.Connect(ShowConfigWindow, this);
ShowConfigDV.SignalChanged.Connect(ShowConfigWindowChanged, this);
}

if (modInfo.Type == e_ModType_Interface) {
ShowInterface = false;
InterfaceWindowEscTrigger = new EscapeStackNode();
ShowInterfaceDV = DistributedValue.Create(InterfaceWindowVarName);
ShowInterfaceDV.SetValue(false);
ShowInterfaceDV.SignalChanged.Connect(ShowInterfaceWindowChanged, this);
}
}
InitializeModConfig(modInfo);
Expand Down Expand Up @@ -174,6 +178,8 @@ class efd.LoreHound.lib.Mod {
LoadComplete();
}

// TODO: Failure to clear the SystemsLoaded object seems to crash reliably when the interface window opens
// Investigate and fix. Low priority, currently SystemsLoaded is being cleared/largely unused
private function LoadComplete():Void {
delete SystemsLoaded; // No longer required
UpdateInstall();
Expand All @@ -190,7 +196,7 @@ class efd.LoreHound.lib.Mod {
Config.NewSetting("Installed", false); // Will always be saved as true, only remains false if settings do not exist
if (ModEnabledDV != undefined) { Config.NewSetting("Enabled", true); } // Whether mod is enabled by the player

if (ShowInterface != undefined) { Config.NewSetting("InterfaceWindowPosition", new Point(20, 30)); }
if (ShowInterfaceDV != undefined) { Config.NewSetting("InterfaceWindowPosition", new Point(20, 30)); }
if (ShowConfigDV != undefined) { Config.NewSetting("ConfigWindowPosition", new Point(20, 30)); }

Config.SignalConfigLoaded.Connect(ConfigLoaded, this);
Expand Down Expand Up @@ -357,7 +363,7 @@ class efd.LoreHound.lib.Mod {

if (!iconData.LeftMouseInfo) {
if (modInfo.Type == e_ModType_Interface) {
iconData.LeftMouseInfo = { Action : Delegate.create(this, ToggleInterface), Tooltip : ToggleInterfaceTooltip };
iconData.LeftMouseInfo = { Action : Delegate.create(this, ToggleInterfaceWindow), Tooltip : ToggleInterfaceTooltip };
} else if (modInfo.Type == e_ModType_Reactive && ShowConfigDV != undefined) {
iconData.LeftMouseInfo = { Action : Delegate.create(this, ToggleConfigWindow), Tooltip : ToggleConfigTooltip };
}
Expand Down Expand Up @@ -390,18 +396,22 @@ class efd.LoreHound.lib.Mod {
return LocaleManager.GetString("GUI", Config.GetValue("Enabled") ? "TooltipModOff" : "TooltipModOn");
}

private function ToggleConfigWindow():Void { ShowConfigDV.SetValue(!ShowConfigDV.GetValue()); }
private function ToggleConfigWindow():Void {
if (!ShowConfigDV.GetValue()) {
ShowConfigDV.SetValue(true);
} else {
TriggerWindowClose.apply(ConfigWindowClip);
}
}
private static function ToggleConfigTooltip():String { return LocaleManager.GetString("GUI", "TooltipShowSettings"); }

private function ToggleInterface():Void {
if (!ShowInterface) { // Show the interface
if (InterfaceWindowClip == null) {
InterfaceWindowClip = OpenWindow("InterfaceWindow", InterfaceWindowLoaded, CloseInterfaceWindow, InterfaceWindowEscTrigger);
}
} else { // Close the interface
CloseInterfaceWindow();
private function ToggleInterfaceWindow():Void {
if (! ShowInterfaceDV.GetValue()) {// Show the interface
ShowInterfaceDV.SetValue(true);
} else {
// Close the interface;
TriggerWindowClose.apply(InterfaceWindowClip);
}
ShowInterface == !ShowInterface;
}
private static function ToggleInterfaceTooltip():String { return LocaleManager.GetString("GUI", "TooltipShowInterface"); }

Expand All @@ -424,15 +434,15 @@ class efd.LoreHound.lib.Mod {
clip._x = position.x;
clip._y = position.y;

escNode.SignalEscapePressed.Connect(closeEvent, this);
escNode.SignalEscapePressed.Connect(TriggerWindowClose, clip);
EscapeStack.Push(escNode);
clip.SignalClose.Connect(closeEvent, this);

return clip;
}

private function CloseWindow(windowClip:MovieClip, windowName:String, closeEvent:Function, escNode:EscapeStackNode):Void {
escNode.SignalEscapePressed.Disconnect(closeEvent, this);
private function WindowClosed(windowClip:MovieClip, windowName:String, escNode:EscapeStackNode):Void {
escNode.SignalEscapePressed.Disconnect(TriggerWindowClose, windowClip);

ReturnWindowToVisibleBounds(windowClip, Config.GetDefault(windowName + "Position"));
Config.SetValue(windowName + "Position", new Point(windowClip._x, windowClip._y));
Expand All @@ -452,21 +462,27 @@ class efd.LoreHound.lib.Mod {
}
}

private function TriggerWindowClose():Void {
var target:Object = this;
target.SignalClose.Emit(target);
target.m_Content.Close();
}

private function SetWindowScale(scaleDV:DistributedValue):Void {
var scale:Number = scaleDV.GetValue() * 100;
var target:Object = this;
target._xscale = scale;
target._yscale = scale;
}

private function ShowConfigWindow(dv:DistributedValue):Void {
private function ShowConfigWindowChanged(dv:DistributedValue):Void {
if (dv.GetValue()) { // Open window
if (ConfigWindowClip == null) {
ConfigWindowClip = OpenWindow("ConfigWindow", ConfigWindowLoaded, CloseConfigWindow, ConfigWindowEscTrigger);
}
} else { // Close window
if (ConfigWindowClip != null) {
CloseWindow(ConfigWindowClip, "ConfigWindow", CloseConfigWindow, ConfigWindowEscTrigger);
WindowClosed(ConfigWindowClip, "ConfigWindow", ConfigWindowEscTrigger);
ConfigWindowClip = null;
}
}
Expand All @@ -476,15 +492,24 @@ class efd.LoreHound.lib.Mod {

private function CloseConfigWindow():Void { ShowConfigDV.SetValue(false); }

private function InterfaceWindowLoaded():Void { }

private function CloseInterfaceWindow():Void {
if (InterfaceWindowClip != null) {
CloseWindow(InterfaceWindowClip, "InterfaceWindow", CloseInterfaceWindow, InterfaceWindowEscTrigger);
InterfaceWindowClip = null;
private function ShowInterfaceWindowChanged(dv:DistributedValue):Void {
if (dv.GetValue()) { // Open window
if (InterfaceWindowClip == null)
{
InterfaceWindowClip = OpenWindow("InterfaceWindow", InterfaceWindowLoaded, CloseInterfaceWindow, InterfaceWindowEscTrigger);
}
} else {// Close window
if (InterfaceWindowClip != null) {
WindowClosed(InterfaceWindowClip, "InterfaceWindow", InterfaceWindowEscTrigger);
InterfaceWindowClip = null;
}
}
}

private function InterfaceWindowLoaded():Void { }

private function CloseInterfaceWindow():Void { ShowInterfaceDV.SetValue(false); }

// The game itself toggles the mod's activation state (based on modules.xml criteria)
public function GameToggleModEnabled(state:Boolean, archive:Archive) {
if (!state) {
Expand All @@ -499,6 +524,22 @@ class efd.LoreHound.lib.Mod {

private function SetDebugMode(dv:DistributedValue):Void { DebugTrace = dv.GetValue(); }

/// Data file loading

// Loads an XML file from a path local to the mod's directory
// The '.xml' suffix is added if not present
public function _LoadXmlAsynch(fileName:String, callback:Function):XML {
if (fileName.substr(-4) != ".xml") {
fileName += ".xml";
}
var loader:XML = new XML();
loader.ignoreWhite = true;
loader.onLoad = callback;
loader.load(ModName + "\\" + fileName);
return loader;
}
public static var LoadXmlAsynch:Function; // Static delegate

/// Text output utility functions
// Options object supports the following properties:
// system:String - Name of subsystem to include in the prefix
Expand Down Expand Up @@ -584,6 +625,7 @@ class efd.LoreHound.lib.Mod {

public function get Enabled():Boolean { return _Enabled; }
public function set Enabled(value:Boolean):Void {
// TODO: This check for Config("Enabled") should be cleaned up for cases where it doesn't exist
value = EnabledByGame && Config.GetValue("Enabled");
if (value != _Enabled) { // State changed
_Enabled = value;
Expand All @@ -595,6 +637,7 @@ class efd.LoreHound.lib.Mod {
public function get ModLoadedVarName():String { return DVPrefix + ModName + "Loaded"; }
public function get ModEnabledVarName():String { return DVPrefix + ModName + "Enabled"; }
public function get ConfigWindowVarName():String { return DVPrefix + "Show" + ModName + "ConfigUI"; }
public function get InterfaceWindowVarName():String { return DVPrefix + "Show" + ModName + "Interface"; }

// Customize based on mod authorship
public static var DevName:String = "Peloprata";
Expand All @@ -618,7 +661,7 @@ class efd.LoreHound.lib.Mod {
private var ConfigWindowClip:MovieClip = null;
private var ConfigWindowEscTrigger:EscapeStackNode;

private var ShowInterface:Boolean;
private var ShowInterfaceDV:DistributedValue; // Provided as DV for /setoption force opening of interface
private var InterfaceWindowClip:MovieClip = null;
private var InterfaceWindowEscTrigger:EscapeStackNode;

Expand Down

0 comments on commit 9052a65

Please sign in to comment.