Merge basic and quickbasic into a single scenario with more settings.

Author: daid

scripts/locale/scenario_01_quick_basic.en.po

@@ -11,6 +11,14 @@
 -- Enemies[Normal|Default]: Normal amount of enemies. Recommended for a normal crew.
 -- Enemies[Hard]: More enemies. Recommended if you have multiple player-controlled ships.
 -- Enemies[Extreme]: Many enemies. Inexperienced player crews will pretty surely be overwhelmed.
+-- Setting[Time]: Sets up how much time the players have for the scenario
+-- Time[Unlimited|Default]: No time limit
+-- Time[20min]: Automatic loss after 20 minutes
+-- Time[30min]: Automatic loss after 30 minutes
+-- Time[60min]: Automatic loss after 60 minutes
+-- Setting[PlayerShip]: Sets the default player ship
+-- PlayerShip[Atlantis|Default]: Powerful ship with sidewards missile tubes. Requires more advanced play.
+-- PlayerShip[Phobos M3P]: Simpler, less powerful ship. But easier to handler. Recommended for new crews.
 
 --- Scenario
 -- @script scenario_00_basic
@@ -30,8 +38,81 @@ require("utils.lua")
 local enemyList
 local friendlyList
 local stationList
+local playerList
 local addWavesToGMPosition      -- If set to true, add wave will require GM to click on the map to position, where the wave should be spawned. 
 
+local gametimeleft = nil -- Maximum game time in seconds.
+local timewarning = nil -- Used for checking when to give a warning, and to update it so the warning happens once.
+
+local ship_names = {
+    "SS Epsilon",
+    "Ironic Gentleman",
+    "Binary Sunset",
+    "USS Roddenberry",
+    "Earthship Sagan",
+    "Explorer",
+    "ISV Phantom",
+    "Keelhaul",
+    "Peacekeeper",
+    "WarMonger",
+    "Death Bringer",
+    "Executor",
+    "Excaliber",
+    "Voyager",
+    "Khan's Wrath",
+    "Kronos' Savior",
+    "HMS Captor",
+    "Imperial Stature",
+    "ESS Hellfire",
+    "Helen's Fury",
+    "Venus' Light",
+    "Blackbeard's Way",
+    "ISV Monitor",
+    "Argent",
+    "Echo One",
+    "Earth's Might",
+    "ESS Tomahawk",
+    "Sabretooth",
+    "Hiro-maru",
+    "USS Nimoy",
+    "Earthship Tyson",
+    "Destiny's Tear",
+    "HMS SuperNova",
+    "Alma del Terra",
+    "DreadHeart",
+    "Devil's Maw",
+    "Cougar's Claw",
+    "Blood-oath",
+    "Imperial Fist",
+    "HMS Promise",
+    "ESS Catalyst",
+    "Hercules Ascendant",
+    "Heavens Mercy",
+    "HMS Adams",
+    "Explorer",
+    "Discovery",
+    "Stratosphere",
+    "USS Kelly",
+    "HMS Honour",
+    "Devilfish",
+    "Minnow",
+    "Earthship Nye",
+    "Starcruiser Solo",
+    "Starcruiser Reynolds",
+    "Starcruiser Hunt",
+    "Starcruiser Lipinski",
+    "Starcruiser Tylor",
+    "Starcruiser Kato",
+    "Starcruiser Picard",
+    "Starcruiser Janeway",
+    "Starcruiser Archer",
+    "Starcruiser Sisko",
+    "Starcruiser Kirk",
+    "Aluminum Falcon",
+    "SS Essess",
+    "Jenny"
+}
+
 --- Wrapper to adding an enemy wave
 --
 -- This wrapper either calls addWaveInner directly (when on random wave positioning)
@@ -211,11 +292,17 @@ end
 --- Initialize scenario.
 function init()
     -- Spawn a player Atlantis.
