Added ConsoleInput C++ example. Closes #159.

When setting the number of rows, ensure Console sets the text style if available, so that the row container appears immediately with the correct height.

Source/Engine/Engine/Console.cpp

@@ -111,7 +111,8 @@ void Console::SetVisible(bool enable)
     if (enable)
     {
         // Check if we have handler for E_CONSOLECOMMAND every time here in case the handler is being added later dynamically
-        bool hasConsoleCommandEventHandler = context_->GetEventReceivers(this, E_CONSOLECOMMAND) != 0 || context_->GetEventReceivers(E_CONSOLECOMMAND) != 0;
+        bool hasConsoleCommandEventHandler = context_->GetEventReceivers(this, E_CONSOLECOMMAND) != 0 ||
+            context_->GetEventReceivers(E_CONSOLECOMMAND) != 0;
         lineEdit_->SetVisible(hasConsoleCommandEventHandler);
         if (hasConsoleCommandEventHandler)
             GetSubsystem<UI>()->SetFocusElement(lineEdit_);
@@ -144,9 +145,15 @@ void Console::SetNumRows(unsigned rows)
     }
     else
     {
-        // We have less, add more rows at the bottom (text element style will be set initially in SetDefaultStyle() when the stylesheet is available and subsequently in HandlePostUpdate())
+        // We have less, add more rows at the bottom
         for (int i = 0; i > delta; --i)
-            rowContainer_->CreateChild<Text>();
+        {
+            Text* text = rowContainer_->CreateChild<Text>();
+            // If style is already set, apply here to ensure proper height of the console when
+            // amount of rows is changed
+            if (background_->GetDefaultStyle())
+                text->SetStyle("ConsoleText");
+        }
     }
 
     rowContainer_->EnableLayoutUpdate();

Source/Samples/26_ConsoleInput/CMakeLists.txt

@@ -0,0 +1,33 @@
+#
+# Copyright (c) 2008-2014 the Urho3D project.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+
+# Define target name
+set (TARGET_NAME 26_ConsoleInput)
+
+# Define source files
+define_source_files (EXTRA_H_FILES ${COMMON_SAMPLE_H_FILES})
+
+# Setup target with resource copying
+setup_main_executable ()
+
+# Setup test cases
+add_test (NAME ${TARGET_NAME} COMMAND ${TARGET_NAME} -timeout ${TEST_TIME_OUT})

Source/Samples/26_ConsoleInput/ConsoleInput.cpp

