ModernUO/Projects/UOContent/Engines/ML Quests/Objectives/KillObjective.cs
Kamron Batman b90ac0d481
perf: Migrate Quest gumps to DynamicGump (#2416)
## Summary

Migrates the Quest system gumps from legacy `Gump` to `DynamicGump` / `StaticGump<T>`.

**Renames** `Engines/ML Quests/Gumps/BaseQuestGump` to **`BaseMLQuestGump`** to
disambiguate from the Core quest abstract (`Engines/Quests/Core/QuestSystem.cs`).
Both abstracts now extend `DynamicGump`.

**Abstract bases**:
- `Server.Engines.Quests.BaseQuestGump` (Core) - now `abstract DynamicGump`. Holds constants and a static `AddHtmlObject(ref DynamicGumpBuilder, ...)` helper. Concrete subclasses each provide their own `BuildLayout`.
- `Server.Engines.MLQuests.Gumps.BaseMLQuestGump` (ML, renamed) - now `abstract DynamicGump` with a `protected abstract BuildContent(ref DynamicGumpBuilder)` hook. The base's `BuildLayout` draws shared chrome (background art, frame, label header) and then invokes `BuildContent`; subclasses use `BuildPage`, `SetTitle`, `RegisterButton`, `SetPageCount`, and content helpers (`AddDescription`, `AddObjectives`, `AddObjectivesProgress`, `AddRewardsPage`, `AddRewards`, `AddConversation`).

**Concrete Core gumps** migrated to `DynamicGump`:
- `QuestCancelGump`, `QuestOfferGump` (Core), `QuestObjectivesGump`, `QuestConversationsGump`, `QuestLogUpdatedGump`, `QuestItemInfoGump`, `SheetMusicOfferGump` (Impresario), `PaintedImageGump` (renamed from `PaintedImage.InternalGump`).

**Concrete ML gumps** migrated to `DynamicGump` (extending `BaseMLQuestGump` or directly):
- `InfoNPCGump`, `QuestConversationGump`, `QuestLogDetailedGump`, `QuestLogGump`, `QuestOfferGump` (ML), `QuestReportBackGump`, `QuestRewardGump`, `QuestCancelConfirmGump`, `RaceChangeConfirmGump`.

**`StaticGump<T>` migrations**:
- `ScrollOfAbraxusGump` (Dark Tides). Its layout is a single hard-coded cliloc (1060116) with no per-instance dynamic content - safe to cache.

**Cliloc rule**: Every other quest dialog bakes per-instance cliloc IDs into its layout (quest titles, NPC names, race-specific prompts, era-conditional progress messages, escort destinations). Per the cliloc rule, baking different cliloc numbers into a cached layout would defeat `StaticGump<T>` caching - so all of these are `DynamicGump`.

**Signature changes** to support the migration:
- `QuestObjective.RenderMessage`/`RenderProgress` now take `ref DynamicGumpBuilder builder` (15 overrides updated across Collector, Solen Matriarch, Ambitious Solen Queen, Study of the Solen Hive, Terrible Hatchlings, The Summoning, Uzeraan Turmoil, Witch Apprentice, Emino's Undertaking).
- ML `BaseObjective.WriteToGump` / `BaseObjectiveInstance.WriteToGump` / `BaseReward.WriteToGump` now take `ref DynamicGumpBuilder` (KillObjective, GainSkillObjective, EscortObjective, CollectObjective, DeliverObjective, BaseReward).

**Empty-gump and `Singleton` rules**: All concrete gumps now have private constructors with static `DisplayTo` entry points that null-check the player NetState before allocation. All gumps that shouldn't stack are `Singleton => true`.

**External callers updated**: `MLQuest.SendOffer`/`OnRefuse`, `MLQuestEntry.SendProgressGump`/`SendRewardGump`/`SendReportBackGump`, `MLQuestSystem.QuestGumpRequest` and `ViewQuestsCommand`, `BoonCollector` (Darius/Nedrick), `SirHelper.OnDoubleClick` (no longer caches a single shared `InfoNPCGump` instance - `DisplayTo` constructs one per click and the gump's `Singleton => true` handles deduplication), `RaceChangeDeed.OnDoubleClick`, `PaintedImage.OnDoubleClick`, `ScrollOfAbraxus.OnDoubleClick`, `Impresario.OnTalk`, and `PlayerMobile`'s `BaseQuestGump` alias is now `BaseMLQuestGump`.

**Concrete subclasses found beyond the listed entry points**: `SheetMusicOfferGump` (in Impresario.cs), `PaintedImageGump` (was `PaintedImage.InternalGump`), `QuestObjectivesGump`, `QuestConversationsGump`, `QuestLogUpdatedGump`, `QuestItemInfoGump` (the Core base has these embedded across `QuestSystem.cs`/`QuestObjective.cs`/`QuestConversation.cs`/`QuestItemInfo.cs`).

**Code-standards cleanup**: Renamed legacy `m_X` private fields to `_x` in rewritten files; braces on all control flow.
2026-04-25 20:23:13 -07:00

146 lines
4.4 KiB
C#

using System;
using Server.Gumps;
namespace Server.Engines.MLQuests.Objectives
{
public class KillObjective : BaseObjective
{
public KillObjective(
int amount = 0, Type[] types = null, TextDefinition name = null, QuestArea area = null
)
{
DesiredAmount = amount;
AcceptedTypes = types;
Name = name;
Area = area;
}
public int DesiredAmount { get; set; }
public Type[] AcceptedTypes { get; set; }
public TextDefinition Name { get; set; }
public QuestArea Area { get; set; }
public override void WriteToGump(ref DynamicGumpBuilder builder, ref int y)
{
var amount = DesiredAmount.ToString();
builder.AddHtmlLocalized(98, y, 312, 16, 1072204, 0x5F90); // Slay
builder.AddLabel(133, y, 0x481, amount);
if (Name.Number > 0)
{
builder.AddHtmlLocalized(133 + amount.Length * 15, y, 190, 18, Name.Number, 0x77BF);
}
else if (Name.String != null)
{
builder.AddLabel(133 + amount.Length * 15, y, 0x481, Name.String);
}
y += 16;
if (Area != null)
{
builder.AddHtmlLocalized(103, y, 312, 20, 1018327, 0x5F90); // Location
if (Area.Name.Number > 0)
{
builder.AddHtmlLocalized(223, y, 312, 20, Area.Name.Number, 0x7FFF);
}
else if (Area.Name.String != null)
{
builder.AddLabel(223, y, 0x481, Area.Name.String);
}
y += 16;
}
}
public override BaseObjectiveInstance CreateInstance(MLQuestInstance instance) =>
new KillObjectiveInstance(this, instance);
}
public class TimedKillObjective : KillObjective
{
public TimedKillObjective(TimeSpan duration, int amount, Type[] types, TextDefinition name, QuestArea area = null)
: base(amount, types, name, area) =>
Duration = duration;
public override bool IsTimed => true;
public override TimeSpan Duration { get; }
}
public class KillObjectiveInstance : BaseObjectiveInstance
{
public KillObjectiveInstance(KillObjective objective, MLQuestInstance instance)
: base(instance, objective)
{
Objective = objective;
Slain = 0;
}
public KillObjective Objective { get; set; }
public int Slain { get; set; }
public override DataType ExtraDataType => DataType.KillObjective;
public bool AddKill(Mobile mob, Type type)
{
var desired = Objective.DesiredAmount;
foreach (var acceptedType in Objective.AcceptedTypes)
{
if (acceptedType.IsAssignableFrom(type))
{
if (Objective.Area?.Contains(mob) == false)
{
return false;
}
var pm = Instance.Player;
if (++Slain >= desired)
{
pm.SendLocalizedMessage(1075050); // You have killed all the required quest creatures of this type.
}
else
{
// You have killed a quest creature. ~1_val~ more left.
pm.SendLocalizedMessage(1075051, (desired - Slain).ToString());
}
return true;
}
}
return false;
}
public override bool IsCompleted() => Slain >= Objective.DesiredAmount;
public override void WriteToGump(ref DynamicGumpBuilder builder, ref int y)
{
Objective.WriteToGump(ref builder, ref y);
base.WriteToGump(ref builder, ref y);
builder.AddHtmlLocalized(103, y, 120, 16, 3000087, 0x5F90); // Total
builder.AddLabel(223, y, 0x481, $"{Slain}");
y += 16;
builder.AddHtmlLocalized(103, y, 120, 16, 1074782, 0x5F90); // Return to
builder.AddLabel(223, y, 0x481, QuesterNameAttribute.GetQuesterNameFor(Instance.QuesterType));
y += 16;
}
public override void Serialize(IGenericWriter writer)
{
base.Serialize(writer);
writer.Write(Slain);
}
}
}