Castle Siege Data Model & Configuration

src/DataModel/Configuration/CastleSiegeConfiguration.cs

@@ -0,0 +1,152 @@
+// <copyright file="CastleSiegeConfiguration.cs" company="MUnique">
+// Licensed under the MIT License. See LICENSE file in the project root for full license information.
+// </copyright>
+
+namespace MUnique.OpenMU.DataModel.Configuration;
+
+using MUnique.OpenMU.Annotations;
+using MUnique.OpenMU.DataModel.Configuration.Items;
+
+/// <summary>
+/// Main configuration for the castle siege event.
+/// </summary>
+[Cloneable]
+public partial class CastleSiegeConfiguration
+{
+    /// <summary>
+    /// Gets or sets a value indicating whether the castle siege feature is enabled.
+    /// </summary>
+    public bool Enabled { get; set; }
+
+    /// <summary>
+    /// Gets or sets the number of seconds a guild must hold the crown to capture the castle.
+    /// </summary>
+    public int CrownHoldTimeSeconds { get; set; } = 30;
+
+    /// <summary>
+    /// Gets or sets the minimum combined level of a guild master required to register for the siege.
+    /// </summary>
+    public int RegisterMinLevel { get; set; } = 200;
+
+    /// <summary>
+    /// Gets or sets the minimum number of guild members required to register for the siege.
+    /// </summary>
+    public int RegisterMinMembers { get; set; } = 20;
+
+    /// <summary>
+    /// Gets or sets the minimum number of seconds a participant must be present in the battle to be eligible for a reward.
+    /// </summary>
+    public int ParticipantRewardMinSeconds { get; set; }
+
+    /// <summary>
+    /// Gets or sets the maximum number of attacking alliance slots.
+    /// </summary>
+    public int MaxAttackingGuilds { get; set; } = 3;
+
+    /// <summary>
+    /// Gets or sets the guild score awarded to the guild that wins the siege.
+    /// </summary>
+    public int GuildScoreCastleSiege { get; set; }
+
+    /// <summary>
+    /// Gets or sets the guild score awarded to alliance member guilds of the winning side.
+    /// </summary>
+    public int GuildScoreCastleSiegeMembers { get; set; }
+
+    /// <summary>
+    /// Gets or sets the Zen cost for the castle owner to re-purchase a destroyed gate.
+    /// </summary>
+    public int GateBuyPrice { get; set; }
+
+    /// <summary>
+    /// Gets or sets the Zen cost for the castle owner to re-purchase a destroyed statue.
+    /// </summary>
+    public int StatueBuyPrice { get; set; }
+
+    /// <summary>
+    /// Gets or sets the map definition for the Valley of Loren (map 30), where the siege takes place.
+    /// </summary>
+    public virtual GameMapDefinition? CastleSiegeMapDefinition { get; set; }
+
+    /// <summary>
+    /// Gets or sets the map definition for the Land of Trials (map 31), the castle-owner's exclusive zone.
+    /// </summary>
+    public virtual GameMapDefinition? LandOfTrialsMapDefinition { get; set; }
+
+    /// <summary>
+    /// Gets or sets the item definition for the participation reward item.
+    /// </summary>
+    public virtual ItemDefinition? RewardItemDefinition { get; set; }
+
+    /// <summary>
+    /// Gets or sets the schedule entries that define when each siege state begins.
+    /// </summary>
+    [MemberOfAggregate]
+    public virtual ICollection<CastleSiegeStateScheduleEntry> StateSchedule { get; protected set; } = null!;
+
+    /// <summary>
+    /// Gets or sets the definitions for all castle siege NPCs (gates, statues, etc.).
+    /// </summary>
+    [MemberOfAggregate]
+    public virtual ICollection<CastleSiegeNpcDefinition> NpcDefinitions { get; protected set; } = null!;
+
+    /// <summary>
+    /// Gets or sets the upgrade levels for gate defense.
+    /// </summary>
+    [MemberOfAggregate]
+    public virtual ICollection<CastleSiegeUpgradeDefinition> GateDefenseUpgrades { get; protected set; } = null!;
+
+    /// <summary>
+    /// Gets or sets the upgrade levels for gate maximum HP.
+    /// </summary>
+    [MemberOfAggregate]
+    public virtual ICollection<CastleSiegeUpgradeDefinition> GateLifeUpgrades { get; protected set; } = null!;
+
+    /// <summary>
+    /// Gets or sets the upgrade levels for statue defense.
+    /// </summary>
+    [MemberOfAggregate]
+    public virtual ICollection<CastleSiegeUpgradeDefinition> StatueDefenseUpgrades { get; protected set; } = null!;
+
+    /// <summary>
+    /// Gets or sets the upgrade levels for statue maximum HP.
+    /// </summary>
+    [MemberOfAggregate]
+    public virtual ICollection<CastleSiegeUpgradeDefinition> StatueLifeUpgrades { get; protected set; } = null!;
+
+    /// <summary>
+    /// Gets or sets the upgrade levels for statue HP regeneration.
+    /// </summary>
+    [MemberOfAggregate]
+    public virtual ICollection<CastleSiegeUpgradeDefinition> StatueRegenUpgrades { get; protected set; } = null!;
+
+    /// <summary>
+    /// Gets or sets the zones on the siege map where attacking siege machines may be placed.
+    /// </summary>
+    [MemberOfAggregate]
+    public virtual ICollection<CastleSiegeZoneDefinition> AttackMachineZones { get; protected set; } = null!;
+
+    /// <summary>
+    /// Gets or sets the zones on the siege map where defensive siege machines may be placed.
+    /// </summary>
+    [MemberOfAggregate]
+    public virtual ICollection<CastleSiegeZoneDefinition> DefenseMachineZones { get; protected set; } = null!;
+
+    /// <summary>
+    /// Gets or sets the zone where defending players respawn during the siege.
+    /// </summary>
+    [MemberOfAggregate]
+    public virtual CastleSiegeZoneDefinition? DefenseRespawnArea { get; set; }
+
+    /// <summary>
+    /// Gets or sets the zone where attacking players respawn during the siege.
+    /// </summary>
+    [MemberOfAggregate]
+    public virtual CastleSiegeZoneDefinition? AttackRespawnArea { get; set; }
+
+    /// <inheritdoc />
+    public override string ToString()
+    {
+        return "Castle Siege Configuration";
+    }
+}

