using System;

namespace AcDream.Core.Items;

/// <summary>
/// Verbatim retail <c>AMMO_TYPE</c> (<c>docs/research/named-retail/acclient.h:4221</c>).
/// Arrives on the wire as <c>PublicWeenieDesc._ammo_type</c> (CreateObject weenie flag
/// 0x00000100) and in the appraisal weapon profile.
///
/// <para>The three base kinds each have a crystal and a chorizite variant on their own
/// bit, so a launcher's "uses arrows" test must fold the variants back to the base — see
/// <c>ItemAppraisalTextFormatter</c>, which does exactly that.</para>
/// </summary>
[Flags]
public enum AmmoType : uint
{
    None            = 0x000,
    Arrow           = 0x001,
    Bolt            = 0x002,
    Atlatl          = 0x004,
    ArrowCrystal    = 0x008,
    BoltCrystal     = 0x010,
    AtlatlCrystal   = 0x020,
    ArrowChorizite  = 0x040,
    BoltChorizite   = 0x080,
    AtlatlChorizite = 0x100,
}

/// <summary>
/// Verbatim retail <c>COMBAT_USE</c> (<c>docs/research/named-retail/acclient.h:6523</c>) —
/// how a wieldable participates in combat. This is a plain sequence, not a bitfield.
/// Arrives as <c>PropertyInt.CombatUse</c> (51).
/// </summary>
public enum CombatUse : uint
{
    None      = 0,
    Melee     = 1,
    Missile   = 2,
    Ammo      = 3,
    Shield    = 4,
    TwoHanded = 5,
}

/// <summary>
/// Verbatim retail <c>ITEM_USEABLE</c> (<c>docs/research/named-retail/acclient.h:6478</c>) —
/// where an object must be, and where its target must be, for a use attempt to be legal.
/// Arrives as <c>PropertyInt.ItemUseable</c> (16).
///
/// <para>The layout is two 16-bit halves: the low half (<see cref="SourceMask"/>) constrains
/// the object being used, the high half (<see cref="TargetMask"/>) constrains its target.
/// Retail names the useful combinations explicitly rather than expecting callers to compose
/// them, and they are transcribed here the same way — several are not the obvious union
/// (<see cref="SourceContainedTargetObjSelfOrContained"/> is 0x880008, not
/// <c>ObjSelf | Contained | (Contained &lt;&lt; 16)</c>).</para>
/// </summary>
[Flags]
public enum ItemUseable : uint
{
    Undef                    = 0x0,
    No                       = 0x1,
    Self                     = 0x2,
    Wielded                  = 0x4,
    Contained                = 0x8,
    Viewed                   = 0x10,
    Remote                   = 0x20,
    NeverWalk                = 0x40,
    ObjSelf                  = 0x80,

    ContainedViewed                    = 0x18,
    ViewedRemote                       = 0x30,
    ContainedViewedRemote              = 0x38,
    RemoteNeverWalk                    = 0x60,
    ViewedRemoteNeverWalk              = 0x70,
    ContainedViewedRemoteNeverWalk     = 0x78,

    SourceWieldedTargetWielded                 = 0x00040004,
    SourceWieldedTargetContained               = 0x00080004,
    SourceWieldedTargetViewed                  = 0x00100004,
    SourceWieldedTargetRemote                  = 0x00200004,
    SourceWieldedTargetRemoteNeverWalk         = 0x00600004,

    SourceContainedTargetWielded               = 0x00040008,
    SourceContainedTargetContained             = 0x00080008,
    SourceContainedTargetSelfOrContained       = 0x000A0008,
    SourceContainedTargetViewed                = 0x00100008,
    SourceContainedTargetRemote                = 0x00200008,
    SourceContainedTargetRemoteOrSelf          = 0x00220008,
    SourceContainedTargetRemoteNeverWalk       = 0x00600008,
    SourceContainedTargetObjSelfOrContained    = 0x00880008,

    SourceViewedTargetWielded                  = 0x00040010,
    SourceViewedTargetContained                = 0x00080010,
    SourceViewedTargetViewed                   = 0x00100010,
    SourceViewedTargetRemote                   = 0x00200010,

    SourceRemoteTargetWielded                  = 0x00040020,
    SourceRemoteTargetContained                = 0x00080020,
    SourceRemoteTargetViewed                   = 0x00100020,
    SourceRemoteTargetRemote                   = 0x00200020,
    SourceRemoteTargetRemoteNeverWalk          = 0x00600020,

    SourceMask = 0x0000FFFF,
    TargetMask = 0xFFFF0000,
}