Aetheria/Assets/Scripts/ServerShared/Sensing.cs

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */

using System.Linq;
using CultMath;

// Light signatures split by channel (ruling visibility-per-capability-reveal): an observer learns what a ship
// is by which channel carries the light. Append-only: values are serialized in VisibilityData.
public enum SignatureChannel
{
    Thermal,
    Reflection,
    DrivePlume,
    LaunchFlash,
    Emission
}

public readonly struct Signature
{
    public readonly SignatureChannel Channel;
    public readonly float Strength;
    public readonly EquippedItem Item;
    // The class this act claims: the true item's Data unless its ship's EW claims otherwise (aetheria-ew,
    // classify-from-belief). Stamped by Entity.SetSignature from the ship's claim.
    public readonly EquippableItemData Claimed;

    public Signature(SignatureChannel channel, float strength, EquippedItem item, EquippableItemData claimed)
    {
        Channel = channel;
        Strength = strength;
        Item = item;
        Claimed = claimed;
    }

    public Signature WithStrength(float strength) => new Signature(Channel, strength, Item, Claimed);
}

// What a painted ship learns of a beam on it (ruling sensor-stat-set item 4): a Search paint is a ping sweeping
// it (Strength 0); a Track paint is a lock (Strength is the emitter's own lock progress, 0..1, ruling
// lock-warning-strength). A Scan paint is a held scanner: Strength is its scan progress 0..1 (ruling scan-is-an-act).
// Never summed.
public enum PaintMode
{
    Search,
    Track,
    Scan
}

// An ally's ping crossed `Subject` at `IlluminatedRange` through `IlluminatedObscuration`; `MaxRange` is that
// sensor's PingRange. Posted on the crossing tick and read for one tick by the receiving ship's own sensors.
public readonly struct PingReturn
{
    public readonly Entity Subject;
    public readonly float IlluminatedRange;
    public readonly float IlluminatedObscuration;
    public readonly float MaxRange;

    public PingReturn(Entity subject, float illuminatedRange, float illuminatedObscuration, float maxRange)
    {
        Subject = subject;
        IlluminatedRange = illuminatedRange;
        IlluminatedObscuration = illuminatedObscuration;
        MaxRange = maxRange;
    }
}

// An item's emission this tick, heard by another ship's Sense within `HearRange` x its HearingMultiple x obscuration;
// it decides nothing by itself.
public readonly struct ActiveEmission
{
    public readonly EquippedItem Item;
    public readonly float HearRange;
    // The class this emission claims (see Signature.Claimed); stamped by Entity.Emit.
    public readonly EquippableItemData Claimed;

    public ActiveEmission(EquippedItem item, float hearRange, EquippableItemData claimed)
    {
        Item = item;
        HearRange = hearRange;
        Claimed = claimed;
    }
}

public readonly struct PaintWarning
{
    public readonly float2 Bearing;
    public readonly EquippableItemData EmitterClass;
    public readonly PaintMode Mode;
    public readonly float Strength;

    public PaintWarning(float2 bearing, EquippableItemData emitterClass, PaintMode mode, float strength)
    {
        Bearing = bearing;
        EmitterClass = emitterClass;
        Mode = mode;
        Strength = strength;
    }
}

// What an observer has seen `Item` do (ruling visibility-per-capability-reveal): the channel it showed on, the
// bearing at that act and the zone clock then. Held per (subject, item) in the observer's Entity; the latest act
// replaces the earlier one. Position is never carried: only the track gives it. `Item` stays the true item: it is the
// book's key and what aim reads. `Claimed` is the class the act claimed, and is what every classifying reader reads
// (aetheria-ew, classify-from-belief). A null `Channel` is a reveal by the observer's own scan (Entity.RecordInspection),
// whose `Claimed` is the subject's claim for the item.
public readonly struct Reveal
{
    public readonly EquippedItem Item;
    public readonly EquippableItemData Claimed;
    public readonly SignatureChannel? Channel;
    public readonly float2 Bearing;
    public readonly float Time;

    public Reveal(EquippedItem item, SignatureChannel? channel, float2 bearing, float time, EquippableItemData claimed)
    {
        Item = item;
        Claimed = claimed;
        Channel = channel;
        Bearing = bearing;
        Time = time;
    }
}

