feat(chat): port retail's @pklite client command (EnterPkLite 0x028F)
acdream never implemented @pklite. It is a CLIENT command in retail, not a
server one — ACE has no pklite text-command handler — so typing it forwarded as
inert chat text that the server ignored.
Retail: ClientCommunicationSystem::DoPKLite @0x0057A490 rejects with
WeenieError 0x507 when ACCWeenieObject::IsPlayerKiller @0x0058C910 is true
(that returns true when EITHER the PK bit 0x20 OR the PKLite bit 0x2000000 is
set), prints "Please see @help pklite for more..." and sends nothing if given
any argument text, and otherwise calls CM_Character::Event_EnterPKLite
@0x006A13F0 — a bare 12-byte parameterless game action, opcode 0x28F, the same
shape as Event_LoginCompleteNotification beside it. Verb string at 0x007E16B0,
help text at 0x007DF0C8, failure string at 0x007D31E8; one verb, no alias.
HasPlayerFlag is a tri-state (null = the local PublicWeenieDesc has not
arrived). The existing arena gates compare `== false` because they reject on a
known-FALSE flag; retail's DoPKLite gates the other way, rejecting on
known-TRUE. So this case compares `== true` on either bit: an indeterminate
description sends rather than blocks, which matches retail trusting the server
instead of inventing a client-side suppression rule.
Landed as its own commit because it is retail-faithful on its own merits, but
the motivation is C4 route 2: ACE advances SequenceType.ObjectForcePosition in
exactly two places, and the only reachable one is Player.HandleActionEnterPkLite's
entry-collision bump (allow_pkl_bump, default on). Every admin teleport advances
ObjectTeleport instead, so @teleto-style displacement exercises route 3, not
route 2. Without this command route 2 has no connected acceptance gate at all.
Gates: complete Release solution 10,867 passed / 4 skipped / 0 failed
(9966b531 baseline 10,858/4/0; +9 = the 9 tests added). Coverage includes both
known-true rejections, the known-false success case, the tri-state unknown
case, the 12-byte wire envelope, and @pklite resolving as ClientHandled rather
than falling through to the server-text path.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
parent
9966b53174
commit
69ba9486b6
13 changed files with 146 additions and 8 deletions
|
|
@ -340,7 +340,8 @@ internal sealed class LiveSessionCommandRouter : ILiveSessionCommandRouting
|
||||||
ClearDesiredComponents: () => InvokeClient(static b => b.ClearDesiredComponents()),
|
ClearDesiredComponents: () => InvokeClient(static b => b.ClearDesiredComponents()),
|
||||||
HasOpenVendor: () => ReadClient(static b => b.HasOpenVendor(), false),
|
HasOpenVendor: () => ReadClient(static b => b.HasOpenVendor(), false),
|
||||||
FillComponentBuyList: (componentId, targetCount) =>
|
FillComponentBuyList: (componentId, targetCount) =>
|
||||||
InvokeClient(b => b.FillComponentBuyList(componentId, targetCount)));
|
InvokeClient(b => b.FillComponentBuyList(componentId, targetCount)),
|
||||||
|
EnterPkLite: () => InvokeClient(static b => b.EnterPkLite()));
|
||||||
|
|
||||||
private bool InvokeClient(Action<ClientCommandController.Bindings> invoke)
|
private bool InvokeClient(Action<ClientCommandController.Bindings> invoke)
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -376,7 +376,8 @@ internal sealed class LiveSessionRuntimeFactory
|
||||||
session.SendClearDesiredComponents();
|
session.SendClearDesiredComponents();
|
||||||
},
|
},
|
||||||
HasOpenVendor: () => false,
|
HasOpenVendor: () => false,
|
||||||
FillComponentBuyList: (_, _) => { }),
|
FillComponentBuyList: (_, _) => { },
|
||||||
|
EnterPkLite: session.SendEnterPkLite),
|
||||||
_domain.Communication.Chat,
|
_domain.Communication.Chat,
|
||||||
_domain.Communication.TurbineChat,
|
_domain.Communication.TurbineChat,
|
||||||
PlayerGuid: () => _player.Identity.ServerGuid,
|
PlayerGuid: () => _player.Identity.ServerGuid,
|
||||||
|
|
|
||||||
|
|
@ -57,7 +57,8 @@ public sealed class ClientCommandController
|
||||||
Func<string?> LastTeller,
|
Func<string?> LastTeller,
|
||||||
Action ClearDesiredComponents,
|
Action ClearDesiredComponents,
|
||||||
Func<bool> HasOpenVendor,
|
Func<bool> HasOpenVendor,
|
||||||
Action<uint?, uint> FillComponentBuyList);
|
Action<uint?, uint> FillComponentBuyList,
|
||||||
|
Action EnterPkLite);
|
||||||
|
|
||||||
private readonly Bindings _bindings;
|
private readonly Bindings _bindings;
|
||||||
|
|
||||||
|
|
@ -94,6 +95,22 @@ public sealed class ClientCommandController
|
||||||
else
|
else
|
||||||
_bindings.TeleportToPkLiteArena();
|
_bindings.TeleportToPkLiteArena();
|
||||||
break;
|
break;
|
||||||
|
// ClientCommunicationSystem::DoPKLite @ 0x0057A490 rejects with
|
||||||
|
// WeenieError 0x507 when ACCWeenieObject::IsPlayerKiller @
|
||||||
|
// 0x0058C910 is true — that is, when EITHER the PK bit (0x20) OR
|
||||||
|
// the PKLite bit (0x2000000) is already set. Unlike the arena
|
||||||
|
// gates above (which reject on a known-false flag and so already
|
||||||
|
// send on an indeterminate one), this gate must reject only on a
|
||||||
|
// known-TRUE flag: an unknown/indeterminate PublicWeenieDesc
|
||||||
|
// still sends, matching retail's send-and-let-the-server-decide
|
||||||
|
// default for a description that has not arrived yet.
|
||||||
|
case ClientCommandId.EnterPkLite:
|
||||||
|
if (HasPlayerFlag(EntityCollisionFlags.IsPK) == true
|
||||||
|
|| HasPlayerFlag(EntityCollisionFlags.IsPKLite) == true)
|
||||||
|
_bindings.ShowWeenieError(0x0507u);
|
||||||
|
else
|
||||||
|
_bindings.EnterPkLite();
|
||||||
|
break;
|
||||||
case ClientCommandId.HouseRecall:
|
case ClientCommandId.HouseRecall:
|
||||||
_bindings.TeleportToHouse();
|
_bindings.TeleportToHouse();
|
||||||
break;
|
break;
|
||||||
|
|
@ -652,9 +669,12 @@ public sealed class ClientCommandController
|
||||||
+ "@afk msg <message> - Set the message that will be sent to players that send you directed chat while you are in AFK mode. Issuing \"@afk msg\" with no message will set your AFK message back to the default. Your custom AFK message is limited to 192 characters.\n";
|
+ "@afk msg <message> - Set the message that will be sent to players that send you directed chat while you are in AFK mode. Issuing \"@afk msg\" with no message will set your AFK message back to the default. Your custom AFK message is limited to 192 characters.\n";
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Null means the local PublicWeenieDesc has not arrived yet. Retail only
|
/// Tri-state: null means the local PublicWeenieDesc has not arrived yet.
|
||||||
/// rejects when it has a player object and the required bit is absent, so
|
/// Callers must gate on the direction retail actually rejects in — some
|
||||||
/// unknown follows the same send-and-let-the-server-decide path.
|
/// gates (the arena recalls) reject on a known-false flag, others (@pklite)
|
||||||
|
/// reject on a known-true flag — so an unknown flag always falls through
|
||||||
|
/// to sending, matching retail's send-and-let-the-server-decide default
|
||||||
|
/// for a description that has not arrived yet.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
private bool? HasPlayerFlag(EntityCollisionFlags flag)
|
private bool? HasPlayerFlag(EntityCollisionFlags flag)
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -14,6 +14,7 @@ public static class ClientCommandRequests
|
||||||
public const uint MarketplaceOpcode = 0x028Du;
|
public const uint MarketplaceOpcode = 0x028Du;
|
||||||
public const uint PkArenaOpcode = 0x0027u;
|
public const uint PkArenaOpcode = 0x0027u;
|
||||||
public const uint PkLiteArenaOpcode = 0x0026u;
|
public const uint PkLiteArenaOpcode = 0x0026u;
|
||||||
|
public const uint EnterPkLiteOpcode = 0x028Fu;
|
||||||
public const uint HouseRecallOpcode = 0x0262u;
|
public const uint HouseRecallOpcode = 0x0262u;
|
||||||
public const uint MansionRecallOpcode = 0x0278u;
|
public const uint MansionRecallOpcode = 0x0278u;
|
||||||
public const uint QueryAgeOpcode = 0x01C2u;
|
public const uint QueryAgeOpcode = 0x01C2u;
|
||||||
|
|
@ -54,6 +55,11 @@ public static class ClientCommandRequests
|
||||||
public static byte[] BuildPkLiteArena(uint sequence) =>
|
public static byte[] BuildPkLiteArena(uint sequence) =>
|
||||||
BuildParameterless(sequence, PkLiteArenaOpcode);
|
BuildParameterless(sequence, PkLiteArenaOpcode);
|
||||||
|
|
||||||
|
// CM_Character::Event_EnterPKLite @ 0x006A13F0 — 12-byte parameterless
|
||||||
|
// game action, opcode 0x28F, identical shape to Event_LoginCompleteNotification.
|
||||||
|
public static byte[] BuildEnterPkLite(uint sequence) =>
|
||||||
|
BuildParameterless(sequence, EnterPkLiteOpcode);
|
||||||
|
|
||||||
public static byte[] BuildHouseRecall(uint sequence) =>
|
public static byte[] BuildHouseRecall(uint sequence) =>
|
||||||
BuildParameterless(sequence, HouseRecallOpcode);
|
BuildParameterless(sequence, HouseRecallOpcode);
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2102,6 +2102,13 @@ public sealed class WorldSession : IDisposable
|
||||||
SendGameAction(ClientCommandRequests.BuildPkLiteArena(seq));
|
SendGameAction(ClientCommandRequests.BuildPkLiteArena(seq));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>Send retail @pklite / Enter PK Lite request (0x028F).</summary>
|
||||||
|
public void SendEnterPkLite()
|
||||||
|
{
|
||||||
|
uint seq = NextGameActionSequence();
|
||||||
|
SendGameAction(ClientCommandRequests.BuildEnterPkLite(seq));
|
||||||
|
}
|
||||||
|
|
||||||
/// <summary>Send retail personal-house recall (0x0262).</summary>
|
/// <summary>Send retail personal-house recall (0x0262).</summary>
|
||||||
public void SendTeleportToHouse()
|
public void SendTeleportToHouse()
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -12,6 +12,7 @@ public enum ClientCommandId
|
||||||
MarketplaceRecall,
|
MarketplaceRecall,
|
||||||
PkArenaRecall,
|
PkArenaRecall,
|
||||||
PkLiteArenaRecall,
|
PkLiteArenaRecall,
|
||||||
|
EnterPkLite,
|
||||||
HouseRecall,
|
HouseRecall,
|
||||||
MansionRecall,
|
MansionRecall,
|
||||||
QueryAge,
|
QueryAge,
|
||||||
|
|
|
||||||
|
|
@ -50,6 +50,14 @@ public static class RetailClientCommandCatalog
|
||||||
"/pklarena",
|
"/pklarena",
|
||||||
"/pklarena (/pla) - Teleports a PKLite player to the PKLite Arena.");
|
"/pklarena (/pla) - Teleports a PKLite player to the PKLite Arena.");
|
||||||
|
|
||||||
|
// ClientCommunicationSystem::DoPKLite/HelpPKLite @ 0x0057A490/0x0057A540.
|
||||||
|
// Retail registers exactly one verb string ("pklite" @ 0x007E16B0) — no
|
||||||
|
// alias, unlike most of this catalog.
|
||||||
|
private static readonly Definition PkLite = NoArguments(
|
||||||
|
ClientCommandId.EnterPkLite,
|
||||||
|
"/pklite",
|
||||||
|
"@pklite - Sets your status to Player Killer Lite. Type @help pklite for more details.");
|
||||||
|
|
||||||
private static readonly Definition HouseRecall = NoArguments(
|
private static readonly Definition HouseRecall = NoArguments(
|
||||||
ClientCommandId.HouseRecall,
|
ClientCommandId.HouseRecall,
|
||||||
"/house recall",
|
"/house recall",
|
||||||
|
|
@ -207,6 +215,7 @@ public static class RetailClientCommandCatalog
|
||||||
["pka"] = PkArena,
|
["pka"] = PkArena,
|
||||||
["pklarena"] = PkLiteArena,
|
["pklarena"] = PkLiteArena,
|
||||||
["pla"] = PkLiteArena,
|
["pla"] = PkLiteArena,
|
||||||
|
["pklite"] = PkLite,
|
||||||
["hor"] = HouseRecall,
|
["hor"] = HouseRecall,
|
||||||
["hr"] = HouseRecall,
|
["hr"] = HouseRecall,
|
||||||
["hom"] = MansionRecall,
|
["hom"] = MansionRecall,
|
||||||
|
|
@ -310,6 +319,7 @@ public static class RetailClientCommandCatalog
|
||||||
Marketplace.HelpText,
|
Marketplace.HelpText,
|
||||||
PkArena.HelpText,
|
PkArena.HelpText,
|
||||||
PkLiteArena.HelpText,
|
PkLiteArena.HelpText,
|
||||||
|
PkLite.HelpText,
|
||||||
HouseRecall.HelpText,
|
HouseRecall.HelpText,
|
||||||
MansionRecall.HelpText,
|
MansionRecall.HelpText,
|
||||||
QueryAge.HelpText,
|
QueryAge.HelpText,
|
||||||
|
|
|
||||||
|
|
@ -374,5 +374,6 @@ public sealed class LiveSessionCommandRouterTests
|
||||||
LastTeller: () => null,
|
LastTeller: () => null,
|
||||||
ClearDesiredComponents: () => { },
|
ClearDesiredComponents: () => { },
|
||||||
HasOpenVendor: () => false,
|
HasOpenVendor: () => false,
|
||||||
FillComponentBuyList: (_, _) => { });
|
FillComponentBuyList: (_, _) => { },
|
||||||
|
EnterPkLite: () => { });
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -58,6 +58,68 @@ public sealed class ClientCommandControllerTests
|
||||||
Assert.Equal([0x0560u], errors);
|
Assert.Equal([0x0560u], errors);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void EnterPkLite_NonPk_SendsTheRetailGameAction()
|
||||||
|
{
|
||||||
|
var calls = new List<string>();
|
||||||
|
var errors = new List<uint>();
|
||||||
|
var controller = NewController(calls, errors, playerBitfield: 0x8u);
|
||||||
|
|
||||||
|
controller.Execute(new ExecuteClientCommandCmd(
|
||||||
|
ClientCommandId.EnterPkLite, string.Empty));
|
||||||
|
|
||||||
|
Assert.Equal(["pklite"], calls);
|
||||||
|
Assert.Empty(errors);
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void EnterPkLite_AlreadyPk_ShowsRetailFailureWithoutSending()
|
||||||
|
{
|
||||||
|
var calls = new List<string>();
|
||||||
|
var errors = new List<uint>();
|
||||||
|
// 0x20 = ACCWeenieObject::IsPK bit only.
|
||||||
|
var controller = NewController(calls, errors, playerBitfield: 0x20u);
|
||||||
|
|
||||||
|
controller.Execute(new ExecuteClientCommandCmd(
|
||||||
|
ClientCommandId.EnterPkLite, string.Empty));
|
||||||
|
|
||||||
|
Assert.Empty(calls);
|
||||||
|
Assert.Equal([0x0507u], errors);
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void EnterPkLite_AlreadyPkLite_ShowsRetailFailureWithoutSending()
|
||||||
|
{
|
||||||
|
var calls = new List<string>();
|
||||||
|
var errors = new List<uint>();
|
||||||
|
// 0x2000000 = ACCWeenieObject::IsPKLite bit only.
|
||||||
|
var controller = NewController(calls, errors, playerBitfield: 0x2000000u);
|
||||||
|
|
||||||
|
controller.Execute(new ExecuteClientCommandCmd(
|
||||||
|
ClientCommandId.EnterPkLite, string.Empty));
|
||||||
|
|
||||||
|
Assert.Empty(calls);
|
||||||
|
Assert.Equal([0x0507u], errors);
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void EnterPkLite_UnknownPlayerDescription_SendsRatherThanRejects()
|
||||||
|
{
|
||||||
|
// Tri-state decision: retail's DoPKLite only rejects when
|
||||||
|
// IsPlayerKiller() is TRUE. An indeterminate PublicWeenieDesc (not
|
||||||
|
// yet arrived) must send, not reject -- the opposite direction from
|
||||||
|
// the arena recalls, which gate on the flag being known-true.
|
||||||
|
var calls = new List<string>();
|
||||||
|
var errors = new List<uint>();
|
||||||
|
var controller = NewController(calls, errors, playerBitfield: null);
|
||||||
|
|
||||||
|
controller.Execute(new ExecuteClientCommandCmd(
|
||||||
|
ClientCommandId.EnterPkLite, string.Empty));
|
||||||
|
|
||||||
|
Assert.Equal(["pklite"], calls);
|
||||||
|
Assert.Empty(errors);
|
||||||
|
}
|
||||||
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public void MissingPlayerDescription_DoesNotInventAClientRejection()
|
public void MissingPlayerDescription_DoesNotInventAClientRejection()
|
||||||
{
|
{
|
||||||
|
|
@ -314,6 +376,7 @@ public sealed class ClientCommandControllerTests
|
||||||
() => lastTeller,
|
() => lastTeller,
|
||||||
() => calls.Add("clearcomps"),
|
() => calls.Add("clearcomps"),
|
||||||
() => vendorOpen,
|
() => vendorOpen,
|
||||||
(category, price) => calls.Add($"fillcomps:{category}:{price}")));
|
(category, price) => calls.Add($"fillcomps:{category}:{price}"),
|
||||||
|
() => calls.Add("pklite")));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -10,6 +10,7 @@ public sealed class ClientCommandRequestsTests
|
||||||
{ ClientCommandRequests.BuildMarketplace, ClientCommandRequests.MarketplaceOpcode },
|
{ ClientCommandRequests.BuildMarketplace, ClientCommandRequests.MarketplaceOpcode },
|
||||||
{ ClientCommandRequests.BuildPkArena, ClientCommandRequests.PkArenaOpcode },
|
{ ClientCommandRequests.BuildPkArena, ClientCommandRequests.PkArenaOpcode },
|
||||||
{ ClientCommandRequests.BuildPkLiteArena, ClientCommandRequests.PkLiteArenaOpcode },
|
{ ClientCommandRequests.BuildPkLiteArena, ClientCommandRequests.PkLiteArenaOpcode },
|
||||||
|
{ ClientCommandRequests.BuildEnterPkLite, ClientCommandRequests.EnterPkLiteOpcode },
|
||||||
{ ClientCommandRequests.BuildHouseRecall, ClientCommandRequests.HouseRecallOpcode },
|
{ ClientCommandRequests.BuildHouseRecall, ClientCommandRequests.HouseRecallOpcode },
|
||||||
{ ClientCommandRequests.BuildMansionRecall, ClientCommandRequests.MansionRecallOpcode },
|
{ ClientCommandRequests.BuildMansionRecall, ClientCommandRequests.MansionRecallOpcode },
|
||||||
{ ClientCommandRequests.BuildSuicide, ClientCommandRequests.SuicideOpcode },
|
{ ClientCommandRequests.BuildSuicide, ClientCommandRequests.SuicideOpcode },
|
||||||
|
|
|
||||||
|
|
@ -89,4 +89,17 @@ public sealed class WorldSessionChatTests
|
||||||
Assert.NotNull(captured);
|
Assert.NotNull(captured);
|
||||||
Assert.Equal(InteractRequests.BuildTeleToLifestone(1), captured);
|
Assert.Equal(InteractRequests.BuildTeleToLifestone(1), captured);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void SendEnterPkLite_EmitsRetailGameAction()
|
||||||
|
{
|
||||||
|
using var session = NewSession();
|
||||||
|
byte[]? captured = null;
|
||||||
|
session.GameActionCapture = body => captured = body;
|
||||||
|
|
||||||
|
session.SendEnterPkLite();
|
||||||
|
|
||||||
|
Assert.NotNull(captured);
|
||||||
|
Assert.Equal(ClientCommandRequests.BuildEnterPkLite(1), captured);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -87,6 +87,18 @@ public class ChatCommandRouterTests
|
||||||
Assert.Contains(log.Snapshot(), entry => entry.Text == "Usage: /lifestone");
|
Assert.Contains(log.Snapshot(), entry => entry.Text == "Usage: /lifestone");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void PkLiteAlias_ResolvesAsClientHandled_NotTheServerTextPath()
|
||||||
|
{
|
||||||
|
var (vm, _, bus) = Fixture();
|
||||||
|
|
||||||
|
var outcome = ChatCommandRouter.Submit("@pklite", vm, bus, ChatChannelKind.Say);
|
||||||
|
|
||||||
|
Assert.Equal(SubmitOutcome.ClientHandled, outcome);
|
||||||
|
var command = Assert.IsType<ExecuteClientCommandCmd>(Assert.Single(bus.Published));
|
||||||
|
Assert.Equal(ClientCommandId.EnterPkLite, command.Command);
|
||||||
|
}
|
||||||
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public void UnknownSlashVerb_RoutesThroughExplicitServerCommand()
|
public void UnknownSlashVerb_RoutesThroughExplicitServerCommand()
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -28,6 +28,8 @@ public sealed class RetailClientCommandCatalogTests
|
||||||
[InlineData("/pka", ClientCommandId.PkArenaRecall)]
|
[InlineData("/pka", ClientCommandId.PkArenaRecall)]
|
||||||
[InlineData("/pklarena", ClientCommandId.PkLiteArenaRecall)]
|
[InlineData("/pklarena", ClientCommandId.PkLiteArenaRecall)]
|
||||||
[InlineData("/pla", ClientCommandId.PkLiteArenaRecall)]
|
[InlineData("/pla", ClientCommandId.PkLiteArenaRecall)]
|
||||||
|
[InlineData("/pklite", ClientCommandId.EnterPkLite)]
|
||||||
|
[InlineData("@pklite", ClientCommandId.EnterPkLite)]
|
||||||
[InlineData("/hor", ClientCommandId.HouseRecall)]
|
[InlineData("/hor", ClientCommandId.HouseRecall)]
|
||||||
[InlineData("/hr", ClientCommandId.HouseRecall)]
|
[InlineData("/hr", ClientCommandId.HouseRecall)]
|
||||||
[InlineData("/hom", ClientCommandId.MansionRecall)]
|
[InlineData("/hom", ClientCommandId.MansionRecall)]
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue