fix: Moves ContextMenu out of core, streamlines code, fixes bugs (#1873)

## Summary
- Removes allocation of a `List<ContextMenuEntry>` every time a context menu is created.
- Moves packet/context menu creation logic out of the core
- Fixes tame entry

## BREAKING CHANGE
> [!Important]
> **Developer Note**
> ```cs
> public virtual void GetContextMenuEntries(Mobile from, List<ContextMenuEntry> list)
> ```
> and similar functions changed to
> ```cs
> public virtual void GetContextMenuEntries(Mobile from, ref PooledRefList<ContextMenuEntry> list)
> ```
This commit is contained in:
Kamron Batman 2024-07-20 21:33:23 -07:00 • committed by GitHub
parent bb24b330e1
commit f58117a877
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
88 changed files with 1206 additions and 1483 deletions

View file

@ -1,6 +1,7 @@
using System;
using System.Collections.Generic;
using ModernUO.Serialization;
using Server.Collections;
using Server.ContextMenus;
using Server.Gumps;
using Server.Mobiles;
@ -277,36 +278,33 @@ public partial class BulkOrderBook : Item, ISecurable
}
}
public override void GetContextMenuEntries(Mobile from, List<ContextMenuEntry> list)
public override void GetContextMenuEntries(Mobile from, ref PooledRefList<ContextMenuEntry> list)
{
base.GetContextMenuEntries(from, list);
base.GetContextMenuEntries(from, ref list);
if (from.CheckAlive() && IsChildOf(from.Backpack))
{
list.Add(new NameBookEntry(from, this));
list.Add(new NameBookEntry());
}
SetSecureLevelEntry.AddTo(from, this, list);
SetSecureLevelEntry.AddTo(from, this, ref list);
}
private class NameBookEntry : ContextMenuEntry
{
private readonly BulkOrderBook m_Book;
private readonly Mobile m_From;
public NameBookEntry(Mobile from, BulkOrderBook book) : base(6216)
public NameBookEntry() : base(6216)
{
m_From = from;
m_Book = book;
}
public override void OnClick()
public override void OnClick(Mobile from, IEntity target)
{
if (m_From.CheckAlive() && m_Book.IsChildOf(m_From.Backpack))
if (!from.CheckAlive() || target is not BulkOrderBook book || !book.IsChildOf(from.Backpack))
{
m_From.Prompt = new NameBookPrompt(m_Book);
m_From.SendLocalizedMessage(1062479); // Type in the new name of the book:
return;
}
from.Prompt = new NameBookPrompt(book);
from.SendLocalizedMessage(1062479); // Type in the new name of the book:
}
}

View file

@ -1,4 +1,5 @@
using System.Collections.Generic;
using Server.Collections;
using Server.ContextMenus;
using Server.Gumps;
@ -46,17 +47,17 @@ namespace Server.Engines.ConPVP
public override string DefaultName => "tournament controller";
public override void GetContextMenuEntries(Mobile from, List<ContextMenuEntry> list)
public override void GetContextMenuEntries(Mobile from, ref PooledRefList<ContextMenuEntry> list)
{
base.GetContextMenuEntries(from, list);
base.GetContextMenuEntries(from, ref list);
if (from.AccessLevel >= AccessLevel.GameMaster && Tournament != null)
{
list.Add(new EditEntry(Tournament));
list.Add(new EditEntry());
if (Tournament.CurrentStage == TournamentStage.Inactive)
{
list.Add(new StartEntry(Tournament));
list.Add(new StartEntry());
}
}
}
@ -107,35 +108,42 @@ namespace Server.Engines.ConPVP
private class EditEntry : ContextMenuEntry
{
private readonly Tournament m_Tournament;
public EditEntry(Tournament tourney) : base(5101) => m_Tournament = tourney;
public override void OnClick()
public EditEntry() : base(5101)
{
Owner.From.SendGump(new PropertiesGump(Owner.From, m_Tournament));
}
public override void OnClick(Mobile from, IEntity target)
{
if (target is not TournamentController controller)
{
return;
}
from.SendGump(new PropertiesGump(from, controller.Tournament));
}
}
private class StartEntry : ContextMenuEntry
{
private readonly Tournament m_Tournament;
public StartEntry(Tournament tourney) : base(5113) => m_Tournament = tourney;
public override void OnClick()
public StartEntry() : base(5113)
{
if (m_Tournament.Stage == TournamentStage.Inactive)
}
public override void OnClick(Mobile from, IEntity target)
{
if (target is not TournamentController controller || controller.Tournament.Stage != TournamentStage.Inactive)
{
m_Tournament.SignupStart = Core.Now;
m_Tournament.Stage = TournamentStage.Signup;
m_Tournament.Participants.Clear();
m_Tournament.Pyramid.Levels.Clear();
m_Tournament.Alert(
"Hear ye! Hear ye!",
"Tournament signup has opened. You can enter by signing up with the registrar."
);
return;
}
controller.Tournament.SignupStart = Core.Now;
controller.Tournament.Stage = TournamentStage.Signup;
controller.Tournament.Participants.Clear();
controller.Tournament.Pyramid.Levels.Clear();
controller.Tournament.Alert(
"Hear ye! Hear ye!",
"Tournament signup has opened. You can enter by signing up with the registrar."
);
}
}
}

