Bonus timing, misc. updates to codebase

README.md

@@ -26,11 +26,11 @@ Bold & Italics = being worked on.
       - [ ] Save Stage times
     - [X] Support for bonuses
       - [X] Hook to their start/end zones
-      - [ ] Save Bonus times
+      - [X] Save Bonus times
     - [X] Start/End trigger touch hooks
     - [X] Load zone information automatically from standardised triggers: https://github.com/CS2Surf/Timer/wiki/CS2-Surf-Mapping 
-    - [X] _**Support for stages (`/rs`, teleporting with `/s`)**_
-    - [ ] _**Support for bonuses (`/rs`, teleporting with `/b #`)**_
+    - [X] Support for stages (`/rs`, teleporting with `/s`)
+    - [X] Support for bonuses (`/rs`, teleporting with `/b #`)
     - [ ] _**Start/End touch hooks implemented for all zones**_
 - [ ] Surf configs
   - [X] Server settings configuration
@@ -44,7 +44,7 @@ Bold & Italics = being worked on.
     - [x] Map times
     - [x] Checkpoint times
     - [ ] Stage times
-    - [ ] Bonus times
+    - [X] Bonus times
   - [X] Practice Mode implementation
   - [ ] Announce records to Discord
   - [ ] Stretch goal: sub-tick timing

cfg/SurfTimer/server_settings.cfg

@@ -76,5 +76,6 @@ mp_warmup_end
 mp_warmuptime 0
 sv_holiday_mode 0
 sv_party_mode 0
+sv_hibernate_when_empty 0
 
 sv_cheats 0

src/ST-Commands/PlayerCommands.cs

@@ -32,43 +32,62 @@ public void PlayerResetStage(CCSPlayerController? player, CommandInfo command)
 
         // To-do: players[userid].Timer.Reset() -> teleport player
         Player SurfPlayer = playerList[player.UserId ?? 0];
-        if (SurfPlayer.Timer.Stage != 0 && CurrentMap.StageStartZone[SurfPlayer.Timer.Stage] != new Vector(0, 0, 0))
-            Server.NextFrame(() => player.PlayerPawn.Value!.Teleport(CurrentMap.StageStartZone[SurfPlayer.Timer.Stage], CurrentMap.StageStartZoneAngles[SurfPlayer.Timer.Stage], new Vector(0, 0, 0)));
-        else // Reset back to map start
-            Server.NextFrame(() => player.PlayerPawn.Value!.Teleport(CurrentMap.StartZone, new QAngle(0, 0, 0), new Vector(0, 0, 0)));
+
+        if (SurfPlayer.Timer.IsBonusMode)
+        {
+            if (SurfPlayer.Timer.Bonus != 0 && CurrentMap.BonusStartZone[SurfPlayer.Timer.Bonus] != new Vector(0, 0, 0))
+                Server.NextFrame(() => player.PlayerPawn.Value!.Teleport(CurrentMap.BonusStartZone[SurfPlayer.Timer.Bonus], CurrentMap.BonusStartZoneAngles[SurfPlayer.Timer.Bonus], new Vector(0, 0, 0)));
+            else // Reset back to map start
+                Server.NextFrame(() => player.PlayerPawn.Value!.Teleport(CurrentMap.StartZone, new QAngle(0, 0, 0), new Vector(0, 0, 0)));
+        }
+
+        else
+        {
+            if (SurfPlayer.Timer.Stage != 0 && CurrentMap.StageStartZone[SurfPlayer.Timer.Stage] != new Vector(0, 0, 0))
+                Server.NextFrame(() => player.PlayerPawn.Value!.Teleport(CurrentMap.StageStartZone[SurfPlayer.Timer.Stage], CurrentMap.StageStartZoneAngles[SurfPlayer.Timer.Stage], new Vector(0, 0, 0)));
+            else // Reset back to map start
+                Server.NextFrame(() => player.PlayerPawn.Value!.Teleport(CurrentMap.StartZone, new QAngle(0, 0, 0), new Vector(0, 0, 0)));
+        }
+
         return;
     }
 
     [ConsoleCommand("css_s", "Teleport to a stage")]
