mirror of
https://github.com/sp-tarkov/modules.git
synced 2025-02-13 09:50:43 -05:00
DanW
d727ac385d
To avoid issues when somebody calls `GetRemainingRaidSeconds()` or `GetRaidTimeRemainingFraction()` when a raid isn't in progress, I throw an exception if `GameTimer` isn't running. However, this can be confusing for modders since `GameTimer` starts well after `GameWorld` is instantiated. Therefore, I added a new `HasRaidStarted()` method so it's more clear when these methods can be called. Additionally, I updated the documentation for those methods to warn the user that `HasRaidStarted()` must be true or they'll throw an exception. Alternatively, I can change the return type from `float` to `float?` for those methods and return null if a raid hasn't started. However, I felt like a null response is less intuitive than an exception in this case. Co-authored-by: dwesterwick <dwesterwick@yahoo.com> Reviewed-on: SPT-AKI/Modules#41 Co-authored-by: DanW <danw@noreply.dev.sp-tarkov.com> Co-committed-by: DanW <danw@noreply.dev.sp-tarkov.com>
70 lines
3.0 KiB
C#
70 lines
3.0 KiB
C#
using Comfort.Common;
|
|
using EFT;
|
|
using System;
|
|
|
|
namespace Aki.SinglePlayer.Utils.InRaid
|
|
{
|
|
/// <summary>
|
|
/// Allow modders to access information about the current raid time, especially if its reduced for Scav raids
|
|
/// </summary>
|
|
public static class RaidTimeUtil
|
|
{
|
|
/// <summary>
|
|
/// Determines if a raid is in-progress by checking if the GameTimer has started
|
|
/// </summary>
|
|
public static bool HasRaidStarted()
|
|
{
|
|
return Singleton<AbstractGame>.Instance.GameTimer.Started();
|
|
}
|
|
|
|
/// <summary>
|
|
/// <para>Calculates the seconds remaining in the current raid.</para>
|
|
/// <para>Please ensure <see cref="HasRaidStarted"/> is <c>true</c>, or this will throw an exception.</para>
|
|
/// </summary>
|
|
/// <returns>Seconds remaining in the raid</returns>
|
|
/// <exception cref="InvalidOperationException">Thrown if there is no raid in progress</exception>
|
|
public static float GetRemainingRaidSeconds()
|
|
{
|
|
if (!HasRaidStarted())
|
|
{
|
|
throw new InvalidOperationException("The raid-time remaining can only be calculated when a raid is in-progress");
|
|
}
|
|
|
|
float remainingTimeSeconds = Singleton<AbstractGame>.Instance.GameTimer.EscapeTimeSeconds();
|
|
|
|
// Until the raid starts, remainingTimeSeconds is TimeSpan.MaxValue, so it needs to be reduced to the actual starting raid time
|
|
return Math.Min(remainingTimeSeconds, RaidChangesUtil.NewEscapeTimeSeconds);
|
|
}
|
|
|
|
/// <summary>
|
|
/// <para>Calculates the fraction of raid-time remaining relative to the original escape time for the map.
|
|
/// 1.0 = the raid just started, and 0.0 = the raid is over (and you're MIA).</para>
|
|
/// <para>Please ensure <see cref="HasRaidStarted"/> is <c>true</c>, or this will throw an exception.</para>
|
|
/// </summary>
|
|
/// <returns>The fraction of raid-time remaining (0.0 - 1.0) relative to the original escape time for the map</returns>
|
|
/// <exception cref="InvalidOperationException">Thrown if there is no raid in progress</exception>
|
|
public static float GetRaidTimeRemainingFraction()
|
|
{
|
|
return GetRemainingRaidSeconds() / RaidChangesUtil.OriginalEscapeTimeSeconds;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Calculates the seconds since the player spawned into the raid
|
|
/// </summary>
|
|
/// <returns>Seconds since the player spawned into the raid</returns>
|
|
public static float GetSecondsSinceSpawning()
|
|
{
|
|
return Singleton<AbstractGame>.Instance.GameTimer.PastTimeSeconds();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Calculates the elapsed seconds in the raid from the original escape time for the map.
|
|
/// </summary>
|
|
/// <returns>Elapsed seconds in the raid</returns>
|
|
public static float GetElapsedRaidSeconds()
|
|
{
|
|
return RaidChangesUtil.RaidTimeReductionSeconds + GetSecondsSinceSpawning();
|
|
}
|
|
}
|
|
}
|