src/DataModel/Configuration/CastleSiegeJoinSide.cs

@@ -0,0 +1,36 @@
+// <copyright file="CastleSiegeJoinSide.cs" company="MUnique">
+// Licensed under the MIT License. See LICENSE file in the project root for full license information.
+// </copyright>
+
+namespace MUnique.OpenMU.DataModel.Configuration;
+
+/// <summary>
+/// Defines the side (defending or attacking) a guild or NPC belongs to in the castle siege.
+/// </summary>
+public enum CastleSiegeJoinSide : byte
+{
+    /// <summary>
+    /// No side assigned.
+    /// </summary>
+    None = 0,
+
+    /// <summary>
+    /// The defending guild side.
+    /// </summary>
+    Defense = 1,
+
+    /// <summary>
+    /// The first attacking alliance slot.
+    /// </summary>
+    Attack1 = 2,
+
+    /// <summary>
+    /// The second attacking alliance slot.
+    /// </summary>
+    Attack2 = 3,
+
+    /// <summary>
+    /// The third attacking alliance slot.
+    /// </summary>
+    Attack3 = 4,
+}

src/DataModel/Configuration/CastleSiegeNpcDefinition.cs

@@ -0,0 +1,55 @@
+// <copyright file="CastleSiegeNpcDefinition.cs" company="MUnique">
+// Licensed under the MIT License. See LICENSE file in the project root for full license information.
+// </copyright>
+
+namespace MUnique.OpenMU.DataModel.Configuration;
+
+using MUnique.OpenMU.Annotations;
+
+/// <summary>
+/// Defines a castle siege NPC instance, including its spawn location, side, and persistence settings.
+/// </summary>
+[Cloneable]
+public partial class CastleSiegeNpcDefinition
+{
+    /// <summary>
+    /// Gets or sets the monster definition template for this NPC.
+    /// </summary>
+    public virtual MonsterDefinition? MonsterDefinition { get; set; }
+
+    /// <summary>
+    /// Gets or sets the unique instance identifier within its NPC type.
+    /// </summary>
+    public byte InstanceId { get; set; }
+
+    /// <summary>
+    /// Gets or sets a value indicating whether this NPC's state is persisted to the database between sieges.
+    /// </summary>
+    public bool IsPersistedToDatabase { get; set; }
+
+    /// <summary>
+    /// Gets or sets the default join side this NPC belongs to.
+    /// </summary>
+    public CastleSiegeJoinSide DefaultSide { get; set; }
+
+    /// <summary>
+    /// Gets or sets the X coordinate of the NPC's spawn position.
+    /// </summary>
+    public short SpawnX { get; set; }
+
+    /// <summary>
+    /// Gets or sets the Y coordinate of the NPC's spawn position.
+    /// </summary>
+    public short SpawnY { get; set; }
+
+    /// <summary>
+    /// Gets or sets the facing direction of the NPC at spawn.
+    /// </summary>
+    public Direction Direction { get; set; }
+
+    /// <inheritdoc />
+    public override string ToString()
+    {
+        return $"{this.MonsterDefinition} #{this.InstanceId} at ({this.SpawnX},{this.SpawnY})";
+    }
+}

src/DataModel/Configuration/CastleSiegeState.cs

