feat: Moves gumps out of the core (#1916)
> [!Important] > **Developer Note** > This code change will **completely move gumps out of the core** ### Summary - Adds `GetGumps()` convenience which exposes methods to Find/Close/Send multiple gumps. This helper is a performance improvement by eliminating the Dictionary<Player, List> lookup for gumps.
This commit is contained in:
Kamron Batman
GitHub
parent
40d99f6d1c
commit
8282b00ca2
246 changed files with 1722 additions and 1383 deletions
289
Projects/UOContent/Gumps/Base/GumpSystem.cs
Normal file
289
Projects/UOContent/Gumps/Base/GumpSystem.cs
Normal file
|
|
@ -0,0 +1,289 @@
|
|||
/*************************************************************************
|
||||
* ModernUO *
|
||||
* Copyright 2019-2023 - ModernUO Development Team *
|
||||
* Email: hi@modernuo.com *
|
||||
* File: GumpSystem.cs *
|
||||
* *
|
||||
* This program is free software: you can redistribute it and/or modify *
|
||||
* it under the terms of the GNU General Public License as published by *
|
||||
* the Free Software Foundation, either version 3 of the License, or *
|
||||
* (at your option) any later version. *
|
||||
* *
|
||||
* You should have received a copy of the GNU General Public License *
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
|
||||
*************************************************************************/
|
||||
|
||||
using Server.Gumps.Base;
|
||||
using Server.Logging;
|
||||
using Server.Network;
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Diagnostics.CodeAnalysis;
|
||||
using System.Runtime.CompilerServices;
|
||||
using System.Runtime.InteropServices;
|
||||
|
||||
namespace Server.Gumps;
|
||||
|
||||
public static partial class GumpSystem
|
||||
{
|
||||
private const int GumpCap = 512;
|
||||
private const int InitialCapacity = 4;
|
||||
|
||||
private static readonly Dictionary<NetState, List<BaseGump>> _gumps = [];
|
||||
private static readonly ILogger _logger = LogFactory.GetLogger(typeof(GumpSystem));
|
||||
|
||||
public static unsafe void Configure()
|
||||
{
|
||||
IncomingPackets.Register(0xB1, 0, true, &DisplayGumpResponse);
|
||||
|
||||
EventSink.Disconnected += EventSink_Disconnected;
|
||||
}
|
||||
|
||||
private static void EventSink_Disconnected(Mobile m)
|
||||
{
|
||||
if (m.NetState != null && _gumps.Remove(m.NetState, out var gumps))
|
||||
{
|
||||
gumps.Clear();
|
||||
}
|
||||
}
|
||||
|
||||
private static ReadOnlySpan<BaseGump> GetAll(NetState ns) =>
|
||||
_gumps.TryGetValue(ns, out var gumps) ? CollectionsMarshal.AsSpan(gumps) : [];
|
||||
|
||||
private static T Find<T>(NetState ns) where T : BaseGump
|
||||
{
|
||||
if (ns == null || !_gumps.TryGetValue(ns, out var gumps))
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
var gumpsSpan = CollectionsMarshal.AsSpan(gumps);
|
||||
for (int i = 0; i < gumpsSpan.Length; i++)
|
||||
{
|
||||
if (gumpsSpan[i] is T tGump)
|
||||
{
|
||||
return tGump;
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
private static void Add(NetState ns, BaseGump gump)
|
||||
{
|
||||
if (ns == null || gump == null)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
if (!_gumps.TryGetValue(ns, out var gumps))
|
||||
{
|
||||
gumps = new List<BaseGump>(InitialCapacity);
|
||||
_gumps.Add(ns, gumps);
|
||||
}
|
||||
|
||||
if (gumps.Count < GumpCap)
|
||||
{
|
||||
gumps.Add(gump);
|
||||
}
|
||||
else
|
||||
{
|
||||
_logger.Information("Exceeded gump cap, disconnecting...");
|
||||
ns.Disconnect("Exceeded gump cap.");
|
||||
}
|
||||
}
|
||||
|
||||
private static void Remove(NetState ns, BaseGump gump)
|
||||
{
|
||||
if (_gumps.TryGetValue(ns, out var gumps))
|
||||
{
|
||||
for (int i = 0; i < gumps.Count; i++)
|
||||
{
|
||||
if (gumps[i] == gump)
|
||||
{
|
||||
gumps.RemoveAt(i);
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private static bool Remove<T>(NetState ns, out T gump) where T : BaseGump
|
||||
{
|
||||
if (ns != null && _gumps.TryGetValue(ns, out var gumps))
|
||||
{
|
||||
var gumpsSpan = CollectionsMarshal.AsSpan(gumps);
|
||||
for (int i = 0; i < gumpsSpan.Length; i++)
|
||||
{
|
||||
if (gumpsSpan[i] is T tGump)
|
||||
{
|
||||
gumps.RemoveAt(i);
|
||||
gump = tGump;
|
||||
return true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
gump = null;
|
||||
return false;
|
||||
}
|
||||
|
||||
private static void Send(NetState ns, BaseGump gump, bool singleton)
|
||||
{
|
||||
if (ns.CannotSendPackets()) // Handles ns null check too
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
ref List<BaseGump> list = ref CollectionsMarshal.GetValueRefOrAddDefault(_gumps, ns, out bool exists);
|
||||
|
||||
if (exists)
|
||||
{
|
||||
bool replaced = false;
|
||||
|
||||
if (singleton || gump.Singleton)
|
||||
{
|
||||
for (int i = 0; i < list.Count; i++)
|
||||
{
|
||||
BaseGump old = list[i];
|
||||
|
||||
if (old.TypeID == gump.TypeID)
|
||||
{
|
||||
ns.SendCloseGump(old.TypeID, 0);
|
||||
old.OnServerClose(ns);
|
||||
|
||||
list[i] = gump;
|
||||
replaced = true;
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (!replaced)
|
||||
{
|
||||
list.Add(gump);
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
list = [gump];
|
||||
}
|
||||
|
||||
gump.SendTo(ns);
|
||||
}
|
||||
|
||||
private static bool Close<T>(NetState ns) where T : BaseGump
|
||||
{
|
||||
if (Remove<T>(ns, out var gump))
|
||||
{
|
||||
ns.SendCloseGump(gump.TypeID, 0);
|
||||
gump.OnServerClose(ns);
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
private static readonly List<BaseGump> _emptyList = [];
|
||||
|
||||
private static NetStateGumps Get(NetState ns)
|
||||
{
|
||||
if (ns == null)
|
||||
{
|
||||
return new NetStateGumps(_emptyList, null);
|
||||
}
|
||||
|
||||
ref List<BaseGump> list = ref CollectionsMarshal.GetValueRefOrAddDefault(_gumps, ns, out bool exists);
|
||||
|
||||
if (!exists)
|
||||
{
|
||||
list = [];
|
||||
}
|
||||
|
||||
return new NetStateGumps(list, ns);
|
||||
}
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public static bool HasGump<T>([DisallowNull] this Mobile m) where T : BaseGump
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(m);
|
||||
return Find<T>(m.NetState) != null;
|
||||
}
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public static T FindGump<T>([DisallowNull] this Mobile m) where T : BaseGump
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(m);
|
||||
return Find<T>(m.NetState);
|
||||
}
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public static bool CloseGump<T>([DisallowNull] this Mobile m) where T : BaseGump
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(m);
|
||||
return Close<T>(m.NetState);
|
||||
}
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public static void SendGump([DisallowNull] this Mobile m, BaseGump g, bool singleton = false)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(m);
|
||||
Send(m.NetState, g, singleton);
|
||||
}
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public static ReadOnlySpan<BaseGump> GetAllGumps([DisallowNull] this Mobile m)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(m);
|
||||
return GetAll(m.NetState);
|
||||
}
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public static NetStateGumps GetGumps([DisallowNull] this Mobile m)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(m);
|
||||
return Get(m.NetState);
|
||||
}
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public static bool HasGump<T>([DisallowNull] this NetState ns) where T : BaseGump
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(ns);
|
||||
return Find<T>(ns) != null;
|
||||
}
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public static void SendGump([DisallowNull] this NetState ns, BaseGump g, bool singleton = false)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(ns);
|
||||
Send(ns, g, singleton);
|
||||
}
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public static bool CloseGump<T>([DisallowNull] this NetState ns) where T : BaseGump
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(ns);
|
||||
return Close<T>(ns);
|
||||
}
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public static ReadOnlySpan<BaseGump> GetAllGumps([DisallowNull] this NetState ns)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(ns);
|
||||
return GetAll(ns);
|
||||
}
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public static void AddGump([DisallowNull] this NetState ns, BaseGump gump)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(ns);
|
||||
Add(ns, gump);
|
||||
}
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public static NetStateGumps GetGumps([DisallowNull] this NetState ns)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(ns);
|
||||
return Get(ns);
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue