Ticket #2141: uses_of_Engine.Console_Write.2.patch

binaries/data/mods/public/gui/common/functions_utility_list.js

@@ -11 +11 @@
 function removeItem (objectName, pos)
 {
     if (Engine.GetGUIObjectByName (objectName) == null)
-        Engine.Console_Write (sprintf(translate("%(functionName)s: %(object)s not found."), { functionName: "removeItem()", object: objectName }));
+        error (sprintf("%(functionName)s: %(object)s not found.", { functionName: "removeItem()", object: objectName }));
 
     var list = Engine.GetGUIObjectByName (objectName).list;
     var selected = Engine.GetGUIObjectByName (objectName).selected;
@@ -41 +41 @@
 function addItem (objectName, pos, value)
 {
     if (Engine.GetGUIObjectByName (objectName) == null)
-        Engine.Console_Write (sprintf(translate("%(functionName)s: %(object)s not found."), { functionName: "addItem()", object: objectName }));
+        error (sprintf("%(functionName)s: %(object)s not found.", { functionName: "addItem()", object: objectName }));
 
     var list = Engine.GetGUIObjectByName (objectName).list;
     var selected = Engine.GetGUIObjectByName (objectName).selected;
@@ -66 +66 @@
 function pushItem (objectName, value)
 {
     if (Engine.GetGUIObjectByName (objectName) == null)
-        Engine.Console_Write (sprintf(translate("%(functionName)s: %(object)s not found."), { functionName: "pushItem()", object: objectName }));
+        error (sprintf("%(functionName)s: %(object)s not found.", { functionName: "pushItem()", object: objectName }));
 
     var list = Engine.GetGUIObjectByName (objectName).list;
     list.push (value);
@@ -81 +81 @@
 function popItem (objectName)
 {
     if (Engine.GetGUIObjectByName (objectName) == null)
-        Engine.Console_Write (sprintf(translate("%(functionName)s: %(object)s not found."), { functionName: "popItem()", object: objectName }));
+        error (sprintf("%(functionName)s: %(object)s not found.", { functionName: "popItem()", object: objectName }));
 
     var selected = Engine.GetGUIObjectByName (objectName).selected;
     removeItem(objectName, getNumItems(objectName)-1);
@@ -98 +98 @@
 function getNumItems (objectName)
 {
     if (Engine.GetGUIObjectByName (objectName) == null)
-        Engine.Console_Write (sprintf(translate("%(functionName)s: %(object)s not found."), { functionName: "getNumItems()", object: objectName }));
+        error (sprintf("%(functionName)s: %(object)s not found.", { functionName: "getNumItems()", object: objectName }));
 
     var list = Engine.GetGUIObjectByName(objectName).list;
     return list.length;
@@ -110 +110 @@
 function getItemValue (objectName, pos)
 {
     if (Engine.GetGUIObjectByName (objectName) == null)
-        Engine.Console_Write (sprintf(translate("%(functionName)s: %(object)s not found."), { functionName: "getItemValue()", object: objectName }));
+        error (sprintf("%(functionName)s: %(object)s not found.", { functionName: "getItemValue()", object: objectName }));
 
     var list = Engine.GetGUIObjectByName(objectName).list;
     return list[pos];
@@ -122 +122 @@
 function getCurrItemValue (objectName)
 {
     if (Engine.GetGUIObjectByName (objectName) == null)
-        Engine.Console_Write (sprintf(translate("%(functionName)s: %(object)s not found."), { functionName: "getCurrItemValue()", object: objectName }));
+        error (sprintf("%(functionName)s: %(object)s not found.", { functionName: "getCurrItemValue()", object: objectName }));
 
     if (Engine.GetGUIObjectByName(objectName).selected == -1)
         return "";
@@ -138 +138 @@
 {
     if (Engine.GetGUIObjectByName(objectName) == null)
     {
-        Engine.Console_Write (sprintf(translate("%(functionName)s: %(object)s not found."), { functionName: "setCurrItemValue()", object: objectName }));
+        error (sprintf("%(functionName)s: %(object)s not found.", { functionName: "setCurrItemValue()", object: objectName }));
         return -1;
     }
 
@@ -158 +158 @@
     }
 
     // Return -2 if failed to find value in list.
-    Engine.Console_Write (sprintf(translate("Requested string '%(string)s' not found in %(object)s's list."), { string: string, object: objectName }));
+    error (sprintf("Requested string '%(string)s' not found in %(object)s's list.", { string: string, object: objectName }));
     return -2;
 }
 

binaries/data/mods/public/gui/common/functions_utility_music.js

@@ -4 +4 @@
 */
 
 
-
-
-// ====================================================================
-
-// Quick run-down of the basic audio commands:
-
-// Save the specified audio file to handle "s".
-// s = new Sound( "audio/music/menu_track.ogg" );
-
-// Play the sound stored at handle "s" one time (it'll be automatically freed when the playback ends):
-// s.play();
-
-// Play the sound stored at handle "s" continuously:
-// s.loop();
-
-// Close "s" and free it from memory (use in conjunction with loop()):
-// s.free();
-
-// Adjust the gain (volume) of a sound (floating point range between 0 (silent) and 1 (max volume)).
-// s.setGain(value);
-
-// ====================================================================
-
-function newRandomSound(soundType, soundSubType, soundPrePath)
-{
-    // Return a random audio file by category, to be assigned to a handle.
-    var randomSoundPath;
-
-    switch (soundType)
-    {
-        case "music":
-            randomSoundPath = "audio/music/"
-        break;
-        case "ambient":
-            randomSoundPath = "audio/ambient/" + soundPrePath + "/";
-        break;
-        case "effect":
-            randomSoundPath = soundPrePath + "/";
-        break;
-        default:
-        break;
-    }
-
-    // Get names of sounds (attack, command, select, hit, pain).
-    // or
-    // Get names of "peace", "menu" (theme) and "battle" tracks.
-    var soundArray = Engine.BuildDirEntList(randomSoundPath, "*" + soundSubType + "*", false);
-    if (soundArray.length == 0)
-    {
-        Engine.Console_Write (sprintf("Failed to find sounds matching '*%(subtype)s*'", { soundSubType: subtype }));
-        return undefined;
-    }
-    // Get a random number within the sound's range.
-    var randomSound = getRandom (0, soundArray.length-1);
-    // Set name of track.
-    var randomFileName = soundArray[randomSound];
-
-    // Build path to random audio file.
-    randomSoundPath = randomFileName;
-
-    //Engine.Console_Write("Playing " + randomSoundPath + " ...");
-
-    switch (soundType)
-    {
-        case "music":
-            return new MusicSound(randomSoundPath);
-        break;
-        case "ambient":
-            return new AmbientSound(randomSoundPath);
-        break;
-        case "effect":
-            Engine.Console_Write(sprintf("am loading effect '*%(path)s*'", { path: randomSoundPath }));
-        break;
-        default:
-        break;
-    }
-    return new Sound(randomSoundPath);
-}
-
 // ====================================================================
 
 function fadeOut (soundHandle, fadeDuration)
@@ -123 +44 @@
 
     return true;
 }
-
-// ====================================================================
-
-
-//const AMBIENT_SOUND = "audio/ambient/dayscape/day_temperate_gen_03.ogg";
-
-
-//const AMBIENT_TEMPERATE = "temperate";
-//var currentAmbient;
-
-//function playRandomAmbient(type)
-//{
-//  switch (type)
-//  {
-//      case AMBIENT_TEMPERATE:
-//          // Seem to need the underscore at the end of "temperate" to avoid crash
-//          // (Might be caused by trying to randomly load day_temperate.xml)
-//          currentAmbient = newRandomSound("ambient", "temperate_", "dayscape");
-//          if (currentAmbient)
-//          {
-//              currentAmbient.loop();
-//              currentAmbient.setGain(0.8);
-//          }
-//          break;
-//
-//      default:
-//          Engine.Console_Write("Unrecognized ambient type: " + type);
-//          break;
-//  }
-//}
-//
-//function stopAmbient()
-//{
-//  if (currentAmbient)
-//  {
-//      currentAmbient.fade(-1, 0.0, 5.0);
-//      currentAmbient = null;
-//  }
-//}
-
-//const BUTTON_SOUND = "audio/interface/ui/ui_button_longclick.ogg";
-//function playButtonSound()
-//{
-//    var buttonSound = new Sound(BUTTON_SOUND);
-//    buttonSound.play();
-//}

binaries/data/mods/public/gui/session/messages.js

@@ -497 +497 @@
         {
             if (msg.context !== "")
             {
-                Engine.Console_Write(sprintf(translate("(%(context)s) * %(user)s %(message)s"), {
-                    context: msg.context,
-                    user: username,
-                    message: message
-                }));
                 formatted = sprintf(translate("(%(context)s) * %(user)s %(message)s"), {
                     context: msg.context,
                     user: "[color=\"" + playerColor + "\"]" + username + "[/color]",
@@ -510 +505 @@
             }
             else
             {
-                Engine.Console_Write(sprintf(translate("* %(user)s %(message)s"), {
-                    user: username,
-                    message: message
-                }));
                 formatted = sprintf(translate("* %(user)s %(message)s"), {
                     user: "[color=\"" + playerColor + "\"]" + username + "[/color]",
                     message: message
@@ -526 +517 @@
             var formattedUserTag = sprintf(translate("<%(user)s>"), { user: "[color=\"" + playerColor + "\"]" + username + "[/color]" })
             if (msg.context !== "")
             {
-                Engine.Console_Write(sprintf(translate("(%(context)s) %(userTag)s %(message)s"), {
-                    context: msg.context,
-                    userTag: userTag,
-                    message: message
-                }));
                 formatted = sprintf(translate("(%(context)s) %(userTag)s %(message)s"), {
                     context: msg.context,
                     userTag: formattedUserTag,
@@ -539 +525 @@
             }
             else
             {
-                Engine.Console_Write(sprintf(translate("%(userTag)s %(message)s"), { userTag: userTag, message: message}));
                 formatted = sprintf(translate("%(userTag)s %(message)s"), { userTag: formattedUserTag, message: message});
             }
         }

binaries/data/mods/public/gui/session/session.js

@@ -888 +888 @@
             break;
 
         default:
-            Engine.Console_Write(sprintf(translate("Unrecognized ambient type: %(ambientType)s"), { ambientType: type }));
+            error(sprintf("Unrecognized ambient type: %(ambientType)s", { ambientType: type }));
             break;
     }
 }