warrentyexpired/ModernUO
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix: Fixes localization corner cases with OPL (#1050)

Browse source 
## Changes
- [X] Adds OPL convenience methods
    - `opl.Add(cliloc, value)` and `opl.Add(value)` - value as an integer or string works just like `opl.Add(cliloc, $"{value}")`
    - `opl.AddLocalized(cliloc, clilocValue)` - works the same as `opl.Add(cliloc, $"#{clilocValue}");`
- [X] Simplifies basic `list.Add()` situations
- [X] Changes cliloc as an argument so it works with custom IPropertyList implementations (HTML)
- [X] Fixes plants so they support the old localization and new (changed in 7.0.12.0+)
- [X] Exposes more methods to override for Item to make creating custom OPL possible.

## Important Notes
* Using a ternary as an argument, like this `opl.Add(number, showType ? $"{type}\t{value}" : $"{value}");` _will not use the correct string interpolation_. This means if you use a custom PropertyList (for HTML or some other purpose), the property list won't be localized properly.
* All localization values must be interpolated, even if they are literal strings, or integers. Example: `opl.Add(number, $"{"Charges"}\t{m_Charges}");` is correct. Using the following: `$"Charges\t{m_Charges}"` will not work for custom PropertyList implementations!
This commit is contained in:
Kamron Batman 2022-06-12 21:17:42 -07:00 • committed by GitHub
parent 12404ba6f6
commit b74b47159f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
75 changed files with 715 additions and 477 deletions
Download patch file Download diff file Expand all files Collapse all files

1
Projects/Server/Client/ClientVersion.cs
View file

@ -39,6 +39,7 @@ public class ClientVersion : IComparable<ClientVersion>, IComparer<ClientVersion
public static readonly ClientVersion Version60142 = new("6.0.14.2");
public static readonly ClientVersion Version7000 = new("7.0.0.0");
public static readonly ClientVersion Version7090 = new("7.0.9.0");
public static readonly ClientVersion Version70120 = new("7.0.12.0"); // Plant localization change
public static readonly ClientVersion Version70130 = new("7.0.13.0");
public static readonly ClientVersion Version70160 = new("7.0.16.0");
public static readonly ClientVersion Version70300 = new("7.0.30.0");

23
Projects/Server/Items/Item.cs
View file

@ -1471,8 +1471,7 @@ namespace Server
World.RemoveEntity(this);
OnAfterDelete();
m_PropertyList = null;
ClearProperties();
}
public ISpawner Spawner
@ -1808,9 +1807,9 @@ namespace Server
/// <summary>
/// Overridable. Sends the <see cref="PropertyList">object property list</see> to <paramref name="from" />.
/// </summary>
public virtual void SendPropertiesTo(Mobile from)
public virtual void SendPropertiesTo(NetState ns)
{
from.NetState?.Send(PropertyList.Buffer);
ns?.Send(PropertyList.Buffer);
}
/// <summary>
@ -1829,7 +1828,7 @@ namespace Server
}
else
{
list.Add(1050039, $"{m_Amount}\t#{LabelNumber}"); // ~1_NUMBER~ ~2_ITEMNAME~
list.Add(1050039, $"{m_Amount}\t{LabelNumber:#}"); // ~1_NUMBER~ ~2_ITEMNAME~
}
}
else
@ -1874,35 +1873,35 @@ namespace Server
if (v != 0)
{
list.Add(1060448, $"{v}"); // physical resist ~1_val~%
list.Add(1060448, v); // physical resist ~1_val~%
}
v = FireResistance;
if (v != 0)
{
list.Add(1060447, $"{v}"); // fire resist ~1_val~%
list.Add(1060447, v); // fire resist ~1_val~%
}
v = ColdResistance;
if (v != 0)
{
list.Add(1060445, $"{v}"); // cold resist ~1_val~%
list.Add(1060445, v); // cold resist ~1_val~%
}
v = PoisonResistance;
if (v != 0)
{
list.Add(1060449, $"{v}"); // poison resist ~1_val~%
list.Add(1060449, v); // poison resist ~1_val~%
}
v = EnergyResistance;
if (v != 0)
{
list.Add(1060446, $"{v}"); // energy resist ~1_val~%
list.Add(1060446, v); // energy resist ~1_val~%
}
}
@ -2401,7 +2400,7 @@ namespace Server
return list;
}
public void ClearProperties()
public virtual void ClearProperties()
{
m_PropertyList = null;
}
@ -3080,7 +3079,7 @@ namespace Server
SendOPLPacketTo(ns, opl);
}
public void SendOPLPacketTo(NetState ns, Span<byte> opl = default)
public virtual void SendOPLPacketTo(NetState ns, Span<byte> opl = default)
{
if (!ObjectPropertyList.Enabled)
{

17
Projects/Server/Mobiles/Mobile.cs
View file

@ -3413,9 +3413,9 @@ namespace Server
public int GetAOSStatus(int index) => AOSStatusHandler?.Invoke(this, index) ?? 0;
public virtual void SendPropertiesTo(Mobile from)
public virtual void SendPropertiesTo(NetState ns)
{
from.NetState?.Send(PropertyList.Buffer);
ns?.Send(PropertyList.Buffer);
}
public virtual void OnAosSingleClick(Mobile from)
@ -3485,11 +3485,14 @@ namespace Server
if (guildTitle.Length > 0)
{
list.Add(
NewGuildDisplay
? $"{Utility.FixHtml(guildTitle)}, {Utility.FixHtml(guild.Name)}"
: $"{Utility.FixHtml(guildTitle)}, {Utility.FixHtml(guild.Name)} Guild{type}"
);
if (NewGuildDisplay)
{
list.Add($"{Utility.FixHtml(guildTitle)}, {Utility.FixHtml(guild.Name)}");
}
else
{
list.Add($"{Utility.FixHtml(guildTitle)}, {Utility.FixHtml(guild.Name)} Guild{type}");
}
}
else
{

4
Projects/Server/Network/Packets/IncomingEntityPackets.cs
View file

@ -175,7 +175,7 @@ public static class IncomingEntityPackets
if (m != null && from.CanSee(m) && Utility.InUpdateRange(from.Location, m.Location))
{
m.SendPropertiesTo(from);
m.SendPropertiesTo(state);
}
}
else if (s.IsItem)
@ -185,7 +185,7 @@ public static class IncomingEntityPackets
if (item?.Deleted == false && from.CanSee(item) &&
Utility.InUpdateRange(from.Location, item.GetWorldLocation()))
{
item.SendPropertiesTo(from);
item.SendPropertiesTo(state);
}
}
}

4
Projects/Server/Network/Packets/IncomingExtendedCommandPackets.cs
View file

@ -330,7 +330,7 @@ public static class IncomingExtendedCommandPackets
if (m != null && from.CanSee(m) && Utility.InUpdateRange(from.Location, m.Location))
{
m.SendPropertiesTo(from);
m.SendPropertiesTo(state);
}
}
else if (s.IsItem)
@ -340,7 +340,7 @@ public static class IncomingExtendedCommandPackets
if (item?.Deleted == false && from.CanSee(item) &&
Utility.InUpdateRange(from.Location, item.GetWorldLocation()))
{
item.SendPropertiesTo(from);
item.SendPropertiesTo(state);
}
}
}

18
Projects/Server/PropertyList/IPropertyList.cs
View file

@ -22,9 +22,25 @@ public interface IPropertyList : ISelfInterpolatedStringHandler
{
public void Reset();
public void Terminate();
public void Add(int number, string argument = null);
public void Add(int number);
/** Convenience method for $"{argument}". */
public void Add(int number, string argument);
/** Convenience method for $"{text}". */
public void Add(string text);
/** Convenience method for $"{value}". */
public void Add(int number, int value);
/** Convenience method for $"{value:#}". */
public void AddLocalized(int value);
/** Convenience method for $"{value:#}". */
public void AddLocalized(int number, int value);
// String Interpolation
public void Add([InterpolatedStringHandlerArgument("")] ref InterpolatedStringHandler handler);
public void Add(int number, [InterpolatedStringHandlerArgument("")] ref InterpolatedStringHandler handler);
}

