## 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.
186 lines
4.9 KiB
C#
186 lines
4.9 KiB
C#
using System;
|
|
using Server.Gumps;
|
|
using Server.Mobiles;
|
|
|
|
namespace Server.Engines.MLQuests.Objectives
|
|
{
|
|
public abstract class BaseObjective
|
|
{
|
|
public virtual bool IsTimed => false;
|
|
public virtual TimeSpan Duration => TimeSpan.Zero;
|
|
|
|
public virtual bool CanOffer(IQuestGiver quester, PlayerMobile pm, bool message) => true;
|
|
|
|
public abstract void WriteToGump(ref DynamicGumpBuilder builder, ref int y);
|
|
|
|
public virtual BaseObjectiveInstance CreateInstance(MLQuestInstance instance) => null;
|
|
}
|
|
|
|
public abstract class BaseObjectiveInstance
|
|
{
|
|
public enum DataType : byte
|
|
{
|
|
None,
|
|
EscortObjective,
|
|
KillObjective,
|
|
DeliverObjective
|
|
}
|
|
|
|
public BaseObjectiveInstance(MLQuestInstance instance, BaseObjective obj)
|
|
{
|
|
Instance = instance;
|
|
|
|
if (obj.IsTimed)
|
|
{
|
|
EndTime = Core.Now + obj.Duration;
|
|
}
|
|
}
|
|
|
|
public MLQuestInstance Instance { get; }
|
|
|
|
public bool IsTimed => EndTime != DateTime.MinValue;
|
|
|
|
public DateTime EndTime { get; set; }
|
|
|
|
public bool Expired { get; set; }
|
|
|
|
public virtual DataType ExtraDataType => DataType.None;
|
|
|
|
public virtual void WriteToGump(ref DynamicGumpBuilder builder, ref int y)
|
|
{
|
|
if (IsTimed)
|
|
{
|
|
WriteTimeRemaining(ref builder, ref y, Utility.Max(EndTime - Core.Now, TimeSpan.Zero));
|
|
}
|
|
}
|
|
|
|
public static void WriteTimeRemaining(ref DynamicGumpBuilder builder, ref int y, TimeSpan timeRemaining)
|
|
{
|
|
builder.AddHtmlLocalized(103, y, 120, 16, 1062379, 0x5F90); // Est. time remaining:
|
|
builder.AddLabel(223, y, 0x481, $"{timeRemaining.TotalSeconds:F0}");
|
|
y += 16;
|
|
}
|
|
|
|
public virtual bool AllowsQuestItem(Item item, Type type) => false;
|
|
|
|
public virtual bool IsCompleted() => false;
|
|
|
|
public virtual void CheckComplete()
|
|
{
|
|
if (IsCompleted())
|
|
{
|
|
Instance.Player.PlaySound(0x5B6); // public sound
|
|
Instance.CheckComplete();
|
|
}
|
|
}
|
|
|
|
public virtual void OnQuestAccepted()
|
|
{
|
|
}
|
|
|
|
public virtual void OnQuestCancelled()
|
|
{
|
|
}
|
|
|
|
public virtual void OnQuestCompleted()
|
|
{
|
|
}
|
|
|
|
public virtual bool OnBeforeClaimReward() => true;
|
|
|
|
public virtual void OnClaimReward()
|
|
{
|
|
}
|
|
|
|
public virtual void OnAfterClaimReward()
|
|
{
|
|
}
|
|
|
|
public virtual void OnRewardClaimed()
|
|
{
|
|
}
|
|
|
|
public virtual void OnQuesterDeleted()
|
|
{
|
|
}
|
|
|
|
public virtual void OnPlayerDeath()
|
|
{
|
|
}
|
|
|
|
public virtual void OnExpire()
|
|
{
|
|
}
|
|
|
|
public virtual void Serialize(IGenericWriter writer)
|
|
{
|
|
// Version info is written in MLQuestPersistence.Serialize
|
|
|
|
if (IsTimed)
|
|
{
|
|
writer.Write(true);
|
|
writer.WriteDeltaTime(EndTime);
|
|
}
|
|
else
|
|
{
|
|
writer.Write(false);
|
|
}
|
|
|
|
// For type checks on deserialization
|
|
// (This way quest objectives can be changed without breaking serialization)
|
|
writer.Write((byte)ExtraDataType);
|
|
}
|
|
|
|
public static void Deserialize(IGenericReader reader, int version, BaseObjectiveInstance objInstance)
|
|
{
|
|
if (reader.ReadBool())
|
|
{
|
|
var endTime = reader.ReadDeltaTime();
|
|
|
|
if (objInstance != null)
|
|
{
|
|
objInstance.EndTime = endTime;
|
|
}
|
|
}
|
|
|
|
var extraDataType = (DataType)reader.ReadByte();
|
|
|
|
switch (extraDataType)
|
|
{
|
|
case DataType.EscortObjective:
|
|
{
|
|
var completed = reader.ReadBool();
|
|
|
|
if (objInstance is EscortObjectiveInstance instance)
|
|
{
|
|
instance.HasCompleted = completed;
|
|
}
|
|
|
|
break;
|
|
}
|
|
case DataType.KillObjective:
|
|
{
|
|
var slain = reader.ReadInt();
|
|
|
|
if (objInstance is KillObjectiveInstance instance)
|
|
{
|
|
instance.Slain = slain;
|
|
}
|
|
|
|
break;
|
|
}
|
|
case DataType.DeliverObjective:
|
|
{
|
|
var completed = reader.ReadBool();
|
|
|
|
if (objInstance is DeliverObjectiveInstance instance)
|
|
{
|
|
instance.HasCompleted = completed;
|
|
}
|
|
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|