View file

@ -4,31 +4,26 @@ namespace Server.ContextMenus
{
public class RemoveFromPartyEntry : ContextMenuEntry
{
private readonly Mobile m_From;
private readonly Mobile m_Target;
public RemoveFromPartyEntry(Mobile from, Mobile target) : base(0198, 12)
public RemoveFromPartyEntry() : base(0198, 12)
{
m_From = from;
m_Target = target;
}
public override void OnClick()
public override void OnClick(Mobile from, IEntity target)
{
var p = Party.Get(m_From);
var p = Party.Get(from);
if (p == null || p.Leader != m_From || !p.Contains(m_Target))
if (target is not Mobile mobile || p == null || p.Leader != from || !p.Contains(mobile))
{
return;
}
if (m_From == m_Target)
if (from == mobile)
{
m_From.SendLocalizedMessage(1005446); // You may only remove yourself from a party if you are not the leader.
from.SendLocalizedMessage(1005446); // You may only remove yourself from a party if you are not the leader.
}
else
{
p.Remove(m_Target);
p.Remove(mobile);
}
}
}

View file

@ -1,5 +1,6 @@
using System.Collections.Generic;
using ModernUO.Serialization;
using Server.Collections;
using Server.ContextMenus;
using Server.Gumps;
using Server.Items;
@ -221,10 +222,10 @@ public partial class PlantItem : Item, ISecurable
}
}
public override void GetContextMenuEntries(Mobile from, List<ContextMenuEntry> list)
public override void GetContextMenuEntries(Mobile from, ref PooledRefList<ContextMenuEntry> list)
{
base.GetContextMenuEntries(from, list);
SetSecureLevelEntry.AddTo(from, this, list);
base.GetContextMenuEntries(from, ref list);
SetSecureLevelEntry.AddTo(from, this, ref list);
}
public int GetLocalizedPlantStatus()

View file

