UI commands can now have variables, prefilling prompt command is poss…

…ible. Also: - updated version to 15.12.1 - updated changelog
iiyo · Dec 23, 2015 · eb41585 · eb41585
1 parent add4460
commit eb41585
Show file tree

Hide file tree

Showing 8 changed files with 146 additions and 37 deletions.
diff --git a/bin/WebStoryEngine.js b/bin/WebStoryEngine.js
@@ -7263,7 +7263,7 @@ define("WSE", function (EventBus, assets, commands, dataSources, functions) {
 
     "use strict";
 
-    var WSE = {}, version = "2015.11.1-final.1511061334";
+    var WSE = {}, version = "2015.12.1-final.1512231127";
 
     EventBus.inject(WSE);
 
@@ -10261,7 +10261,10 @@ define("WSE.LoadingScreen", function (transform, CoreObject) {
 
 /* global using */
 
-using("WSE.tools::warn").define("WSE.tools.ui", function (warn) {
+using(
+    "WSE.tools::warn",
+    "WSE.tools::replaceVariables"
+).define("WSE.tools.ui", function (warn, replaceVars) {
 
     "use strict";
 
@@ -10449,8 +10452,8 @@ using("WSE.tools::warn").define("WSE.tools.ui", function (warn) {
         prompt: function (interpreter, args) {
 
             var title, message, submitText, cancelText, callback, root, dialog, oldState;
-            var tEl, mEl, buttonEl, cancelEl, inputEl, container, defaultValue, pause, doNext;
-            var allowEmptyInput, hideCancelButton;
+            var tEl, mEl, buttonEl, cancelEl, inputEl, container, pause, doNext;
+            var allowEmptyInput, hideCancelButton, prefill;
 
             interpreter.waitCounter += 1;
             //             interpreter.keysDisabled += 1;
@@ -10460,14 +10463,14 @@ using("WSE.tools::warn").define("WSE.tools.ui", function (warn) {
             message = args.message || "Please enter something:";
             submitText = args.submitText || "Submit";
             cancelText = args.cancelText || "Cancel";
-            defaultValue = args.defaultValue || "";
             callback = typeof args.callback === "function" ? args.callback : function () {};
             root = args.parent || interpreter.stage;
             pause = args.pause === true ? true : false;
             oldState = interpreter.state;
             doNext = args.doNext === true ? true : false;
             allowEmptyInput = args.allowEmptyInput;
             hideCancelButton = args.hideCancelButton;
+            prefill = args.prefill || "";
 
             if (pause === true) {
                 interpreter.state = "pause";
@@ -10488,8 +10491,8 @@ using("WSE.tools::warn").define("WSE.tools.ui", function (warn) {
             mEl.setAttribute("class", "message");
 
             inputEl = document.createElement("input");
-            inputEl.setAttribute("value", defaultValue);
-            inputEl.value = defaultValue;
+            inputEl.setAttribute("value", prefill);
+            inputEl.value = prefill;
             inputEl.setAttribute("class", "input text");
             inputEl.setAttribute("type", "text");
 
@@ -10536,7 +10539,7 @@ using("WSE.tools::warn").define("WSE.tools.ui", function (warn) {
             buttonEl.setAttribute("class", "submit button");
             buttonEl.setAttribute("type", "button");
 
-            if (!allowEmptyInput && !defaultValue) {
+            if (!allowEmptyInput && !prefill) {
                 buttonEl.disabled = true;
             }
 
@@ -10616,16 +10619,38 @@ using("WSE.tools::warn").define("WSE.tools.ui", function (warn) {
         return function (command, interpreter) {
 
             var title, message, container, key, doNext, hideCancelButton, allowEmptyInput;
-            var submitText, cancelText;
+            var submitText, cancelText, prefill;
 
             title = command.getAttribute("title") || "Input required...";
             message = command.getAttribute("message") || "Your input is required:";
             key = command.getAttribute("var") || null;
-            doNext = command.getAttribute("next") === "false" ? false : true;
-            hideCancelButton = command.getAttribute("hideCancelButton") === "yes" ? true : false;
-            allowEmptyInput = command.getAttribute("allowEmptyInput") === "no" ? false : true;
             submitText = command.getAttribute("submitText") || "";
             cancelText = command.getAttribute("cancelText") || "";
+            prefill = command.getAttribute("prefill") || "";
+
+            allowEmptyInput =
+                replaceVars(command.getAttribute("allowEmptyInput") || "", interpreter) === "no" ?
+                    false :
+                    true;
+
+            hideCancelButton =
+                replaceVars(command.getAttribute("hideCancelButton") || "", interpreter) === "yes" ?
+                    true :
+                    false;
+
+            doNext = replaceVars(command.getAttribute("next") || "", interpreter) === "false" ?
+                false :
+                true;
+
+            if (key !== null) {
+                key = replaceVars(key, interpreter);
+            }
+
+            title = replaceVars(title, interpreter);
+            message = replaceVars(message, interpreter);
+            cancelText = replaceVars(cancelText, interpreter);
+            submitText = replaceVars(submitText, interpreter);
+            prefill = replaceVars(prefill, interpreter);
 
             interpreter.bus.trigger("wse.interpreter.commands." + type, command);
 
@@ -10652,8 +10677,10 @@ using("WSE.tools::warn").define("WSE.tools.ui", function (warn) {
                     allowEmptyInput: allowEmptyInput,
                     hideCancelButton: hideCancelButton,
                     submitText: submitText,
-                    cancelText: cancelText
-            });
+                    cancelText: cancelText,
+                    prefill: prefill
+                }
+            );
 
             return {
                 doNext: true
@@ -12850,16 +12877,27 @@ define("WSE.assets.Background", function (applyUnits, DisplayObject, warn) {
 
 /* global using */
 
-using("WSE.tools.ui", "WSE.tools").define("WSE.commands.alert", function (ui, tools) {
+using(
+    "WSE.tools.ui",
+    "WSE.tools",
+    "WSE.tools::replaceVariables"
+).define("WSE.commands.alert", function (ui, tools, replaceVars) {
 
     function alert (command, interpreter) {
 
         var title, message, doNext;
 
         title = command.getAttribute("title") || "Alert!";
         message = command.getAttribute("message") || "Alert!";
+
+        doNext = replaceVars(command.getAttribute("next") || "", interpreter) === "false" ?
+            false :
+            true;
+
+        message = replaceVars(message, interpreter);
+        title = replaceVars(title, interpreter);
+
         message = tools.textToHtml(message);
-        doNext = command.getAttribute("next") === "false" ? false : true;
 
         interpreter.bus.trigger("wse.interpreter.commands.alert", command);
 

diff --git a/bin/WebStoryEngine.min.js b/bin/WebStoryEngine.min.js
diff --git a/changelog.txt b/changelog.txt
@@ -1,6 +1,22 @@
 ====== WebStory Engine Changelog ======
 
-===== Version 2015.10.x ======
+===== Version 2015.x ======
+
+==== Version 2015.12.1 ====
+
+ * UI commands can now have attributes with variables.
+ * Added a `prefill` attribute to the prompt comannd. It sets a default value.
+
+==== Version 2015.11.1 ====
+
+ * WebStory code can now be embedded in the HTML so that the engine works without a server on local file systems. Take a look at the xml_embedded test for an example of this.
+ * The loading screen can now be customized by adding a `loadingScreen` element to the `settings` section. It can contain an HTML template snippet with these variables: `{$all}`, `{$loaded}`, `{$remaining}` and `{$progress}`
+
+==== Version 2015.10.2 ====
+
+ * Default extensions didn't work with new module system (mainly side-images)
+ * Added a test game for the side-images extension
+ * Added head images for Cecile and Jack for testing
 
 ==== Version 2015.10.1 ====
 

diff --git a/js/WSE.js b/js/WSE.js
@@ -5,7 +5,7 @@ define("WSE", function (EventBus, assets, commands, dataSources, functions) {
 
     "use strict";
 
-    var WSE = {}, version = "2015.11.1-final.1511061334";
+    var WSE = {}, version = "2015.12.1-final.1512231127";
 
     EventBus.inject(WSE);
 

diff --git a/js/commands/alert.js b/js/commands/alert.js
@@ -1,15 +1,26 @@
 /* global using */
 
-using("WSE.tools.ui", "WSE.tools").define("WSE.commands.alert", function (ui, tools) {
+using(
+    "WSE.tools.ui",
+    "WSE.tools",
+    "WSE.tools::replaceVariables"
+).define("WSE.commands.alert", function (ui, tools, replaceVars) {
 
     function alert (command, interpreter) {
 
         var title, message, doNext;
 
         title = command.getAttribute("title") || "Alert!";
         message = command.getAttribute("message") || "Alert!";
+
+        doNext = replaceVars(command.getAttribute("next") || "", interpreter) === "false" ?
+            false :
+            true;
+
+        message = replaceVars(message, interpreter);
+        title = replaceVars(title, interpreter);
+
         message = tools.textToHtml(message);
-        doNext = command.getAttribute("next") === "false" ? false : true;
 
         interpreter.bus.trigger("wse.interpreter.commands.alert", command);
 

diff --git a/js/tools/ui.js b/js/tools/ui.js
@@ -1,6 +1,9 @@
 /* global using */
 
-using("WSE.tools::warn").define("WSE.tools.ui", function (warn) {
+using(
+    "WSE.tools::warn",
+    "WSE.tools::replaceVariables"
+).define("WSE.tools.ui", function (warn, replaceVars) {
 
     "use strict";
 
@@ -188,8 +191,8 @@ using("WSE.tools::warn").define("WSE.tools.ui", function (warn) {
         prompt: function (interpreter, args) {
 
             var title, message, submitText, cancelText, callback, root, dialog, oldState;
-            var tEl, mEl, buttonEl, cancelEl, inputEl, container, defaultValue, pause, doNext;
-            var allowEmptyInput, hideCancelButton;
+            var tEl, mEl, buttonEl, cancelEl, inputEl, container, pause, doNext;
+            var allowEmptyInput, hideCancelButton, prefill;
 
             interpreter.waitCounter += 1;
             //             interpreter.keysDisabled += 1;
@@ -199,14 +202,14 @@ using("WSE.tools::warn").define("WSE.tools.ui", function (warn) {
             message = args.message || "Please enter something:";
             submitText = args.submitText || "Submit";
             cancelText = args.cancelText || "Cancel";
-            defaultValue = args.defaultValue || "";
             callback = typeof args.callback === "function" ? args.callback : function () {};
             root = args.parent || interpreter.stage;
             pause = args.pause === true ? true : false;
             oldState = interpreter.state;
             doNext = args.doNext === true ? true : false;
             allowEmptyInput = args.allowEmptyInput;
             hideCancelButton = args.hideCancelButton;
+            prefill = args.prefill || "";
 
             if (pause === true) {
                 interpreter.state = "pause";
@@ -227,8 +230,8 @@ using("WSE.tools::warn").define("WSE.tools.ui", function (warn) {
             mEl.setAttribute("class", "message");
 
             inputEl = document.createElement("input");
-            inputEl.setAttribute("value", defaultValue);
-            inputEl.value = defaultValue;
+            inputEl.setAttribute("value", prefill);
+            inputEl.value = prefill;
             inputEl.setAttribute("class", "input text");
             inputEl.setAttribute("type", "text");
 
@@ -275,7 +278,7 @@ using("WSE.tools::warn").define("WSE.tools.ui", function (warn) {
             buttonEl.setAttribute("class", "submit button");
             buttonEl.setAttribute("type", "button");
 
-            if (!allowEmptyInput && !defaultValue) {
+            if (!allowEmptyInput && !prefill) {
                 buttonEl.disabled = true;
             }
 
@@ -355,16 +358,38 @@ using("WSE.tools::warn").define("WSE.tools.ui", function (warn) {
         return function (command, interpreter) {
 
             var title, message, container, key, doNext, hideCancelButton, allowEmptyInput;
-            var submitText, cancelText;
+            var submitText, cancelText, prefill;
 
             title = command.getAttribute("title") || "Input required...";
             message = command.getAttribute("message") || "Your input is required:";
             key = command.getAttribute("var") || null;
-            doNext = command.getAttribute("next") === "false" ? false : true;
-            hideCancelButton = command.getAttribute("hideCancelButton") === "yes" ? true : false;
-            allowEmptyInput = command.getAttribute("allowEmptyInput") === "no" ? false : true;
             submitText = command.getAttribute("submitText") || "";
             cancelText = command.getAttribute("cancelText") || "";
+            prefill = command.getAttribute("prefill") || "";
+
+            allowEmptyInput =
+                replaceVars(command.getAttribute("allowEmptyInput") || "", interpreter) === "no" ?
+                    false :
+                    true;
+
+            hideCancelButton =
+                replaceVars(command.getAttribute("hideCancelButton") || "", interpreter) === "yes" ?
+                    true :
+                    false;
+
+            doNext = replaceVars(command.getAttribute("next") || "", interpreter) === "false" ?
+                false :
+                true;
+
+            if (key !== null) {
+                key = replaceVars(key, interpreter);
+            }
+
+            title = replaceVars(title, interpreter);
+            message = replaceVars(message, interpreter);
+            cancelText = replaceVars(cancelText, interpreter);
+            submitText = replaceVars(submitText, interpreter);
+            prefill = replaceVars(prefill, interpreter);
 
             interpreter.bus.trigger("wse.interpreter.commands." + type, command);
 
@@ -391,8 +416,10 @@ using("WSE.tools::warn").define("WSE.tools.ui", function (warn) {
                     allowEmptyInput: allowEmptyInput,
                     hideCancelButton: hideCancelButton,
                     submitText: submitText,
-                    cancelText: cancelText
-            });
+                    cancelText: cancelText,
+                    prefill: prefill
+                }
+            );
 
             return {
                 doNext: true

diff --git a/tests/prompt_command/game.xml → tests/ui_commands/game.xml b/tests/prompt_command/game.xml → tests/ui_commands/game.xml
@@ -19,6 +19,8 @@
 
         <scene id="start">
 
+            <var name="prefill" value="foo!" />
+
             <show asset="bg" />
 
             <prompt 
@@ -46,6 +48,21 @@
                 hideCancelButton="yes"
                 allowEmptyInput="no" />
 
+            <prompt
+                title="Prompt with ({$prefill}) variables."
+                message="This prompt has a default ({$prefill}) value loaded from a variable."
+                var="foo"
+                prefill="{$prefill}" />
+
+            <alert
+                title="An alert with {$prefill}"
+                message="Its message has {$prefill}" />
+
+            <confirm
+                var="foo"
+                title="A confirm with {$prefill}"
+                message="Its message has {$prefill}" />
+
             <restart />
         </scene>
 

diff --git a/tests/prompt_command/index.html → tests/ui_commands/index.html b/tests/prompt_command/index.html → tests/ui_commands/index.html