feat(CS): weekly auto-schedule (day-of-week + UTC time), persisted, /csschedule GM cmd
Some checks failed
.NET Core / build (push) Has been cancelled
Some checks failed
.NET Core / build (push) Has been cancelled
The siege can now auto-open registration on scheduled days/time instead of only manual /csphase. Schedule is context-owned state (like owner), persisted across restarts via the same config-JSON path. New GM command /csschedule sets/views/clears it (e.g. /csschedule Sunday 20:00, UTC). +2 unit tests (11 total). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -48,6 +48,12 @@ public class CastleSiegeConfiguration
|
|||||||
/// <summary>Gets or sets the persisted registered guild names for the current cycle.</summary>
|
/// <summary>Gets or sets the persisted registered guild names for the current cycle.</summary>
|
||||||
public IList<string> PersistedRegisteredGuilds { get; set; } = new List<string>();
|
public IList<string> PersistedRegisteredGuilds { get; set; } = new List<string>();
|
||||||
|
|
||||||
|
/// <summary>Gets or sets the persisted auto-schedule days of week (empty = manual start only).</summary>
|
||||||
|
public IList<DayOfWeek> PersistedScheduleDays { get; set; } = new List<DayOfWeek>();
|
||||||
|
|
||||||
|
/// <summary>Gets or sets the persisted auto-schedule UTC time of day, or null if unscheduled.</summary>
|
||||||
|
public TimeOnly? PersistedScheduleTime { get; set; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Returns true if <paramref name="now"/> falls within a 5-second window of any configured
|
/// Returns true if <paramref name="now"/> falls within a 5-second window of any configured
|
||||||
/// registration-open time.
|
/// registration-open time.
|
||||||
|
|||||||
@@ -23,6 +23,8 @@ public class CastleSiegeContext
|
|||||||
private string? _occupier;
|
private string? _occupier;
|
||||||
private int _defensesRemaining;
|
private int _defensesRemaining;
|
||||||
private bool _dirty;
|
private bool _dirty;
|
||||||
|
private List<DayOfWeek> _scheduleDays = new();
|
||||||
|
private TimeOnly? _scheduleTime;
|
||||||
|
|
||||||
/// <summary>Initializes a new instance of the <see cref="CastleSiegeContext"/> class.</summary>
|
/// <summary>Initializes a new instance of the <see cref="CastleSiegeContext"/> class.</summary>
|
||||||
/// <param name="configuration">The cycle timing configuration.</param>
|
/// <param name="configuration">The cycle timing configuration.</param>
|
||||||
@@ -56,6 +58,12 @@ public class CastleSiegeContext
|
|||||||
/// <summary>Gets the guild names registered for the current cycle.</summary>
|
/// <summary>Gets the guild names registered for the current cycle.</summary>
|
||||||
public IReadOnlyList<string> RegisteredGuilds => this._registeredGuilds;
|
public IReadOnlyList<string> RegisteredGuilds => this._registeredGuilds;
|
||||||
|
|
||||||
|
/// <summary>Gets the days of week the siege auto-opens registration (empty = manual start only).</summary>
|
||||||
|
public IReadOnlyList<DayOfWeek> ScheduleDays => this._scheduleDays;
|
||||||
|
|
||||||
|
/// <summary>Gets the UTC time of day registration auto-opens on scheduled days, or null if unscheduled.</summary>
|
||||||
|
public TimeOnly? ScheduleTime => this._scheduleTime;
|
||||||
|
|
||||||
/// <summary>Advances the state machine based on the current time.</summary>
|
/// <summary>Advances the state machine based on the current time.</summary>
|
||||||
/// <param name="now">The current UTC time.</param>
|
/// <param name="now">The current UTC time.</param>
|
||||||
public ValueTask TickAsync(DateTime now)
|
public ValueTask TickAsync(DateTime now)
|
||||||
@@ -63,7 +71,7 @@ public class CastleSiegeContext
|
|||||||
switch (this.Phase)
|
switch (this.Phase)
|
||||||
{
|
{
|
||||||
case CastleSiegePhase.Ownership:
|
case CastleSiegePhase.Ownership:
|
||||||
if (this.Configuration.IsRegistrationOpenTime(now))
|
if (this.ShouldOpenRegistration(now))
|
||||||
{
|
{
|
||||||
return this.ForceStartRegistrationAsync(now);
|
return this.ForceStartRegistrationAsync(now);
|
||||||
}
|
}
|
||||||
@@ -150,6 +158,41 @@ public class CastleSiegeContext
|
|||||||
this._dirty = true;
|
this._dirty = true;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Sets the weekly auto-schedule (days of week + UTC time) and marks the state dirty for persistence.
|
||||||
|
/// Empty days disables auto-start (manual only).
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="days">The days of week registration should auto-open.</param>
|
||||||
|
/// <param name="time">The UTC time of day registration should auto-open, or null to disable.</param>
|
||||||
|
public void SetSchedule(IEnumerable<DayOfWeek> days, TimeOnly? time)
|
||||||
|
{
|
||||||
|
this._scheduleDays = days.Distinct().OrderBy(d => d).ToList();
|
||||||
|
this._scheduleTime = this._scheduleDays.Count > 0 ? time : null;
|
||||||
|
this._dirty = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Returns whether registration should auto-open now: a scheduled day matches and the current UTC time
|
||||||
|
/// falls within a 5-second window at/after the scheduled time. Only meaningful in the ownership phase.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="nowUtc">The current UTC time.</param>
|
||||||
|
public bool ShouldOpenRegistration(DateTime nowUtc)
|
||||||
|
{
|
||||||
|
if (this._scheduleTime is not { } scheduleTime || this._scheduleDays.Count == 0)
|
||||||
|
{
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!this._scheduleDays.Contains(nowUtc.DayOfWeek))
|
||||||
|
{
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
var nowTime = TimeOnly.FromDateTime(nowUtc);
|
||||||
|
var windowEnd = scheduleTime.Add(TimeSpan.FromSeconds(5));
|
||||||
|
return scheduleTime <= nowTime && nowTime <= windowEnd;
|
||||||
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Returns whether the persistable state changed since the last call, resetting the flag.
|
/// Returns whether the persistable state changed since the last call, resetting the flag.
|
||||||
/// Called each tick by the plugin to decide whether to write state to the database.
|
/// Called each tick by the plugin to decide whether to write state to the database.
|
||||||
@@ -169,7 +212,9 @@ public class CastleSiegeContext
|
|||||||
/// <param name="phase">The persisted phase.</param>
|
/// <param name="phase">The persisted phase.</param>
|
||||||
/// <param name="phaseStartedUtc">When the persisted phase started (UTC), or null to keep the default.</param>
|
/// <param name="phaseStartedUtc">When the persisted phase started (UTC), or null to keep the default.</param>
|
||||||
/// <param name="registeredGuilds">The persisted registered guild names, or null.</param>
|
/// <param name="registeredGuilds">The persisted registered guild names, or null.</param>
|
||||||
public void RestoreState(string? owner, CastleSiegePhase phase, DateTime? phaseStartedUtc, IEnumerable<string>? registeredGuilds)
|
/// <param name="scheduleDays">The persisted auto-schedule days of week, or null.</param>
|
||||||
|
/// <param name="scheduleTime">The persisted auto-schedule UTC time, or null.</param>
|
||||||
|
public void RestoreState(string? owner, CastleSiegePhase phase, DateTime? phaseStartedUtc, IEnumerable<string>? registeredGuilds, IEnumerable<DayOfWeek>? scheduleDays, TimeOnly? scheduleTime)
|
||||||
{
|
{
|
||||||
this.OwnerGuildName = owner;
|
this.OwnerGuildName = owner;
|
||||||
this.Phase = phase;
|
this.Phase = phase;
|
||||||
@@ -180,6 +225,8 @@ public class CastleSiegeContext
|
|||||||
this._registeredGuilds.AddRange(registeredGuilds);
|
this._registeredGuilds.AddRange(registeredGuilds);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
this._scheduleDays = scheduleDays?.Distinct().OrderBy(d => d).ToList() ?? new List<DayOfWeek>();
|
||||||
|
this._scheduleTime = this._scheduleDays.Count > 0 ? scheduleTime : null;
|
||||||
this._dirty = false;
|
this._dirty = false;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,101 @@
|
|||||||
|
// <copyright file="CastleSiegeScheduleChatCommandPlugIn.cs" company="MUnique">
|
||||||
|
// Licensed under the MIT License. See LICENSE file in the project root for full license information.
|
||||||
|
// </copyright>
|
||||||
|
|
||||||
|
namespace MUnique.OpenMU.GameLogic.PlugIns.ChatCommands;
|
||||||
|
|
||||||
|
using System.Globalization;
|
||||||
|
using System.Linq;
|
||||||
|
using System.Runtime.InteropServices;
|
||||||
|
using MUnique.OpenMU.GameLogic.CastleSiege;
|
||||||
|
using MUnique.OpenMU.GameLogic.PlugIns.PeriodicTasks;
|
||||||
|
using MUnique.OpenMU.GameLogic.Views;
|
||||||
|
using MUnique.OpenMU.Interfaces;
|
||||||
|
using MUnique.OpenMU.PlugIns;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Sets the Castle Siege weekly auto-schedule. GM only. Times are UTC.
|
||||||
|
/// Usage: <c>/csschedule</c> (show) | <c>/csschedule Sunday 20:00</c> | <c>/csschedule Sunday,Wednesday 20:00</c> | <c>/csschedule clear</c>.
|
||||||
|
/// </summary>
|
||||||
|
[Guid("A1B2C3D4-0006-4E5F-9A0B-CA5710000006")]
|
||||||
|
[PlugIn]
|
||||||
|
[Display(Name = "Castle Siege Schedule", Description = "GM command: /csschedule [<days> <HH:mm UTC> | clear]")]
|
||||||
|
[ChatCommandHelp(Command, CharacterStatus.GameMaster)]
|
||||||
|
public class CastleSiegeScheduleChatCommandPlugIn : IChatCommandPlugIn
|
||||||
|
{
|
||||||
|
private const string Command = "/csschedule";
|
||||||
|
|
||||||
|
/// <inheritdoc />
|
||||||
|
public string Key => Command;
|
||||||
|
|
||||||
|
/// <inheritdoc/>
|
||||||
|
public CharacterStatus MinCharacterStatusRequirement => CharacterStatus.GameMaster;
|
||||||
|
|
||||||
|
/// <inheritdoc />
|
||||||
|
public async ValueTask HandleCommandAsync(Player player, string command)
|
||||||
|
{
|
||||||
|
var context = CastleSiegeEventPlugIn.TryGetContext(player.GameContext);
|
||||||
|
if (context is null)
|
||||||
|
{
|
||||||
|
await ShowAsync(player, "Castle Siege plugin not active.").ConfigureAwait(false);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
var parts = command.Split(' ', StringSplitOptions.RemoveEmptyEntries);
|
||||||
|
|
||||||
|
// "/csschedule" -> show current schedule.
|
||||||
|
if (parts.Length == 1)
|
||||||
|
{
|
||||||
|
await ShowAsync(player, Describe(context)).ConfigureAwait(false);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// "/csschedule clear" -> disable auto-start.
|
||||||
|
if (parts.Length == 2 && string.Equals(parts[1], "clear", StringComparison.OrdinalIgnoreCase))
|
||||||
|
{
|
||||||
|
context.SetSchedule(Array.Empty<DayOfWeek>(), null);
|
||||||
|
await ShowAsync(player, "Castle Siege auto-schedule cleared (manual start only).").ConfigureAwait(false);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (parts.Length < 3)
|
||||||
|
{
|
||||||
|
await ShowAsync(player, "Usage: /csschedule <day[,day...]> <HH:mm UTC> | /csschedule clear").ConfigureAwait(false);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
var days = new List<DayOfWeek>();
|
||||||
|
foreach (var token in parts[1].Split(',', StringSplitOptions.RemoveEmptyEntries))
|
||||||
|
{
|
||||||
|
if (!Enum.TryParse<DayOfWeek>(token, true, out var day))
|
||||||
|
{
|
||||||
|
await ShowAsync(player, $"Unknown day '{token}'. Use e.g. Sunday, Monday, Tuesday...").ConfigureAwait(false);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
days.Add(day);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!TimeOnly.TryParse(parts[2], CultureInfo.InvariantCulture, out var time))
|
||||||
|
{
|
||||||
|
await ShowAsync(player, $"Invalid time '{parts[2]}'. Use 24h HH:mm (UTC).").ConfigureAwait(false);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
context.SetSchedule(days, time);
|
||||||
|
await ShowAsync(player, $"{Describe(context)} Server UTC now: {DateTime.UtcNow:ddd HH:mm}.").ConfigureAwait(false);
|
||||||
|
}
|
||||||
|
|
||||||
|
private static string Describe(CastleSiegeContext context)
|
||||||
|
{
|
||||||
|
if (context.ScheduleTime is not { } time || context.ScheduleDays.Count == 0)
|
||||||
|
{
|
||||||
|
return "Castle Siege auto-schedule: (none). Set with /csschedule <days> <HH:mm UTC>.";
|
||||||
|
}
|
||||||
|
|
||||||
|
return $"Castle Siege auto-schedule: {string.Join(",", context.ScheduleDays)} at {time:HH:mm} UTC.";
|
||||||
|
}
|
||||||
|
|
||||||
|
private static ValueTask ShowAsync(Player player, string text)
|
||||||
|
=> player.InvokeViewPlugInAsync<IShowMessagePlugIn>(p => p.ShowMessageAsync(text, MessageType.BlueNormal));
|
||||||
|
}
|
||||||
@@ -75,7 +75,7 @@ public sealed class CastleSiegeEventPlugIn : IPeriodicTaskPlugIn, ISupportCustom
|
|||||||
|
|
||||||
// Restore state persisted before the last restart (owner/phase/registrations) BEFORE subscribing,
|
// Restore state persisted before the last restart (owner/phase/registrations) BEFORE subscribing,
|
||||||
// so restoring doesn't announce phases or re-spawn defenses.
|
// so restoring doesn't announce phases or re-spawn defenses.
|
||||||
created.RestoreState(config.PersistedOwnerGuildName, config.PersistedPhase, config.PersistedPhaseStartedUtc, config.PersistedRegisteredGuilds);
|
created.RestoreState(config.PersistedOwnerGuildName, config.PersistedPhase, config.PersistedPhaseStartedUtc, config.PersistedRegisteredGuilds, config.PersistedScheduleDays, config.PersistedScheduleTime);
|
||||||
|
|
||||||
// Announce phase changes to the whole server and, when the siege begins, warp registered members.
|
// Announce phase changes to the whole server and, when the siege begins, warp registered members.
|
||||||
created.PhaseChanged += phase => _ = OnPhaseChangedAsync(gc, created, phase);
|
created.PhaseChanged += phase => _ = OnPhaseChangedAsync(gc, created, phase);
|
||||||
@@ -150,6 +150,8 @@ public sealed class CastleSiegeEventPlugIn : IPeriodicTaskPlugIn, ISupportCustom
|
|||||||
config.PersistedPhase = context.Phase;
|
config.PersistedPhase = context.Phase;
|
||||||
config.PersistedPhaseStartedUtc = context.PhaseStartedUtc;
|
config.PersistedPhaseStartedUtc = context.PhaseStartedUtc;
|
||||||
config.PersistedRegisteredGuilds = context.RegisteredGuilds.ToList();
|
config.PersistedRegisteredGuilds = context.RegisteredGuilds.ToList();
|
||||||
|
config.PersistedScheduleDays = context.ScheduleDays.ToList();
|
||||||
|
config.PersistedScheduleTime = context.ScheduleTime;
|
||||||
|
|
||||||
// Find our plugin-configuration row via the in-memory config graph to get its id.
|
// Find our plugin-configuration row via the in-memory config graph to get its id.
|
||||||
var pluginTypeId = typeof(CastleSiegeEventPlugIn).GUID;
|
var pluginTypeId = typeof(CastleSiegeEventPlugIn).GUID;
|
||||||
|
|||||||
@@ -131,15 +131,36 @@ public class CastleSiegeContextTest
|
|||||||
var phaseChangedFired = false;
|
var phaseChangedFired = false;
|
||||||
ctx.PhaseChanged += _ => phaseChangedFired = true;
|
ctx.PhaseChanged += _ => phaseChangedFired = true;
|
||||||
|
|
||||||
ctx.RestoreState("Winners", CastleSiegePhase.Ownership, T0, new[] { "Winners", "Losers" });
|
ctx.RestoreState("Winners", CastleSiegePhase.Ownership, T0, new[] { "Winners", "Losers" }, new[] { DayOfWeek.Sunday }, new TimeOnly(20, 0));
|
||||||
|
|
||||||
Assert.That(ctx.Phase, Is.EqualTo(CastleSiegePhase.Ownership));
|
Assert.That(ctx.Phase, Is.EqualTo(CastleSiegePhase.Ownership));
|
||||||
Assert.That(ctx.OwnerGuildName, Is.EqualTo("Winners"));
|
Assert.That(ctx.OwnerGuildName, Is.EqualTo("Winners"));
|
||||||
Assert.That(ctx.RegisteredGuilds, Is.EquivalentTo(new[] { "Winners", "Losers" }));
|
Assert.That(ctx.RegisteredGuilds, Is.EquivalentTo(new[] { "Winners", "Losers" }));
|
||||||
|
Assert.That(ctx.ScheduleDays, Is.EquivalentTo(new[] { DayOfWeek.Sunday }));
|
||||||
|
Assert.That(ctx.ScheduleTime, Is.EqualTo(new TimeOnly(20, 0)));
|
||||||
Assert.That(phaseChangedFired, Is.False);
|
Assert.That(phaseChangedFired, Is.False);
|
||||||
Assert.That(ctx.ConsumeDirty(), Is.False, "restore must not mark the state dirty");
|
Assert.That(ctx.ConsumeDirty(), Is.False, "restore must not mark the state dirty");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>Tests that the weekly auto-schedule only opens registration on a matching day within the time window.</summary>
|
||||||
|
[Test]
|
||||||
|
public void ShouldOpenRegistrationMatchesDayAndTimeWindow()
|
||||||
|
{
|
||||||
|
var ctx = new CastleSiegeContext(Config());
|
||||||
|
ctx.SetSchedule(new[] { DayOfWeek.Sunday }, new TimeOnly(20, 0));
|
||||||
|
|
||||||
|
var sunday = new DateTime(2026, 1, 4, 20, 0, 2, DateTimeKind.Utc); // a Sunday, +2s into the window
|
||||||
|
var sundayLate = new DateTime(2026, 1, 4, 20, 0, 30, DateTimeKind.Utc); // past the 5s window
|
||||||
|
var monday = new DateTime(2026, 1, 5, 20, 0, 2, DateTimeKind.Utc); // wrong day
|
||||||
|
|
||||||
|
Assert.That(ctx.ShouldOpenRegistration(sunday), Is.True);
|
||||||
|
Assert.That(ctx.ShouldOpenRegistration(sundayLate), Is.False);
|
||||||
|
Assert.That(ctx.ShouldOpenRegistration(monday), Is.False);
|
||||||
|
|
||||||
|
ctx.SetSchedule(Array.Empty<DayOfWeek>(), null); // cleared -> never opens
|
||||||
|
Assert.That(ctx.ShouldOpenRegistration(sunday), Is.False);
|
||||||
|
}
|
||||||
|
|
||||||
/// <summary>Tests that state-changing operations flip the dirty flag, which ConsumeDirty reads-and-resets.</summary>
|
/// <summary>Tests that state-changing operations flip the dirty flag, which ConsumeDirty reads-and-resets.</summary>
|
||||||
[Test]
|
[Test]
|
||||||
public async Task DirtyFlagTracksPersistableChangesAsync()
|
public async Task DirtyFlagTracksPersistableChangesAsync()
|
||||||
|
|||||||
Reference in New Issue
Block a user