// One weapon or gear row of a ship's schematic as its viewer is entitled to read it (aetheria-ew, classify-from-belief; ruling
// ew-claim-weapon-measure-ruled). Made only by Entity.SchematicRows. `Item` is the true item: the selection mark's key and,
// on the viewer's own ship, the live gear. `Claimed` is the class the row shows. The range label is the live range on
// the viewer's own ship and the claimed design's rated range on any other; a row whose claimed class is not a weapon has
// no range. The viewer never sees a target item's quality, wear or power. A renderer shows these and decides nothing.
// A mount row (`Mount` set, `Item` and `Claimed` null) is a hardpoint of the hull the viewer believes the ship to be, with
// nothing of the ship's claimed on it: where something is, not what.
public readonly struct SchematicRow
{
    public readonly EquippedItem Item;
    public readonly EquippableItemData Claimed;
    public readonly HardpointData Mount;
    private readonly bool _own;

    internal SchematicRow(EquippedItem item, EquippableItemData claimed, bool own)
    {
        Item = item;
        Claimed = claimed;
        Mount = null;
        _own = own;
    }

    internal SchematicRow(HardpointData mount) : this()
    {
        Mount = mount;
    }

    // What a renderer compares to know the rows changed. Range is a reading, not part of the key.
    public (EquippedItem, EquippableItemData, HardpointData) Key => (Item, Claimed, Mount);

    // Whether this row is the one `aimed` points at: a claimed-item row by its item, a mount row by the mount the aimed
    // item sits on (an aimed item with a claimed-item row has no mount row).
    public bool Marks(EquippedItem aimed) => Item != null ? Item == aimed : aimed != null && aimed.Hardpoint == Mount;

    public float? Range => _own
        ? Item.Behaviors.OfType<Weapon>().First().Range
        : Claimed?.Behaviors.OfType<WeaponData>().FirstOrDefault()?.RatedRange;
}

// A subject's removal from a zone as the zone recorded it (death, dock, warp, any removal): where it was and how
// bright its light was (its Visibility at removal). Judged by each observer's Sense under the
// light-act gate; notification only, one tick long, it decides nothing.
public readonly struct Departure
{
    public readonly Entity Subject;
    public readonly float2 Position;
    public readonly float Signature;

    public Departure(Entity subject, float2 position, float signature)
    {
        Subject = subject;
        Position = position;
        Signature = signature;
    }
}

// How much an observer holds of one subject, derived on read by Entity.ContactOf from its track, its reveals and
// the zone clock. Detected: tracked, or a reveal younger than GameplaySettings.BearingMemory. Tracked: exactly
// membership of VisibleEntities. Classified: detected, with any reveal in the book. Identified: the track has reached
// TargetGearInfoThreshold, and holds a hull belief: Profile, the hull class this observer believes the subject is (null
// below Identified; aetheria-ew, classify-from-belief; seen-through arrives with the judge). Bearing is the true
// bearing while tracked, else the freshest reveal's.
public readonly struct Contact
{
    public readonly bool Detected;
    public readonly bool Tracked;
    public readonly bool Classified;
    public readonly bool Identified;
    public readonly float2 Bearing;
    public readonly float Info;
    public readonly HullData Profile;

    public Contact(bool detected, bool tracked, bool classified, bool identified, float2 bearing, float info, HullData profile)
    {
        Profile = profile;
        Detected = detected;
        Tracked = tracked;
        Classified = classified;
        Identified = identified;
        Bearing = bearing;
        Info = info;
    }
}