ModernUO/Projects/UOContent/Engines/Quests/Uzeraan Turmoil/Objectives.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

468 lines
13 KiB
C#

using Server.Engines.Help;
using Server.Gumps;
using Server.Items;
using Server.Mobiles;
namespace Server.Engines.Quests.Haven
{
public class FindUzeraanBeginObjective : QuestObjective
{
public override int Message => 1046039;
public override void OnComplete()
{
if (System.From.Profession == 5) // paladin
{
System.AddConversation(new UzeraanTitheConversation());
}
else
{
System.AddConversation(new UzeraanFirstTaskConversation());
}
}
}
public class TitheGoldObjective : QuestObjective
{
private int m_OldTithingPoints;
public TitheGoldObjective() => m_OldTithingPoints = -1;
public override int Message => 1060386;
public override void CheckProgress()
{
var pm = System.From;
var curTithingPoints = pm.TithingPoints;
if (curTithingPoints >= 500)
{
Complete();
}
else if (curTithingPoints > m_OldTithingPoints && m_OldTithingPoints >= 0)
{
pm.SendLocalizedMessage(
1060240,
"",
0x41
); // You must have at least 500 tithing points before you can continue in your quest.
}
m_OldTithingPoints = curTithingPoints;
}
public override void OnComplete()
{
System.AddObjective(new FindUzeraanFirstTaskObjective());
}
}
public class FindUzeraanFirstTaskObjective : QuestObjective
{
public override int Message => 1060387;
public override void OnComplete()
{
System.AddConversation(new UzeraanFirstTaskConversation());
}
}
public enum KillHordeMinionsStep
{
First,
LearnKarma,
Others
}
public class KillHordeMinionsObjective : QuestObjective
{
public KillHordeMinionsObjective()
{
}
public KillHordeMinionsObjective(KillHordeMinionsStep step) => Step = step;
public KillHordeMinionsStep Step { get; private set; }
public override int Message
{
get
{
return Step switch
{
KillHordeMinionsStep.First =>
/* Find the mountain pass beyond the house which lies at the
* end of the runic road.<BR><BR>
*
* Assist the city Militia by slaying <I>Horde Minions</I>
*/
1049089,
KillHordeMinionsStep.LearnKarma =>
/* You have just gained some <a href="?ForceTopic45">Karma</a>
* for killing the horde minion. <a href="?ForceTopic134">Learn</a>
* how this affects your Paladin abilities.
*/
1060389,
_ => 1060507
};
}
}
public override int MaxProgress
{
get
{
if (System.From.Profession == 5) // paladin
{
return Step switch
{
KillHordeMinionsStep.First => 1,
KillHordeMinionsStep.LearnKarma => 2,
_ => 5
};
}
return 5;
}
}
public override bool Completed
{
get
{
if (Step == KillHordeMinionsStep.LearnKarma && HasBeenRead)
{
return true;
}
return base.Completed;
}
}
public override void RenderProgress(ref DynamicGumpBuilder builder)
{
if (!Completed)
{
BaseQuestGump.AddHtmlObject(ref builder, 70, 260, 270, 100, 1049090, BaseQuestGump.Blue, false, false); // Horde Minions killed:
builder.AddLabel(70, 280, 0x64, $"{CurProgress}");
}
else
{
base.RenderProgress(ref builder);
}
}
public override void OnRead()
{
CheckCompletionStatus();
}
public override bool IgnoreYoungProtection(Mobile from)
{
// This restriction continues until the quest is ended
if (from is HordeMinion && from.Map == Map.Trammel && from.X >= 3314 && from.X <= 3814 && from.Y >= 2345 &&
from.Y <= 3095) // Haven island
{
return true;
}
return false;
}
public override void OnKill(BaseCreature creature, Container corpse)
{
if (creature is HordeMinion && corpse.Map == Map.Trammel && corpse.X >= 3314 && corpse.X <= 3814 &&
corpse.Y >= 2345 && corpse.Y <= 3095) // Haven island
{
if (CurProgress == 0)
{
System.From.NetState.SendDisplayHelpTopic(HelpTopic.Healing, false);
}
CurProgress++;
}
}
public override void OnComplete()
{
if (System.From.Profession == 5)
{
switch (Step)
{
case KillHordeMinionsStep.First:
{
var obj = new KillHordeMinionsObjective(KillHordeMinionsStep.LearnKarma);
System.AddObjective(obj);
obj.CurProgress = CurProgress;
break;
}
case KillHordeMinionsStep.LearnKarma:
{
var obj = new KillHordeMinionsObjective(KillHordeMinionsStep.Others);
System.AddObjective(obj);
obj.CurProgress = CurProgress;
break;
}
default:
{
System.AddObjective(new FindUzeraanAboutReportObjective());
break;
}
}
}
else
{
System.AddObjective(new FindUzeraanAboutReportObjective());
}
}
public override void ChildDeserialize(IGenericReader reader)
{
var version = reader.ReadEncodedInt();
Step = (KillHordeMinionsStep)reader.ReadEncodedInt();
}
public override void ChildSerialize(IGenericWriter writer)
{
writer.WriteEncodedInt(0); // version
writer.WriteEncodedInt((int)Step);
}
}
public class FindUzeraanAboutReportObjective : QuestObjective
{
public override int Message => 1049091;
public override void OnComplete()
{
System.AddConversation(new UzeraanReportConversation());
}
}
public class FindSchmendrickObjective : QuestObjective
{
public override int Message => 1049120;
public override bool IgnoreYoungProtection(Mobile from)
{
// This restriction begins when this objective is completed, and continues until the quest is ended
if (Completed && from is RestlessSoul && from.Map == Map.Trammel && from.X >= 5199 && from.X <= 5271 &&
from.Y >= 1812 && from.Y <= 1865) // Schmendrick's cave
{
return true;
}
return false;
}
public override void OnComplete()
{
System.AddConversation(new SchmendrickConversation());
}
}
public class FindApprenticeObjective : QuestObjective
{
public override int Message => 1049323;
public override void OnComplete()
{
System.AddObjective(new ReturnScrollOfPowerObjective());
}
}
public class ReturnScrollOfPowerObjective : QuestObjective
{
public override int Message => 1049324;
public override void OnComplete()
{
System.AddConversation(new UzeraanScrollOfPowerConversation());
}
}
public class FindDryadObjective : QuestObjective
{
public override int Message => 1049358;
public override void OnComplete()
{
System.AddConversation(new DryadConversation());
}
}
public class ReturnFertileDirtObjective : QuestObjective
{
public override int Message => 1049327;
public override void OnComplete()
{
System.AddConversation(new UzeraanFertileDirtConversation());
}
}
public class GetDaemonBloodObjective : QuestObjective
{
private bool m_Ambushed;
public override int Message => 1049361;
public override void CheckProgress()
{
var player = System.From;
if (!m_Ambushed && player.Map == Map.Trammel && player.InRange(new Point3D(3456, 2558, 50), 30))
{
var x = player.X - 1;
var y = player.Y - 2;
var z = Map.Trammel.GetAverageZ(x, y);
if (Map.Trammel.CanSpawnMobile(x, y, z))
{
m_Ambushed = true;
player.LocalOverheadMessage(
MessageType.Regular,
0x3B2,
1049330
); // You have been ambushed! Fight for your honor!!!
var creature = new HordeMinion();
creature.MoveToWorld(new Point3D(x, y, z), Map.Trammel);
creature.Combatant = player;
}
}
}
public override void OnComplete()
{
System.AddObjective(new ReturnDaemonBloodObjective());
}
public override void ChildDeserialize(IGenericReader reader)
{
var version = reader.ReadEncodedInt();
m_Ambushed = reader.ReadBool();
}
public override void ChildSerialize(IGenericWriter writer)
{
writer.WriteEncodedInt(0); // version
writer.Write(m_Ambushed);
}
}
public class ReturnDaemonBloodObjective : QuestObjective
{
public override int Message => 1049332;
public override void OnComplete()
{
System.AddConversation(new UzeraanDaemonBloodConversation());
}
}
public class GetDaemonBoneObjective : QuestObjective
{
public Container CorpseWithBone { get; set; }
public override int Message
{
get
{
if (System.From.Profession == 5)
{
return 1060755;
}
/* Use Uzeraan's teleporter to get to the Haunted graveyard.<BR><BR>
*
* Slay the undead until you find a <I>Daemon Bone</I>.
*/
return 1049362;
}
}
public override void OnComplete()
{
System.AddObjective(new ReturnDaemonBoneObjective());
}
public override bool IgnoreYoungProtection(Mobile from)
{
// This restriction continues until the end of the quest
if (from is Zombie or Skeleton && from.Map == Map.Trammel && from.X >= 3391 && from.X <= 3424 &&
from.Y >= 2639 && from.Y <= 2664) // Haven graveyard
{
return true;
}
return false;
}
public override bool GetKillEvent(BaseCreature creature, Container corpse)
{
if (base.GetKillEvent(creature, corpse))
{
return true;
}
return UzeraanTurmoilQuest.HasLostDaemonBone(System.From);
}
public override void OnKill(BaseCreature creature, Container corpse)
{
if (creature is Zombie or Skeleton && corpse.Map == Map.Trammel && corpse.X >= 3391 &&
corpse.X <= 3424 && corpse.Y >= 2639 && corpse.Y <= 2664) // Haven graveyard
{
if (Utility.RandomDouble() < 0.25)
{
CorpseWithBone = corpse;
}
}
}
public override void ChildDeserialize(IGenericReader reader)
{
var version = reader.ReadEncodedInt();
CorpseWithBone = (Container)reader.ReadEntity<Item>();
}
public override void ChildSerialize(IGenericWriter writer)
{
if (CorpseWithBone?.Deleted == true)
{
CorpseWithBone = null;
}
writer.WriteEncodedInt(0); // version
writer.Write(CorpseWithBone);
}
}
public class ReturnDaemonBoneObjective : QuestObjective
{
public override int Message => 1049334;
public override void OnComplete()
{
System.AddConversation(new UzeraanDaemonBoneConversation());
}
}
public class CashBankCheckObjective : QuestObjective
{
public override int Message => 1049336;
public override void OnComplete()
{
System.AddConversation(new BankerConversation());
}
}
}