@@ -0,0 +1,257 @@
+//
+// Copyright (c) 2008-2014 the Urho3D project.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+//
+
+#include "Console.h"
+#include "CoreEvents.h"
+#include "Engine.h"
+#include "EngineEvents.h"
+#include "Input.h"
+#include "Log.h"
+#include "ProcessUtils.h"
+#include "Random.h"
+#include "Time.h"
+
+#include "ConsoleInput.h"
+
+#include "DebugNew.h"
+
+// Expands to this example's entry-point
+DEFINE_APPLICATION_MAIN(ConsoleInput)
+
+// Hunger level descriptions
+String hungerLevels[] = {
+    "bursting",
+    "well-fed",
+    "fed",
+    "hungry",
+    "very hungry",
+    "starving"
+};
+
+// Urho threat level descriptions
+String urhoThreatLevels[] = {
+    "Suddenly Urho appears from a dark corner of the fish tank",
+    "Urho seems to have his eyes set on you",
+    "Urho is homing in on you mercilessly"
+};
+
+ConsoleInput::ConsoleInput(Context* context) :
+    Sample(context)
+{
+}
+
+void ConsoleInput::Start()
+{
+    // Execute base class startup
+    Sample::Start();
+    
+    // Subscribe to console commands and the frame update
+    SubscribeToEvent(E_CONSOLECOMMAND, HANDLER(ConsoleInput, HandleConsoleCommand));
+    SubscribeToEvent(E_UPDATE, HANDLER(ConsoleInput, HandleUpdate));
+    
+    // Hide logo to make room for the console
+    SetLogoVisible(false);
+    
+    // Show the console by default, make it large. Console will show the text edit field when there is at least one
+    // subscriber for the console command event
+    Console* console = GetSubsystem<Console>();
+    console->SetNumRows(GetSubsystem<Graphics>()->GetHeight() / 16);
+    console->SetVisible(true);
+    
+    // Open the operating system console window (for stdin / stdout) if not open yet
+    OpenConsoleWindow();
+    
+    // Initialize game and print the welcome message
+    StartGame();
+    
+    // Randomize from system clock
+    SetRandomSeed(Time::GetSystemTime());
+}
+
+void ConsoleInput::HandleConsoleCommand(StringHash eventType, VariantMap& eventData)
+{
+    using namespace ConsoleCommand;
+    
+    HandleInput(eventData[P_COMMAND].GetString());
+}
+
+void ConsoleInput::HandleUpdate(StringHash eventType, VariantMap& eventData)
+{
+    // Check if there is input from stdin
+    String input = GetConsoleInput();
+    if (input.Length())
+        HandleInput(input);
+}
+
+void ConsoleInput::StartGame()
+{
+    Print("Welcome to the Urho adventure game! You are the newest fish in the tank; your\n"
+          "objective is to survive as long as possible. Beware of hunger and the merciless\n"
+          "predator cichlid Urho, who appears from time to time. Evading Urho is easier\n"
+          "with an empty stomach. Type 'help' for available commands.\n");
+    
+    gameOn_ = true;
+    foodAvailable_ = false;
+    eatenLastTurn_ = false;
+    numTurns_ = 0;
+    hunger_ = 2;
+    urhoThreat_ = 0;
+}
+
+void ConsoleInput::EndGame(const String& message)
+{
+    Print(message);
+    Print("Game over! You survived " + String(numTurns_) + " turns.\n"
+          "Do you want to play again (Y/N)?\n");
+    
+    gameOn_ = false;
+}
+
+void ConsoleInput::Advance()
+{
+    ++numTurns_;
+    if ((numTurns_ & 3) == 0 && !eatenLastTurn_)
+    {
+        ++hunger_;
+        if (hunger_ > 5)
+        {
+            EndGame("You have died from starvation!\n");
+            return;
+        }
+        else
+            Print("You are " + hungerLevels[hunger_] + ".\n");
+    }
+    
+    eatenLastTurn_ = false;
+    
+    if (foodAvailable_)
+    {
+        Print("The floating pieces of fish food are quickly eaten by other fish in the tank.\n");
+        foodAvailable_ = false;
+    }
+    else if (Random() < 0.15f)
+    {
+        Print("The overhead dispenser drops pieces of delicious fish food to the water!\n");
+        foodAvailable_ = true;
+    }
+    
+    if (urhoThreat_ > 0)
+    {
+        ++urhoThreat_;
+        if (urhoThreat_ > 3)
+        {
+            EndGame("Urho has eaten you!\n");
+            return;
+        }
+    }
+    else if (urhoThreat_ < 0)
+        ++urhoThreat_;
+    if (urhoThreat_ == 0 && Random() < 0.2f)
+        ++urhoThreat_;
+    
+    if (urhoThreat_ > 0)
+        Print(urhoThreatLevels[urhoThreat_ - 1] + ".\n");
+}
+
+void ConsoleInput::HandleInput(const String& input)
+{
+    String inputLower = input.ToLower().Trimmed();
+    if (inputLower.Empty())
+    {
+        Print("Empty input given!\n");
+        return;
+    }
+    
+    if (inputLower == "quit" || inputLower == "exit")
+        GetSubsystem<Engine>()->Exit();
+    
+    if (gameOn_)
+    {
+        // Game is on
+        if (inputLower == "help")
+            Print("The following commands are available: 'eat', 'hide', 'wait', 'score', 'quit'.\n");
+        else if (inputLower == "score")
+            Print("You have survived " + String(numTurns_) + " turns.\n");
+        else if (inputLower == "eat")
+        {
+            if (foodAvailable_)
+            {
+                Print("You eat several pieces of fish food.\n");
+                foodAvailable_ = false;
+                eatenLastTurn_ = true;
+                hunger_ -= (hunger_ > 3) ? 2 : 1;
+                if (hunger_ < 0)
+                {
+                    EndGame("You have killed yourself by over-eating!\n");
+                    return;
+                }
+                else
+                    Print("You are now " + hungerLevels[hunger_] + ".\n");
+            }
+            else
+                Print("There is no food available.\n");
+            
+            Advance();
+        }
+        else if (inputLower == "wait")
+        {
+            Print("Time passes...\n");
+            Advance();
+        }
+        else if (inputLower == "hide")
+        {
+            if (urhoThreat_)
+            {
+                bool evadeSuccess = hunger_ > 2 || Random() < 0.5f;
+                if (evadeSuccess)
+                {
+                    Print("You hide behind the thick bottom vegetation, until Urho grows bored.\n");
+                    urhoThreat_ = -2;
+                }
+                else
+                    Print("Your movements are too slow; you are unable to hide from Urho.\n");
+            }
+            else
+                Print("There is nothing to hide from.\n");
+            
+            Advance();
+        }
+        else
+            Print("Cannot understand the input " + input + ".\n");
+    }
+    else
+    {
+        // Game is over, wait for (y)es or (n)o reply
+        if (inputLower[0] == 'y')
+            StartGame();
+        else if (inputLower[0] == 'n')
+            GetSubsystem<Engine>()->Exit();
+        else
+            Print("Please answer 'y' or 'n'.\n");
+    }
+}
+
+void ConsoleInput::Print(const String& output)
+{
+    // Logging appears both in the engine console and stdout
+    LOGRAW(output);
+}