@@ -0,0 +1,61 @@
+// <copyright file="CastleSiegeState.cs" company="MUnique">
+// Licensed under the MIT License. See LICENSE file in the project root for full license information.
+// </copyright>
+
+namespace MUnique.OpenMU.DataModel.Configuration;
+
+/// <summary>
+/// The state of the castle siege event cycle.
+/// </summary>
+public enum CastleSiegeState : byte
+{
+    /// <summary>
+    /// Idle state before guild registration opens.
+    /// </summary>
+    Idle1 = 0,
+
+    /// <summary>
+    /// Guilds may register for the siege.
+    /// </summary>
+    RegisterGuild = 1,
+
+    /// <summary>
+    /// Idle state after guild registration.
+    /// </summary>
+    Idle2 = 2,
+
+    /// <summary>
+    /// Guilds may register emblems (Marks of Lord) to determine the attacking guilds.
+    /// </summary>
+    RegisterMark = 3,
+
+    /// <summary>
+    /// Idle state after mark registration.
+    /// </summary>
+    Idle3 = 4,
+
+    /// <summary>
+    /// Players are notified that the siege is about to start.
+    /// </summary>
+    Notify = 5,
+
+    /// <summary>
+    /// The siege map is prepared and entry is allowed.
+    /// </summary>
+    Ready = 6,
+
+    /// <summary>
+    /// The siege battle is in progress.
+    /// </summary>
+    Start = 7,
+
+    /// <summary>
+    /// The siege battle has ended and results are being processed.
+    /// </summary>
+    End = 8,
+
+    /// <summary>
+    /// The full siege cycle has completed.
+    /// </summary>
+    EndCycle = 9,
+}

src/DataModel/Configuration/CastleSiegeStateScheduleEntry.cs

@@ -0,0 +1,40 @@
+// <copyright file="CastleSiegeStateScheduleEntry.cs" company="MUnique">
+// Licensed under the MIT License. See LICENSE file in the project root for full license information.
+// </copyright>
+
+namespace MUnique.OpenMU.DataModel.Configuration;
+
+using MUnique.OpenMU.Annotations;
+
+/// <summary>
+/// Defines a scheduled transition to a specific <see cref="CastleSiegeState"/> at a given day and time.
+/// </summary>
+[Cloneable]
+public partial class CastleSiegeStateScheduleEntry
+{
+    /// <summary>
+    /// Gets or sets the siege state that becomes active at the scheduled time.
+    /// </summary>
+    public CastleSiegeState State { get; set; }
+
+    /// <summary>
+    /// Gets or sets the day of the week on which this state transition occurs.
+    /// </summary>
+    public DayOfWeek DayOfWeek { get; set; }
+
+    /// <summary>
+    /// Gets or sets the hour (0–23) at which this state transition occurs.
+    /// </summary>
+    public byte Hour { get; set; }
+
+    /// <summary>
+    /// Gets or sets the minute (0–59) at which this state transition occurs.
+    /// </summary>
+    public byte Minute { get; set; }
+
+    /// <inheritdoc />
+    public override string ToString()
+    {
+        return $"{this.State} on {this.DayOfWeek} at {this.Hour:D2}:{this.Minute:D2}";
+    }
+}

src/DataModel/Configuration/CastleSiegeUpgradeDefinition.cs

@@ -0,0 +1,40 @@
+// <copyright file="CastleSiegeUpgradeDefinition.cs" company="MUnique">
+// Licensed under the MIT License. See LICENSE file in the project root for full license information.
+// </copyright>
+
+namespace MUnique.OpenMU.DataModel.Configuration;
+
+using MUnique.OpenMU.Annotations;
+
+/// <summary>
+/// Defines one level of an upgrade that the castle owner can apply to a gate or statue NPC.
+/// </summary>
+[Cloneable]
+public partial class CastleSiegeUpgradeDefinition
+{
+    /// <summary>
+    /// Gets or sets the upgrade level (0–3), where 0 represents the base/unupgraded state.
+    /// </summary>
+    public byte Level { get; set; }
+
+    /// <summary>
+    /// Gets or sets the number of Jewels of Guardian required to perform this upgrade.
+    /// </summary>
+    public int RequiredJewelOfGuardianCount { get; set; }
+
+    /// <summary>
+    /// Gets or sets the amount of Zen required to perform this upgrade.
+    /// </summary>
+    public int RequiredZen { get; set; }
+
+    /// <summary>
+    /// Gets or sets the resulting stat value granted by this upgrade level (defense or max HP).
+    /// </summary>
+    public int Value { get; set; }
+
+    /// <inheritdoc />
+    public override string ToString()
+    {
+        return $"Level {this.Level}: Value={this.Value}, Jewels={this.RequiredJewelOfGuardianCount}, Zen={this.RequiredZen}";
+    }
+}