53
Projects/Server/PropertyList/ObjectPropertyList.cs
View file

@ -119,29 +119,22 @@ public sealed class ObjectPropertyList : IPropertyList, IDisposable
_hash ^= (val >> 26) & 0x3F;
}
public void Add(int number, string? arguments = null)
public void Add(int number)
{
if (number == 0)
{
return;
}
arguments ??= "";
if (Header == 0)
{
Header = number;
HeaderArgs = arguments;
HeaderArgs = "";
}
AddHash(number);
if (arguments.Length > 0)
{
AddHash(arguments.GetHashCode(StringComparison.Ordinal));
}
int strLength = arguments.Length * 2;
int length = _bufferPos + 6 + strLength;
int length = _bufferPos + 6;
while (length > _buffer.Length)
{
Flush();
@ -149,24 +142,31 @@ public sealed class ObjectPropertyList : IPropertyList, IDisposable
var writer = new SpanWriter(_buffer.AsSpan(_bufferPos));
writer.Write(number);
writer.Write((ushort)strLength);
writer.WriteLittleUni(arguments);
_bufferPos += writer.BytesWritten;
_pos = 0;
writer.Write((ushort)0);
_bufferPos += 6;
}
public void Add(int number, string? arguments) => InternalAdd(number, $"{arguments}");
public void Add(string argument) => InternalAdd(GetStringNumber(), $"{argument}");
public void Add(int number, int value) => InternalAdd(number, $"{value}");
public void AddLocalized(int value) => InternalAdd(GetStringNumber(), $"{value:#}");
public void AddLocalized(int number, int value) => InternalAdd(number, $"{value:#}");
private int GetStringNumber() => _stringNumbers[_stringNumbersIndex++ % _stringNumbers.Length];
public void Add(string argument) => Add(GetStringNumber(), argument);
// String Interpolation
public void Add(
[InterpolatedStringHandlerArgument("")]
ref IPropertyList.InterpolatedStringHandler handler
) => Add(GetStringNumber(), ref handler);
) => InternalAdd(GetStringNumber(), ref handler);
// String Interpolation
public void Add(
int number,
[InterpolatedStringHandlerArgument("")]
ref IPropertyList.InterpolatedStringHandler handler
) => InternalAdd(number, ref handler);
private void InternalAdd(
int number,
[InterpolatedStringHandlerArgument("")]
ref IPropertyList.InterpolatedStringHandler handler)
@ -182,14 +182,10 @@ public sealed class ObjectPropertyList : IPropertyList, IDisposable
{
Header = number;
HeaderArgs = chars.ToString();
HeaderArgs.GetHashCode(StringComparison.Ordinal);
}
AddHash(number);
if (chars.Length > 0)
{
AddHash(string.GetHashCode(chars, StringComparison.Ordinal));
}
AddHash(string.GetHashCode(chars, StringComparison.Ordinal));
int strLength = chars.Length * 2;
int length = _bufferPos + 6 + strLength;
@ -253,7 +249,6 @@ public sealed class ObjectPropertyList : IPropertyList, IDisposable
public void AppendFormatted<T>(T value)
{
string? s;
if (value is IFormattable)
{
@ -284,6 +279,14 @@ public sealed class ObjectPropertyList : IPropertyList, IDisposable
public void AppendFormatted<T>(T value, string? format)
{
// We support localization '#' cliloc formatter for custom property lists
// This allows someone to build an IPropertyList that creates HTML using the same syntax as LocalizationInterpolationHandler
if (format == "#")
{
AppendLiteral("#");
format = null;
}
string? s;
if (value is IFormattable)
{