added english tutorial

Author: MattFiler

CMakeLists.txt

@@ -117,7 +117,7 @@ add_executable(
         Source/UI/InteractionPopup.cpp
         Source/UI/InteractionPopup.h
         Source/UI/ActiveSelectionHighlight.cpp
-        Source/UI/ActiveSelectionHighlight.h)
+        Source/UI/ActiveSelectionHighlight.h Source/Scenes/TutorialCore.cpp Source/Scenes/TutorialCore.h)
 
 ## library includes
 target_include_directories(

Source/Characters/Goon.cpp

@@ -148,7 +148,7 @@ void Goon::findNewPOI()
     our_room = &(*global_map->getRooms())[random_room];
     all_pois.clear();
     getAllPOIInRoom(&all_pois, our_room, true);
-    
+
     auto random_index =
       static_cast<unsigned long long>((rand() % (static_cast<int>(all_pois.size()))));
     Point tile_point =

Source/Constants.h

@@ -109,7 +109,8 @@ enum scenes
   GAME_CORE,
   QUIT_GAME,
   GAME_OVER,
-  TUTORIAL
+  TUTORIAL_MENU,
+  TUTORIAL_CORE
 };
 
 // Render index

Source/Managers/SceneManager.cpp

@@ -3,6 +3,7 @@
 #include "../Scenes/GameOver.h"
 #include "../Scenes/MainMenu.h"
 #include "../Scenes/Splashscreen.h"
+#include "../Scenes/TutorialCore.h"
 #include "../Scenes/TutorialMenu.h"
 
 /**
@@ -75,9 +76,12 @@ int SceneManager::updateCurrentScene(double delta_time)
     case scenes::GAME_OVER:
       swapScene(new GameOver);
       break;
-    case scenes::TUTORIAL:
+    case scenes::TUTORIAL_MENU:
       swapScene(new TutorialMenu);
       break;
+    case scenes::TUTORIAL_CORE:
+      swapScene(new TutorialCore);
+      break;
     default:
       return -1; // Unhandled exception
   }

Source/Managers/UIManager.cpp

@@ -100,7 +100,7 @@ void UIManager::initPointOfInterestPopup(CharacterManager* character_manager)
   poi_interaction_popup->setSoundPlayer(sound_player);
   poi_interaction_popup->setActive(false, false);
 
-  active_highlight = new ActiveSelectionHighlight(renderer);
+  active_highlight = new ActiveSelectionHighlight(renderer, camera);
 }
 
 /* Creates all the UI */

Source/Map/GameMap.cpp

@@ -19,7 +19,7 @@ void GameMap::importJSON()
 }
 
 /* Load our map */
