ModernUO/Projects/Server/Network/Packets/OutgoingMessagePackets.Broadcast.cs
Kamron Batman 5f9fa88220
perf: Zero-alloc interpolation for SendMessage/Overhead APIs (#2434)
## Summary

Phase 1 of a multi-phase optimization to eliminate intermediate string allocations between `$"..."` interpolation and the packet text region for ModernUO's player-facing message APIs.

- Adds `[InterpolatedStringHandler]` overloads to every `Send*`/`Public/Local/Private/NonlocalOverheadMessage`/`Say`/`Emote`/`Whisper`/`Yell`/`SendLocalizedMessageTo` API in `OutgoingMessagePackets`, `Mobile`, and `Item`. Each overload is a 3-line shim that forwards `handler.Text` to the existing span-based path then calls `handler.Clear()` to return the rented `STArrayPool<char>` buffer (matches the established `SpanWriter.WriteAscii(ref RawInterpolatedStringHandler)` precedent).
- Converts `string text/args/affix/name` parameters to `ReadOnlySpan<char>` for consistency with the handler path. `lang` intentionally stays `string` (it's never interpolated and the `??= "ENU"` fallback stays cleaner).
- Adds `int charCount` overloads of the three `GetMaxMessage*Length` helpers so stackalloc sizing can avoid the redundant `ROS<char>` round-trip.
- Moves `Mobile` (17 methods) and `Item` (4 methods) message methods into new partial-class files (`Mobile.Messages.cs`, `Item.Messages.cs`) for organization.

No UOContent call sites change in this PR — existing `string`/`ROS<char>` calls compile unchanged via implicit conversion. Phase 2 (intermediate-string audit) and Phase 3 (cleanup PRs) follow.

## Files

- `Projects/Server/Network/Packets/OutgoingMessagePackets.cs` — `string` → `ROS<char>` for text params, `int charCount` length helpers added, class made `partial`
- `Projects/Server/Network/Packets/OutgoingMessagePackets.Interpolated.cs` (new) — 3 `ref RawInterpolatedStringHandler` extension overloads
- `Projects/Server/Mobiles/Mobile.cs` — message methods extracted (-262 lines)
- `Projects/Server/Mobiles/Mobile.Messages.cs` (new, 463 lines) — moved + ROS-converted methods + 25 handler overloads
- `Projects/Server/Items/Item.cs` — message methods extracted (-93 lines)
- `Projects/Server/Items/Item.Messages.cs` (new, 142 lines) — moved + ROS-converted methods + 4 handler overloads
- `Projects/Server.Tests/Tests/Network/Packets/Outgoing/MessagePacketTests.cs` — 3 new regression tests verifying byte-equivalence for the handler overloads
2026-05-03 18:04:02 -07:00

182 lines
5.9 KiB
C#

/*************************************************************************
* ModernUO *
* Copyright 2019-2026 - ModernUO Development Team *
* Email: hi@modernuo.com *
* File: OutgoingMessagePackets.Broadcast.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 System;
namespace Server.Network;
public static partial class OutgoingMessagePackets
{
public static void BroadcastMessageLocalized<TFilter>(
Map map, Point3D location,
Serial serial, int graphic, MessageType type, int hue, int font,
int number, ReadOnlySpan<char> name, ReadOnlySpan<char> args,
TFilter filter
) where TFilter : struct, IBroadcastFilter
{
if (map == null)
{
return;
}
var buffer = stackalloc byte[GetMaxMessageLocalizedLength(args.Length)].InitializePacket();
foreach (var state in map.GetClientsInRange(location))
{
if (filter.Allow(state))
{
var length = CreateMessageLocalized(
buffer, serial, graphic, type, hue, font, number, name, args
);
if (length != buffer.Length)
{
buffer = buffer[..length];
}
state.Send(buffer);
}
}
}
public static void BroadcastMessageLocalized<TFilter>(
Map map, Point3D location, int range,
Serial serial, int graphic, MessageType type, int hue, int font,
int number, ReadOnlySpan<char> name, ReadOnlySpan<char> args,
TFilter filter
) where TFilter : struct, IBroadcastFilter
{
if (map == null)
{
return;
}
var buffer = stackalloc byte[GetMaxMessageLocalizedLength(args.Length)].InitializePacket();
foreach (var state in map.GetClientsInRange(location, range))
{
if (filter.Allow(state))
{
var length = CreateMessageLocalized(
buffer, serial, graphic, type, hue, font, number, name, args
);
if (length != buffer.Length)
{
buffer = buffer[..length];
}
state.Send(buffer);
}
}
}
public static void BroadcastMessageLocalizedAffix<TFilter>(
Map map, Point3D location,
Serial serial, int graphic, MessageType type, int hue, int font,
int number, ReadOnlySpan<char> name, AffixType affixType,
ReadOnlySpan<char> affix, ReadOnlySpan<char> args,
TFilter filter
) where TFilter : struct, IBroadcastFilter
{
if (map == null)
{
return;
}
var buffer = stackalloc byte[GetMaxMessageLocalizedAffixLength(affix.Length, args.Length)].InitializePacket();
foreach (var state in map.GetClientsInRange(location))
{
if (filter.Allow(state))
{
var length = CreateMessageLocalizedAffix(
buffer, serial, graphic, type, hue, font, number, name, affixType, affix, args
);
if (length != buffer.Length)
{
buffer = buffer[..length];
}
state.Send(buffer);
}
}
}
public static void BroadcastMessage<TFilter>(
Map map, Point3D location,
Serial serial, int graphic, MessageType type, int hue, int font, bool ascii,
string lang, ReadOnlySpan<char> name, ReadOnlySpan<char> text,
TFilter filter
) where TFilter : struct, IBroadcastFilter
{
if (map == null)
{
return;
}
var buffer = stackalloc byte[GetMaxMessageLength(text.Length)].InitializePacket();
foreach (var state in map.GetClientsInRange(location))
{
if (filter.Allow(state))
{
var length = CreateMessage(
buffer, serial, graphic, type, hue, font, ascii, lang, name, text
);
if (length != buffer.Length)
{
buffer = buffer[..length];
}
state.Send(buffer);
}
}
}
public static void BroadcastMessage<TFilter>(
Map map, Point3D location, int range,
Serial serial, int graphic, MessageType type, int hue, int font, bool ascii,
string lang, ReadOnlySpan<char> name, ReadOnlySpan<char> text,
TFilter filter
) where TFilter : struct, IBroadcastFilter
{
if (map == null)
{
return;
}
var buffer = stackalloc byte[GetMaxMessageLength(text.Length)].InitializePacket();
foreach (var state in map.GetClientsInRange(location, range))
{
if (filter.Allow(state))
{
var length = CreateMessage(
buffer, serial, graphic, type, hue, font, ascii, lang, name, text
);
if (length != buffer.Length)
{
buffer = buffer[..length];
}
state.Send(buffer);
}
}
}
}