@ -1,5 +1,5 @@
using System.Collections.Generic;
using ModernUO.Serialization;
using Server.Collections;
using Server.ContextMenus;
using Server.Network;
using Server.Targeting;
@ -153,13 +153,13 @@ public partial class Obsidian : Item
}
}
public override void GetContextMenuEntries(Mobile from, List<ContextMenuEntry> list)
public override void GetContextMenuEntries(Mobile from, ref PooledRefList<ContextMenuEntry> list)
{
base.GetContextMenuEntries(from, list);
base.GetContextMenuEntries(from, ref list);
if (from.Alive && _quantity is >= Partial and < Completed && IsChildOf(from.Backpack))
{
list.Add(new DisassembleEntry(this));
list.Add(new DisassembleEntry());
}
}
@ -187,23 +187,24 @@ public partial class Obsidian : Item
private class DisassembleEntry : ContextMenuEntry
{
private readonly Obsidian _obsidian;
public DisassembleEntry(Obsidian obsidian) : base(6142) => _obsidian = obsidian;
public override void OnClick()
public DisassembleEntry() : base(6142)
{
var from = Owner.From;
if (!_obsidian.Deleted && _obsidian.Quantity >= Partial && _obsidian.Quantity < Completed &&
_obsidian.IsChildOf(from.Backpack) && from.CheckAlive())
{
for (var i = 0; i < _obsidian.Quantity - 1; i++)
{
from.AddToBackpack(new Obsidian());
}
}
_obsidian.Quantity = 1;
public override void OnClick(Mobile from, IEntity target)
{
if (!from.CheckAlive() || target is not Obsidian obsidian || obsidian.Deleted || obsidian.Quantity < Partial ||
obsidian.Quantity >= Completed || !obsidian.IsChildOf(from.Backpack))
{
return;
}
for (var i = 0; i < obsidian.Quantity - 1; i++)
{
from.AddToBackpack(new Obsidian());
}
obsidian.Quantity = 1;
}
}

View file

@ -1,5 +1,6 @@
using System.Collections.Generic;
using ModernUO.Serialization;
using Server.Collections;
using Server.ContextMenus;
using Server.Items;
using Server.Mobiles;
@ -8,17 +9,15 @@ namespace Server.Engines.Quests;
public class TalkEntry : ContextMenuEntry
{
private readonly BaseQuester _quester;
public TalkEntry(BaseQuester quester) : base(quester.TalkNumber) => _quester = quester;
public override void OnClick()
public TalkEntry(int talkNumber) : base(talkNumber)
{
var from = Owner.From;
}
if (from.CheckAlive() && from is PlayerMobile mobile && _quester.CanTalkTo(mobile))
public override void OnClick(Mobile from, IEntity target)
{
if (from.CheckAlive() && from is PlayerMobile mobile && target is BaseQuester quester && quester.CanTalkTo(mobile))
{
_quester.OnTalk(mobile, true);
quester.OnTalk(mobile, true);
}
}
}
@ -60,13 +59,13 @@ public abstract partial class BaseQuester : BaseVendor
return item;
}
public override void AddCustomContextEntries(Mobile from, List<ContextMenuEntry> list)
public override void AddCustomContextEntries(Mobile from, ref PooledRefList<ContextMenuEntry> list)
{
base.AddCustomContextEntries(from, list);
base.AddCustomContextEntries(from, ref list);
if (from.Alive && from is PlayerMobile mobile && TalkNumber > 0 && CanTalkTo(mobile))
{
list.Add(new TalkEntry(this));
list.Add(new TalkEntry(TalkNumber));
}
}

View file

@ -13,7 +13,7 @@ namespace Server.Engines.Quests
public QuestCallbackEntry(int number, int range, QuestCallback callback) : base(number, range) =>
m_Callback = callback;
public override void OnClick()
public override void OnClick(Mobile from, IEntity target)
{
m_Callback?.Invoke();
}

View file

@ -1,5 +1,6 @@
using System;
using System.Collections.Generic;
using Server.Collections;
using Server.ContextMenus;
using Server.Engines.Quests.Ambitious;
using Server.Engines.Quests.Collector;
@ -246,7 +247,7 @@ namespace Server.Engines.Quests
From.SendGump(new QuestOfferGump(this));
}
public virtual void GetContextMenuEntries(List<ContextMenuEntry> list)
public virtual void GetContextMenuEntries(ref PooledRefList<ContextMenuEntry> list)
{
if (Objectives.Count > 0)
{

View file

@ -1,9 +1,8 @@
using System.Collections.Generic;
using ModernUO.Serialization;
using Server.Collections;
using Server.ContextMenus;
using Server.Items;
using Server.Mobiles;
using Server.Network;
namespace Server.Engines.Quests.Necro;
@ -115,9 +114,9 @@ public partial class Horus : BaseQuester
}
}
public override void GetContextMenuEntries(Mobile from, List<ContextMenuEntry> list)
public override void GetContextMenuEntries(Mobile from, ref PooledRefList<ContextMenuEntry> list)
{
base.GetContextMenuEntries(from, list);
base.GetContextMenuEntries(from, ref list);
if (!from.Alive || from is not PlayerMobile pm)
{
@ -131,7 +130,7 @@ public partial class Horus : BaseQuester
var obj = qs.FindObjective<SpeakCavePasswordObjective>();
var enabled = obj?.Completed == false;
list.Add(new SpeakPasswordEntry(this, pm, enabled));
list.Add(new SpeakPasswordEntry(enabled));
}
}
@ -150,25 +149,13 @@ public partial class Horus : BaseQuester
private class SpeakPasswordEntry : ContextMenuEntry
{
private readonly PlayerMobile _from;
private readonly Horus _horus;
public SpeakPasswordEntry(bool enabled) : base(6193, 3) => Enabled = enabled;
public SpeakPasswordEntry(Horus horus, PlayerMobile from, bool enabled) : base(6193, 3)
public override void OnClick(Mobile from, IEntity target)
{
_horus = horus;
_from = from;
if (!enabled)
if (from.Alive && from is PlayerMobile pm && target is Horus horus)
{
Flags |= CMEFlags.Disabled;
}
}
public override void OnClick()
{
if (_from.Alive)
{
_horus.OnPasswordSpoken(_from);
horus.OnPasswordSpoken(pm);
}
}
}

View file

@ -1,5 +1,5 @@
using System.Collections.Generic;
using ModernUO.Serialization;
using Server.Collections;
using Server.ContextMenus;
using Server.Engines.Plants;
using Server.Items;
@ -141,14 +141,14 @@ public abstract partial class BaseSolenMatriarch : BaseQuester
return true;
}
public override void GetContextMenuEntries(Mobile from, List<ContextMenuEntry> list)
public override void GetContextMenuEntries(Mobile from, ref PooledRefList<ContextMenuEntry> list)
{
base.GetContextMenuEntries(from, list);
base.GetContextMenuEntries(from, ref list);
if (from.Alive && from is PlayerMobile pm && pm.Quest is SolenMatriarchQuest qs && qs.RedSolen == RedSolen &&
qs.IsObjectiveInProgress(typeof(ProcessFungiObjective)))
{
list.Add(new ProcessZoogiFungusEntry(this, pm));
list.Add(new ProcessZoogiFungusEntry());
}
}
@ -197,20 +197,15 @@ public abstract partial class BaseSolenMatriarch : BaseQuester
private class ProcessZoogiFungusEntry : ContextMenuEntry
{
private readonly PlayerMobile _from;
private readonly BaseSolenMatriarch _matriarch;
public ProcessZoogiFungusEntry(BaseSolenMatriarch matriarch, PlayerMobile from) : base(6184)
public ProcessZoogiFungusEntry() : base(6184)
{
_matriarch = matriarch;
_from = from;
}
public override void OnClick()
public override void OnClick(Mobile from, IEntity target)
{
if (_from.Alive)
if (from.Alive && from is PlayerMobile pm && target is BaseSolenMatriarch matriarch)
{
_from.Target = new ProcessFungiTarget(_matriarch, _from);
from.Target = new ProcessFungiTarget(matriarch, pm);
}
}
}

View file

@ -1,8 +1,8 @@
using System;
using System.Collections.Generic;
using System.Runtime.CompilerServices;
using ModernUO.Serialization;
using Server.Accounting;
using Server.Collections;
using Server.ContextMenus;
using Server.Engines.VeteranRewards;
using Server.Gumps;
@ -135,9 +135,9 @@ public partial class CharacterStatue : Mobile, IRewardItem
}
}
public override void GetContextMenuEntries(Mobile from, List<ContextMenuEntry> list)
public override void GetContextMenuEntries(Mobile from, ref PooledRefList<ContextMenuEntry> list)
{
base.GetContextMenuEntries(from, list);
base.GetContextMenuEntries(from, ref list);
if (from.Alive && _sculptedBy != null)
{
@ -145,7 +145,7 @@ public partial class CharacterStatue : Mobile, IRewardItem
if (house?.IsCoOwner(from) == true || from.AccessLevel > AccessLevel.Counselor)
{
list.Add(new DemolishEntry(this));
list.Add(new DemolishEntry());
}
}
}
@ -382,15 +382,15 @@ public partial class CharacterStatue : Mobile, IRewardItem
private class DemolishEntry : ContextMenuEntry
{
private readonly CharacterStatue m_Statue;
public DemolishEntry(CharacterStatue statue) : base(6275, 2) => m_Statue = statue;
public override void OnClick()
public DemolishEntry() : base(6275, 2)
{
if (!m_Statue.Deleted)
}
public override void OnClick(Mobile from, IEntity target)
{
if (from.Alive && target is CharacterStatue { Deleted: false } statue)
{
m_Statue.Demolish(Owner.From);
statue.Demolish(from);
}
}
}