-void GameMap::load(ASGE::Renderer* renderer_instance, Camera& camera)
+void GameMap::load(ASGE::Renderer* renderer_instance, Camera* camera)
 {
   // Load map and its initial data
   map_data.load(map_config);
@@ -71,7 +71,7 @@ void GameMap::load(ASGE::Renderer* renderer_instance, Camera& camera)
 void GameMap::render(double delta_time)
 {
   // Render map
-  game_camera.renderSprite(map_data.sprite.get(), delta_time, render_index::MAP_LAYER);
+  game_camera->renderSprite(map_data.sprite.get(), delta_time, render_index::MAP_LAYER);
 
   for (Room& room_to_render : map_data.rooms)
   {
@@ -83,13 +83,13 @@ void GameMap::render(double delta_time)
         if (tile_to_render.hasAnyPointOfInterest() && tile_to_render.getTileSprite()->isVisible())
         {
           // Render POI
-          game_camera.renderSprite(
+          game_camera->renderSprite(
             tile_to_render.getTileSprite().get(), delta_time, render_index::TILE_LAYER);
         }
         if (tile_to_render.hasAnyPointOfInterest() && tile_to_render.getRepairSprite()->isVisible())
         {
           // Render POI repair status
-          game_camera.renderSprite(
+          game_camera->renderSprite(
             tile_to_render.getRepairSprite().get(), delta_time, render_index::TILE_LAYER, false);
         }
       }

Source/Map/GameMap.h

@@ -15,7 +15,7 @@ class GameMap
   GameMap();
   ~GameMap() = default;
 
-  void load(ASGE::Renderer* renderer_instance, Camera& camera);
+  void load(ASGE::Renderer* renderer_instance, Camera* camera);
   void render(double delta_time);
 
   void setUIManager(UIManager* manager) { ui_manager = manager; };
@@ -46,7 +46,7 @@ class GameMap
 
   FileHandler file_handler;
   DebugText debug_text;
-  Camera game_camera;
+  Camera* game_camera = nullptr;
 
   ASGE::Renderer* renderer = nullptr;
   UIManager* ui_manager = nullptr;

Source/Scenes/GameCore.cpp

@@ -25,7 +25,7 @@ bool GameCore::load(ASGE::Renderer* renderer, ASGE::Input* input, SoLoud::Soloud
   file_handler.loadSound(exit_sound, "Interactive_Terminal_End", 0.5f);
 
   // load map
-  game_map.load(renderer, camera);
+  game_map.load(renderer, &camera);
   camera.setMapDims(game_map.getMapSize());
 
   // Pass references out and spawn characters

Source/Scenes/MainMenu.cpp

@@ -56,7 +56,7 @@ void MainMenu::keyHandler(const ASGE::SharedEventData data)
     }
     else if (main_menu.selectedItemWas("tutorial"))
     {
-      next_scene = scenes::TUTORIAL;
+      next_scene = scenes::TUTORIAL_MENU;
       debug_text.print("OPENING TUTORIAL");
     }
     else if (main_menu.selectedItemWas("exit_game"))

Source/Scenes/TutorialCore.cpp

@@ -0,0 +1,91 @@
+#include "TutorialCore.h"
+#include "../Constants.h"
+#include "../Sprites/ScaledSpriteArray.h"
+#include <Engine/Input.h>
+#include <Engine/InputEvents.h>
+#include <Engine/Renderer.h>
+
+/**
+ *   @brief   Loads all variables and sprites for this scene
+ *   @details Initialises all variables and creates all the new
+                         sprites for the scene
+ */
+bool TutorialCore::load(ASGE::Renderer* renderer, ASGE::Input* input, SoLoud::Soloud& player)
+{
+  renderer->setClearColour(ASGE::COLOURS::BLACK);
+
+  // Share the renderer
+  rend = renderer;
+
+  // Load tutorial slides
+  tutorial_slides = new ScaledSpriteArray(tutorial_slide_count);
+  for (int i = 0; i < tutorial_slide_count; i++)
+  {
+    ASGE::Sprite* slide = renderer->createRawSprite();
+    slide->loadTexture("data/UI/TUTORIAL/" + localiser.getLanguage() + "/" + std::to_string(i) +
+                       ".jpg");
+    tutorial_slides->addSprite(*slide);
+  }
+  tutorial_slides->scale(0.6666f);
+  tutorial_slides->xPos(1);
+  tutorial_slides->yPos(-17);
+  tutorial_slides->setCurrentSprite(tutorial_index);
+
+  return true;
+}
+
+/**
+ *   @brief   Changes game state based on inputs
+ *   @details Is called for every input event and will change
+ *   @details the game state / variables etc depending
+ *   @param   data is the event
+ */
+void TutorialCore::keyHandler(const ASGE::SharedEventData data)
+{
+  user_input.registerEvent(static_cast<const ASGE::KeyEvent*>(data.get()));
+  if (user_input.keyReleased("Activate"))
+  {
+    // Increment tutorial slides
+    tutorial_index++;
+    if (tutorial_index <= tutorial_slide_count)
+    {
+      tutorial_slides->setCurrentSprite(tutorial_index);
+    }
+  }
+}
+
+/**
+ *   @brief   Changes game state based on mouse inputs
+ *   @details Is called for every input event and will change
+ *            the game state / variables etc depending
+ *   @param   data is the event, mouse_position the position of the cursor
+ */
+void TutorialCore::mouseHandler(const ASGE::SharedEventData data, Point mouse_position) {}
+
+/**
+ *   @brief   Updates all variables for this scene
+ *   @details Runs every frame and handles all the logic and updates
+ *			 of the active scene
+ *   @param  delta_time is time since last update
+ *   @return  number of the scene to switch to, -1 no change, -2 exit game
+ */
+scenes TutorialCore::update(double delta_time)
+{
+  // Return to main menu when tutorial is over
+  if (tutorial_index >= tutorial_slide_count)
+  {
+    next_scene = scenes::TUTORIAL_MENU;
+  }
+  return next_scene;
+}
+
+/**
+ *   @brief   Renders all sprites for this scene
+ *   @details Runs every frame and draws all the sprites in
+ * 			 order
+ */
+void TutorialCore::render(double delta_time)
+{
+  // Render current tutorial slide
+  rend->renderSprite(tutorial_slides->returnCurrentSprite());
+}