+    [ConsoleCommand("css_stage", "Teleport to a stage")]
     [CommandHelper(whoCanExecute: CommandUsage.CLIENT_ONLY)]
     public void PlayerGoToStage(CCSPlayerController? player, CommandInfo command)
     {
         if (player == null)
             return;
 
-        int stage = Int32.Parse(command.ArgByIndex(1)) - 1;
-        if (stage > CurrentMap.Stages - 1 && CurrentMap.Stages > 0)
-            stage = CurrentMap.Stages - 1;
+        int stage = Int32.Parse(command.ArgByIndex(1));
 
         // Must be 1 argument
-        if (command.ArgCount < 2 || stage < 0)
+        if (command.ArgCount < 2 || stage <= 0)
         {
             #if DEBUG
-            player.PrintToChat($"CS2 Surf DEBUG >> css_s >> Arg#: {command.ArgCount} >> Args: {Int32.Parse(command.ArgByIndex(1))}");
+            player.PrintToChat($"CS2 Surf DEBUG >> css_stage >> Arg#: {command.ArgCount} >> Args: {Int32.Parse(command.ArgByIndex(1))}");
             #endif
 
             player.PrintToChat($"{PluginPrefix} {ChatColors.Red}Invalid arguments. Usage: {ChatColors.Green}!s <stage>");
             return;
         }
+
         else if (CurrentMap.Stages <= 0)
         {
             player.PrintToChat($"{PluginPrefix} {ChatColors.Red}This map has no stages.");
             return;
         }
 
+        else if (stage > CurrentMap.Stages)
+        {
+            player.PrintToChat($"{PluginPrefix} {ChatColors.Red}Invalid stage provided, this map has {ChatColors.Green}{CurrentMap.Stages} stages.");
+            return;
+        }
+
         if (CurrentMap.StageStartZone[stage] != new Vector(0, 0, 0))
         {
-            if (stage == 0)
+            if (stage == 1)
                 Server.NextFrame(() => player.PlayerPawn.Value!.Teleport(CurrentMap.StartZone, CurrentMap.StartZoneAngles, new Vector(0, 0, 0)));
             else
                 Server.NextFrame(() => player.PlayerPawn.Value!.Teleport(CurrentMap.StageStartZone[stage], CurrentMap.StageStartZoneAngles[stage], new Vector(0, 0, 0)));
@@ -84,6 +103,55 @@ public void PlayerGoToStage(CCSPlayerController? player, CommandInfo command)
             player.PrintToChat($"{PluginPrefix} {ChatColors.Red}Invalid stage provided. Usage: {ChatColors.Green}!s <stage>");
     }
 
+    [ConsoleCommand("css_b", "Teleport to a bonus")]
+    [ConsoleCommand("css_bonus", "Teleport to a bonus")]
+    [CommandHelper(whoCanExecute: CommandUsage.CLIENT_ONLY)]
+    public void PlayerGoToBonus(CCSPlayerController? player, CommandInfo command)
+    {
+        if (player == null)
+            return;
+
+        int bonus;
+
+        // Check for argument count
+        if (command.ArgCount < 2)
+        {
+            if (CurrentMap.Bonuses > 0)
+                bonus = 1;
+            else
+            {
+                player.PrintToChat($"{PluginPrefix} {ChatColors.Red}Invalid arguments. Usage: {ChatColors.Green}!bonus <bonus>");
+                return;
+            }
+        }
+
+        else
+            bonus = Int32.Parse(command.ArgByIndex(1));
+
+        if (CurrentMap.Bonuses <= 0)
+        {
+            player.PrintToChat($"{PluginPrefix} {ChatColors.Red}This map has no bonuses.");
+            return;
+        }
+
+        else if (bonus > CurrentMap.Bonuses)
+        {
+            player.PrintToChat($"{PluginPrefix} {ChatColors.Red}Invalid bonus provided, this map has {ChatColors.Green}{CurrentMap.Bonuses} bonuses.");
+            return;
+        }
+
+        if (CurrentMap.BonusStartZone[bonus] != new Vector(0, 0, 0))
+        {
+            playerList[player.UserId ?? 0].Timer.Reset();
+            playerList[player.UserId ?? 0].Timer.IsBonusMode = true;
+
+            Server.NextFrame(() => player.PlayerPawn.Value!.Teleport(CurrentMap.BonusStartZone[bonus], CurrentMap.BonusStartZoneAngles[bonus], new Vector(0, 0, 0)));
+        }
+
+        else
+            player.PrintToChat($"{PluginPrefix} {ChatColors.Red}Invalid bonus provided. Usage: {ChatColors.Green}!bonus <bonus>");
+    }
+
     [ConsoleCommand("css_spec", "Moves a player automaticlly into spectator mode")]
     public void MovePlayerToSpectator(CCSPlayerController? player, CommandInfo command)
     {

src/ST-Events/TriggerEndTouch.cs

@@ -6,8 +6,11 @@ namespace SurfTimer;
 
 public partial class SurfTimer
 {
-    // Trigger end touch handler - CBaseTrigger_EndTouchFunc
-    // internal HookResult OnTriggerEndTouch(DynamicHook handler)
+    /// <summary>
+    /// Handler for trigger end touch hook - CBaseTrigger_EndTouchFunc
+    /// </summary>
+    /// <returns>CounterStrikeSharp.API.Core.HookResult</returns>
+    /// <exception cref="Exception"></exception>
     internal HookResult OnTriggerEndTouch(CEntityIOOutput output, string name, CEntityInstance activator, CEntityInstance caller, CVariant value, float delay)
     {
         // CBaseTrigger trigger = handler.GetParam<CBaseTrigger>(0);
@@ -50,7 +53,7 @@ internal HookResult OnTriggerEndTouch(CEntityIOOutput output, string name, CEnti
                     }
 
                     // MAP START ZONE
-                    if (!player.Timer.IsStageMode)
+                    if (!player.Timer.IsStageMode && !player.Timer.IsBonusMode)
                     {
                         player.Timer.Start();
                         player.ReplayRecorder.CurrentSituation = ReplayFrameSituation.START_RUN;
@@ -103,7 +106,7 @@ internal HookResult OnTriggerEndTouch(CEntityIOOutput output, string name, CEnti
                         currentCheckpoint.EndVelX = velocity_x;
                         currentCheckpoint.EndVelY = velocity_y;
                         currentCheckpoint.EndVelZ = velocity_z;
-                        currentCheckpoint.EndTouch = player.Timer.Ticks; // To-do: what type of value we store in DB ?
+                        currentCheckpoint.EndTouch = player.Timer.Ticks;
                         currentCheckpoint.Attempts += 1;
                         // Assign the updated currentCheckpoint back to the list as `currentCheckpoint` is supposedly a copy of the original object
                         player.Stats.ThisRun.Checkpoint[player.Timer.Checkpoint] = currentCheckpoint;
@@ -139,7 +142,7 @@ internal HookResult OnTriggerEndTouch(CEntityIOOutput output, string name, CEnti
                         currentCheckpoint.EndVelX = velocity_x;
                         currentCheckpoint.EndVelY = velocity_y;
                         currentCheckpoint.EndVelZ = velocity_z;
-                        currentCheckpoint.EndTouch = player.Timer.Ticks; // To-do: what type of value we store in DB ?
+                        currentCheckpoint.EndTouch = player.Timer.Ticks;
                         currentCheckpoint.Attempts += 1;
                         // Assign the updated currentCheckpoint back to the list as `currentCheckpoint` is supposedly a copy of the original object
                         player.Stats.ThisRun.Checkpoint[player.Timer.Checkpoint] = currentCheckpoint;
@@ -152,6 +155,27 @@ internal HookResult OnTriggerEndTouch(CEntityIOOutput output, string name, CEnti
                         // Handle the case where the index is out of bounds
                     }
                 }
+
+                // Bonus start zones -- hook into (b)onus#_start
+                else if (Regex.Match(trigger.Entity.Name, "^b([1-9][0-9]?|onus[1-9][0-9]?)_start$").Success)
+                {
+                    #if DEBUG
+                    player.Controller.PrintToChat($"CS2 Surf DEBUG >> CBaseTrigger_{ChatColors.LightRed}EndTouchFunc{ChatColors.Default} -> {ChatColors.Yellow}Bonus {Regex.Match(trigger.Entity.Name, "[0-9][0-9]?").Value} Start Zone");
+                    #endif
+
+                    // BONUS START ZONE
+                    if (!player.Timer.IsStageMode && player.Timer.IsBonusMode)
+                    {
+                        player.Timer.Start();
+                        // To-do: bonus replay
+                    }
+
+                    // Prespeed display
+                    player.Controller.PrintToCenter($"Prespeed: {velocity.ToString("0")} u/s");
+                    player.Stats.ThisRun.StartVelX = velocity_x; // Start pre speed for the run
+                    player.Stats.ThisRun.StartVelY = velocity_y; // Start pre speed for the run
+                    player.Stats.ThisRun.StartVelZ = velocity_z; // Start pre speed for the run
+                }
             }
 
             return HookResult.Continue;