Source/Samples/26_ConsoleInput/ConsoleInput.h

@@ -0,0 +1,70 @@
+//
+// Copyright (c) 2008-2014 the Urho3D project.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+//
+
+#pragma once
+
+#include "Sample.h"
+
+/// Console input example.
+/// This sample demonstrates:
+///     - Implementing a crude text adventure game, which accepts input both through the engine console,
+///       and standard input.
+class ConsoleInput : public Sample
+{
+    OBJECT(ConsoleInput);
+
+public:
+    /// Construct.
+    ConsoleInput(Context* context);
+
+    /// Setup after engine initialization and before running the main loop.
+    virtual void Start();
+
+private:
+    /// Handle console command event.
+    void HandleConsoleCommand(StringHash eventType, VariantMap& eventData);
+    /// Handle frame update event.
+    void HandleUpdate(StringHash eventType, VariantMap& eventData);
+    /// Print intro message and initialize the game state.
+    void StartGame();
+    /// Print game over message.
+    void EndGame(const String& message);
+    /// Advance the game state.
+    void Advance();
+    /// Handle user input either from the engine console or standard input.
+    void HandleInput(const String& input);
+    /// Print text to the engine console and standard output.
+    void Print(const String& output);
+    
+    /// Game on flag.
+    bool gameOn_;
+    /// Food dispensed flag.
+    bool foodAvailable_;
+    /// Whether ate on the previous turn.
+    bool eatenLastTurn_;
+    /// Number of turns survived.
+    int numTurns_;
+    /// Player's hunger level.
+    int hunger_;
+    /// Threat of Urho level.
+    int urhoThreat_;
+};

Source/Samples/CMakeLists.txt

@@ -63,3 +63,4 @@ endif ()
 add_subdirectory (23_Water)
 add_subdirectory (24_Urho2DSprite)
 add_subdirectory (25_Urho2DParticle)
+add_subdirectory (26_ConsoleInput)