## 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.
221 lines
6.6 KiB
C#
221 lines
6.6 KiB
C#
using System;
|
|
using Server.Gumps;
|
|
|
|
namespace Server.Engines.MLQuests.Objectives
|
|
{
|
|
public class CollectObjective : BaseObjective
|
|
{
|
|
public CollectObjective(int amount = 0, Type type = null, TextDefinition name = null)
|
|
{
|
|
DesiredAmount = amount;
|
|
AcceptedType = type;
|
|
Name = name;
|
|
|
|
if (MLQuestSystem.Debug && ShowDetailed && name?.Number > 0)
|
|
{
|
|
var itemid = LabelToItemID(name.Number);
|
|
|
|
if (itemid is <= 0 or > 0x4000)
|
|
{
|
|
Console.WriteLine("Warning: cliloc {0} is likely giving the wrong item ID", name.Number);
|
|
}
|
|
}
|
|
}
|
|
|
|
public int DesiredAmount { get; set; }
|
|
|
|
public Type AcceptedType { get; set; }
|
|
|
|
public TextDefinition Name { get; set; }
|
|
|
|
public virtual bool ShowDetailed => true;
|
|
|
|
public bool CheckType(Type type) => AcceptedType?.IsAssignableFrom(type) == true;
|
|
|
|
public virtual bool CheckItem(Item item) => true;
|
|
|
|
public static int LabelToItemID(int label)
|
|
{
|
|
if (label < 1078872)
|
|
{
|
|
return label - 1020000;
|
|
}
|
|
|
|
return label - 1078872;
|
|
}
|
|
|
|
public override void WriteToGump(ref DynamicGumpBuilder builder, ref int y)
|
|
{
|
|
if (ShowDetailed)
|
|
{
|
|
var amount = DesiredAmount.ToString();
|
|
|
|
builder.AddHtmlLocalized(98, y, 350, 16, 1072205, 0x5F90); // Obtain
|
|
builder.AddLabel(143, y, 0x481, amount);
|
|
|
|
if (Name.Number > 0)
|
|
{
|
|
builder.AddHtmlLocalized(143 + amount.Length * 15, y, 190, 18, Name.Number, 0x77BF);
|
|
builder.AddItem(350, y, LabelToItemID(Name.Number));
|
|
}
|
|
else if (Name.String != null)
|
|
{
|
|
builder.AddLabel(143 + amount.Length * 15, y, 0x481, Name.String);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
if (Name.Number > 0)
|
|
{
|
|
builder.AddHtmlLocalized(98, y, 312, 32, Name.Number, 0x5F90);
|
|
}
|
|
else if (Name.String != null)
|
|
{
|
|
builder.AddLabel(98, y, 0x481, Name.String);
|
|
}
|
|
}
|
|
|
|
y += 32;
|
|
}
|
|
|
|
public override BaseObjectiveInstance CreateInstance(MLQuestInstance instance) =>
|
|
new CollectObjectiveInstance(this, instance);
|
|
}
|
|
|
|
public class TimedCollectObjective : CollectObjective
|
|
{
|
|
public TimedCollectObjective(TimeSpan duration, int amount, Type type, TextDefinition name)
|
|
: base(amount, type, name) =>
|
|
Duration = duration;
|
|
|
|
public override bool IsTimed => true;
|
|
public override TimeSpan Duration { get; }
|
|
}
|
|
|
|
public class CollectObjectiveInstance : BaseObjectiveInstance
|
|
{
|
|
public CollectObjectiveInstance(CollectObjective objective, MLQuestInstance instance)
|
|
: base(instance, objective) =>
|
|
Objective = objective;
|
|
|
|
public CollectObjective Objective { get; set; }
|
|
|
|
private int GetCurrentTotal()
|
|
{
|
|
var pack = Instance.Player.Backpack;
|
|
|
|
if (pack == null)
|
|
{
|
|
return 0;
|
|
}
|
|
|
|
var total = 0;
|
|
foreach (var item in pack.FindItems(false))
|
|
{
|
|
if (ClaimTypePredicate(item) && item.QuestItem && Objective.CheckItem(item))
|
|
{
|
|
total += item.Amount;
|
|
}
|
|
}
|
|
|
|
return total;
|
|
}
|
|
|
|
public override bool AllowsQuestItem(Item item, Type type) => Objective.CheckType(type) && Objective.CheckItem(item);
|
|
|
|
public override bool IsCompleted() => GetCurrentTotal() >= Objective.DesiredAmount;
|
|
|
|
public override void OnQuestCancelled()
|
|
{
|
|
var pm = Instance.Player;
|
|
var pack = pm.Backpack;
|
|
|
|
if (pack == null)
|
|
{
|
|
return;
|
|
}
|
|
|
|
foreach (var item in pack.FindItems(false))
|
|
{
|
|
// does another quest still need this item? (OSI just unmarks everything)
|
|
if (ClaimTypePredicate(item) &&
|
|
item.QuestItem && !MLQuestSystem.CanMarkQuestItem(pm, item, Objective.AcceptedType))
|
|
{
|
|
item.QuestItem = false;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Note: subclasses are included
|
|
private bool ClaimTypePredicate(Item item) => Objective.AcceptedType.IsInstanceOfType(item);
|
|
|
|
// Should only be called after IsComplete() is checked to be true
|
|
public override void OnClaimReward()
|
|
{
|
|
var pack = Instance.Player.Backpack;
|
|
|
|
if (pack == null)
|
|
{
|
|
return;
|
|
}
|
|
|
|
// TODO: OSI also counts the item in the cursor?
|
|
|
|
var left = Objective.DesiredAmount;
|
|
|
|
using var queue = pack.EnumerateItemsByType<Item>(false, ClaimTypePredicate);
|
|
foreach (var item in queue)
|
|
{
|
|
if (item.QuestItem && Objective.CheckItem(item))
|
|
{
|
|
if (left == 0)
|
|
{
|
|
return;
|
|
}
|
|
|
|
if (item.Amount > left)
|
|
{
|
|
item.Consume(left);
|
|
left = 0;
|
|
}
|
|
else
|
|
{
|
|
item.Delete();
|
|
left -= item.Amount;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
public override void OnAfterClaimReward()
|
|
{
|
|
OnQuestCancelled(); // same thing, clear other quest items
|
|
}
|
|
|
|
public override void OnExpire()
|
|
{
|
|
OnQuestCancelled();
|
|
|
|
// No message
|
|
}
|
|
|
|
public override void WriteToGump(ref DynamicGumpBuilder builder, ref int y)
|
|
{
|
|
Objective.WriteToGump(ref builder, ref y);
|
|
y -= 16;
|
|
|
|
if (Objective.ShowDetailed)
|
|
{
|
|
base.WriteToGump(ref builder, ref y);
|
|
|
|
builder.AddHtmlLocalized(103, y, 120, 16, 3000087, 0x5F90); // Total
|
|
builder.AddLabel(223, y, 0x481, $"{GetCurrentTotal()}");
|
|
y += 16;
|
|
|
|
builder.AddHtmlLocalized(103, y, 120, 16, 1074782, 0x5F90); // Return to
|
|
builder.AddLabel(223, y, 0x481, QuesterNameAttribute.GetQuesterNameFor(Instance.QuesterType));
|
|
y += 16;
|
|
}
|
|
}
|
|
}
|
|
}
|