-    player = PlayerSpaceship():setFaction("Human Navy"):setTemplate("Atlantis")
+    player = PlayerSpaceship():setFaction("Human Navy"):setTemplate(getScenarioSetting("PlayerShip"))
+    player:setCallSign(ship_names[irandom(1, #ship_names)])
 
     enemyList = {}
     friendlyList = {}
     stationList = {}
+    playerList = {player}
+
+    onNewPlayerShip(function(ship)
+        table.insert(playerList, ship)
+    end)
 
     addWavesToGMPosition = false
 
@@ -282,6 +369,17 @@ function init()
     local enemy_group_count = counts[getScenarioSetting("Enemies")]
     assert(enemy_group_count, "unknown enemies setting: " .. getScenarioSetting("Enemies") .. " could not set enemy_group_count")
 
+    local timesetting = {
+        ["Unlimited"] = nil,
+        ["20min"] = 20 * 60,
+        ["30min"] = 30 * 60,
+        ["60min"] = 60 * 60,
+    }
+    gametimeleft = timesetting[getScenarioSetting("Time")]
+    if gametimeleft ~= nil then
+        timewarning = gametimeleft
+    end
+
     -- If not in the Empty variation, spawn the corresponding number of random
     -- enemy waves at distributed random headings and semi-random distances
     -- relative to the players' spawn point.
@@ -366,25 +464,46 @@ function init()
 
     -- Spawn random neutral transports.
     Script():run("util_random_transports.lua")
+
+
+    local station = friendlyList[1]
+    if gametimeleft ~= nil then
+        station:sendCommsMessage(
+            player, string.format(_([[%s, your objective is to fend off the incoming Kraylor attack.
+
+Please inform your Captain and crew that you have a total of %d minutes for this mission.
+
+The mission started at the arrival of this message.
+
+Good luck.]]), player:getCallSign(), gametimeleft / 60)
+        )
+    else
+        station:sendCommsMessage(
+            player, string.format(_([[%s, your objective is to fend off the incoming Kraylor attack.
+
+Good luck.]]), player:getCallSign())
+        )
+    end
+end
+
+function countValid(objectList)
+    local object_count = 0
+    for i_, object in ipairs(objectList) do
+        if object:isValid() then
+            object_count = object_count + 1
+        end
+    end
+    return object_count
 end
 
 --- Update.
 --
 -- @tparam number delta the time delta (in seconds)
 function update(delta)
     -- Count all surviving enemies and allies.
-    local enemy_count = 0
-    for i_, enemy in ipairs(enemyList) do
-        if enemy:isValid() then
-            enemy_count = enemy_count + 1
-        end
-    end
-    local friendly_count = 0
-    for i_, friendly in ipairs(friendlyList) do
-        if friendly:isValid() then
-            friendly_count = friendly_count + 1
-        end
-    end
+    local enemy_count = countValid(enemyList)
+    local friendly_count = countValid(friendlyList)
+    local player_count = countValid(playerList)
 
     -- If not playing the Empty variation, declare victory for the
     -- Humans (players) once all enemies are destroyed. Note that players can win
@@ -394,11 +513,44 @@ function update(delta)
     -- a Human victory.
     if (enemy_count == 0 and getScenarioSetting("Enemies") ~= "Empty") then
         victory("Human Navy")
+        if gametimeleft ~= nil then
+            local text = string.format(_("Mission: SUCCESS (%d seconds left)"), math.floor(gametimeleft))
+            globalMessage(text)
+            setBanner(text)
+            return
+        end
+    end
+
+    if gametimeleft ~= nil then
+        gametimeleft = gametimeleft - delta
+        if gametimeleft < 0 then
+            victory("Kraylor")
+            local text = _("Mission: FAILED (time has run out)")
+            globalMessage(text)
+            setBanner(text)
+            return
+        end
+        if gametimeleft < timewarning then
+            if timewarning <= 1 * 60 then -- Less then 1 minutes left.
+                friendlyList[1]:sendCommsMessage(player, string.format(_([[%s, you have %d minute remaining.]]), player:getCallSign(), timewarning / 60))
+                timewarning = timewarning - 2 * 60
+            elseif timewarning <= 5 * 60 then -- Less then 5 minutes left. Warn ever 2 minutes instead of every 5.
+                friendlyList[1]:sendCommsMessage(player, string.format(_([[%s, you have %d minutes remaining.]]), player:getCallSign(), timewarning / 60))
+                timewarning = timewarning - 2 * 60
+            else
+                friendlyList[1]:sendCommsMessage(player, string.format(_([[%s, you have %d minutes remaining of mission time.]]), player:getCallSign(), timewarning / 60))
+                timewarning = timewarning - 5 * 60
+            end
+        end
     end
 
     -- If all allies are destroyed, the Humans (players) lose.
     if friendly_count == 0 then
         victory("Kraylor")
+        local text = _("Mission: FAILED (no friendlies left)")
+        globalMessage(text)
+        setBanner(text)
+        return
     else
         -- As the battle continues, award reputation based on
         -- the players' progress and number of surviving allies.
@@ -408,4 +560,18 @@ function update(delta)
             end
         end
     end
+
+    -- If last player ship is destroyed, the Humans (players) lose.
+    if player_count == 0 then
+        victory("Kraylor")
+        local text = _("Mission: FAILED (all your ships destroyed)")
+        globalMessage(text)
+        setBanner(text)
+        return
+    end
+    
+    -- Set banner for cinematic and top down views.
+    if gametimeleft ~= nil then
+        setBanner(string.format(_("Mission in progress - Time left: %d:%02d - Enemies: %d"), math.floor(gametimeleft / 60), math.floor(gametimeleft % 60), enemy_count))
+    end
 end