using Content.Shared.DeviceNetwork.Components;
using Content.Shared.Examine;
using JetBrains.Annotations;

namespace Content.Shared.DeviceNetwork.Systems;

/// <summary>
///     Entity system that handles everything device network related.
///     Device networking allows machines and devices to communicate with each other
///     while adhering to restrictions like range or being connected to the same power network.
/// </summary>
public abstract partial class SharedDeviceNetworkSystem : EntitySystem
{
    [SubscribeLocalEvent]
    private void OnExamine(Entity<DeviceNetworkComponent> ent, ref ExaminedEvent args)
    {
        if (ent.Comp.ExaminableAddress)
            args.PushText(Loc.GetString("device-address-examine-message", ("address", ent.Comp.Address)));
    }

    /// <summary>
    /// Sends the given <see cref="INetworkPayload"/> as a device network packet to the entity with the given address and frequency.
    /// Addresses are given to the <see cref="DeviceNetworkComponent"/> of an entity when connecting.
    /// </summary>
    /// <param name="ent">The sending entity.</param>
    /// <param name="address">
    /// The address of the entity that the packet gets sent to.
    /// If null, the message is broadcast to all devices on that frequency (except the sender)
    /// </param>
    /// <param name="frequency">The frequency to send on.</param>
    /// <param name="data">The data to be sent.</param>
    /// <param name="network">The network to send on.</param>
    /// <returns>Returns true when the packet was successfully enqueued.</returns>
    [PublicAPI]
    public virtual bool SendPacket<T>(
        Entity<DeviceNetworkComponent?> ent,
        string? address,
        ref T data,
        uint? frequency = null,
        int? network = null)
        where T : INetworkPayload
    {
        return false;
    }
}