acdream/src/AcDream.Core/Ui/RetailMessages.cs

namespace AcDream.Core.Ui;

/// <summary>
/// Verbatim ports of retail UI message strings. Centralised here so
/// future retail-faithful refinements only need to touch one file —
/// and so the call sites stay readable at the interaction layer.
///
/// <para>
/// String text is byte-identical with retail. Each helper cites the
/// retail DAT data address + the runtime use site in the named decomp
/// at <c>docs/research/named-retail/acclient_2013_pseudo_c.txt</c>.
/// </para>
///
/// <para>
/// Pattern mirrors <see cref="RadarBlipColors"/> — typed port of a
/// retail-UI primitive (<c>gmRadarUI::GetBlipColor</c> at
/// <c>0x004d76f0</c>). Add new strings here as we encounter them.
/// </para>
///
/// <para>
/// Members may be added BEFORE their first call site exists — retail
/// strings are a fixed inventory we know we'll need as we port more
/// features. Each member's doc-comment cites its retail anchor +
/// describes the scenario that'll consume it. Removing dead members
/// without a port is fine; we re-grep the decomp.
/// </para>
/// </summary>
public static class RetailMessages
{
    /// <summary>
    /// Retail: <c>"The %s cannot be used"</c>.
    /// Data: <c>0x007e2a70</c> (line 1033115). Runtime sprintf at
    /// <c>0x00588ea4</c> (line 403095) inside <c>ItemHolder::UseObject</c>'s
    /// IsUseable==0 fallthrough branch. Shown when the player triggers
    /// Use on an entity whose useability is USEABLE_UNDEF/USEABLE_NO.
    /// </summary>
    public static string CannotBeUsed(string entityName)
        => $"The {entityName} cannot be used";

    /// <summary>
    /// Retail: <c>"The %s can't be picked up!"</c>.
    /// Runtime sprintf at <c>0x00587353</c> (line 401589) inside the
    /// pickup-flow handler. Shown when the player triggers a pickup on
    /// an entity that lacks USEABLE_REMOTE / isn't a small-item type.
    /// </summary>
    public static string CantBePickedUp(string entityName)
        => $"The {entityName} can't be picked up!";

    /// <summary>
    /// Retail: <c>"You cannot pick up creatures!"</c>.
    /// Data: <c>0x007e22b4</c> (line 1033034). Runtime use at
    /// <c>0x005871f4</c> (line 401642) inside the same pickup-flow
    /// handler. Shown when the player triggers a pickup on a Creature
    /// ItemType (NPCs, monsters, other players).
    /// </summary>
    public const string CannotPickUpCreatures = "You cannot pick up creatures!";

    /// <summary>
    /// Retail: <c>"The %s is being wielded by someone else!"</c>.
    /// Data: <c>0x007e2228</c> (line 1033029). Runtime sprintf at
    /// <c>0x005872db</c> (line 401606) inside
    /// <c>ItemHolder::AttemptToPlaceInContainer_IsItemLegal @ 0x005870c0</c>,
    /// on the reject arm at <c>0x005872b7</c> that fires when
    /// <c>!ACCWeenieObject::IsOwnedByPlayer(item) &amp;&amp;
    /// item-&gt;pwd._location != 0</c>. Shown when the player tries to pick up
    /// an item another character is wielding.
    /// </summary>
    /// <remarks>
    /// Not to be confused with the punctuation-free
    /// <c>"The %s is being wielded by someone else"</c> at <c>0x007cd350</c>,
    /// which belongs to the wield/wear notice block and is emitted from a
    /// different function at <c>0x00560aef</c>. The pickup gate's own literal
    /// block runs <c>0x007e21f0</c>–<c>0x007e234c</c>, one string per
    /// <c>IsItemLegal</c> arm, in reverse code order.
    /// </remarks>
    public static string BeingWieldedBySomeoneElse(string entityName)
        => $"The {entityName} is being wielded by someone else!";

    /// <summary>
    /// Retail: <c>"Cannot be used with %s"</c>.
    /// Data: <c>0x007cc834</c> (line 1024669). Runtime sprintf at
    /// <c>0x0055ee0e</c> (line 363413). Shown when the player tries
    /// a two-target Use (e.g., key on lock, lockpick on chest) and
    /// the combination is invalid for the source item. The <c>%s</c>
    /// is the TARGET entity name. No call site yet — wired in when
    /// the two-target Use flow ships.
    /// </summary>
    public static string CannotBeUsedWith(string targetName)
        => $"Cannot be used with {targetName}";

    /// <summary>
    /// Retail: <c>"The %s cannot be picked up!"</c>. FORMAL variant.
    /// Data: <c>0x007e227c</c> (line 1033033). Runtime sprintf at
    /// <c>0x00587264</c> (line 401623). Distinct from
    /// <see cref="CantBePickedUp(string)"/> — retail has TWO pickup-
    /// reject strings (formal "cannot" + informal "can't"); they
    /// fire from different code paths inside the pickup handler.
    /// Use whichever the corresponding caller's retail path uses.
    /// No call site yet — wired in when the formal-pickup-reject
    /// path ships (probably a server-side rejection message).
    /// </summary>
    public static string CannotBePickedUp(string entityName)
        => $"The {entityName} cannot be picked up!";

    /// <summary>
    /// Retail: <c>"The %s cannot be used while on a hook, use the
    /// '@house hooks on' command to make the hook openable.\n"</c>.
    /// Data: <c>0x007d1f68</c> (line 1029591). Shown when the player
    /// tries to Use a hooked-up item with the house's "hooks off"
    /// preference set. Trailing newline matches retail. No call
    /// site yet — wired in when the housing system ships.
    /// </summary>
    public static string CannotBeUsedWhileOnHook_HooksOff(string entityName)
        => $"The {entityName} cannot be used while on a hook, use the '@house hooks on' command to make the hook openable.\n";

    /// <summary>
    /// Retail: <c>"The %s cannot be used while on a hook and only
    /// the owner may open the hook.\n"</c>.
    /// Data: <c>0x007d5f30</c> (line 1030063). Shown when a non-owner
    /// tries to Use a hooked-up item in someone else's house.
    /// Trailing newline matches retail. No call site yet — wired in
    /// when the housing system ships.
    /// </summary>
    public static string CannotBeUsedWhileOnHook_NotOwner(string entityName)
        => $"The {entityName} cannot be used while on a hook and only the owner may open the hook.\n";
}