CatStation/Content.Shared/Construction/Events.cs

using Content.Shared.DoAfter;
using Content.Shared.Interaction;
using Robust.Shared.Map;
using Robust.Shared.Serialization;

namespace Content.Shared.Construction;

/// <summary>
///     Sent client -> server to to tell the server that we started building
///     a structure-construction.
/// </summary>
[Serializable, NetSerializable]
public sealed class TryStartStructureConstructionMessage : EntityEventArgs
{
    /// <summary>
    ///     Position to start building.
    /// </summary>
    public readonly NetCoordinates Location;

    /// <summary>
    ///     The construction prototype to start building.
    /// </summary>
    public readonly string PrototypeName;

    public readonly Angle Angle;

    /// <summary>
    ///     Identifier to be sent back in the acknowledgement so that the client can clean up its ghost.
    /// </summary>
    /// <remarks>
    /// So essentially the client is sending its own entity to the server so it knows to delete it when it gets server
    /// response back.
    /// </remarks>
    public readonly int Ack;

    public TryStartStructureConstructionMessage(NetCoordinates loc, string prototypeName, Angle angle, int ack)
    {
        Location = loc;
        PrototypeName = prototypeName;
        Angle = angle;
        Ack = ack;
    }
}

/// <summary>
///     Sent client -> server to to tell the server that we started building
///     an item-construction.
/// </summary>
[Serializable, NetSerializable]
public sealed class TryStartItemConstructionMessage : EntityEventArgs
{
    /// <summary>
    ///     The construction prototype to start building.
    /// </summary>
    public readonly string PrototypeName;

    public TryStartItemConstructionMessage(string prototypeName)
    {
        PrototypeName = prototypeName;
    }
}

/// <summary>
/// Sent server -> client to tell the client that a ghost has started to be constructed.
/// </summary>
[Serializable, NetSerializable]
public sealed class AckStructureConstructionMessage : EntityEventArgs
{
    public readonly int GhostId;

    /// <summary>
    ///     The entity that is now being constructed, if any.
    /// </summary>
    public readonly NetEntity? Uid;

    public AckStructureConstructionMessage(int ghostId, NetEntity? uid = null)
    {
        GhostId = ghostId;
        Uid = uid;
    }
}

/// <summary>
/// Sent client -> server to request a specific construction guide.
/// </summary>
[Serializable, NetSerializable]
public sealed class RequestConstructionGuide : EntityEventArgs
{
    public readonly string ConstructionId;

    public RequestConstructionGuide(string constructionId)
    {
        ConstructionId = constructionId;
    }
}

/// <summary>
/// Sent server -> client as a response to a <see cref="RequestConstructionGuide"/> net message.
/// </summary>
[Serializable, NetSerializable]
public sealed class ResponseConstructionGuide : EntityEventArgs
{
    public readonly string ConstructionId;
    public readonly ConstructionGuide Guide;

    public ResponseConstructionGuide(string constructionId, ConstructionGuide guide)
    {
        ConstructionId = constructionId;
        Guide = guide;
    }
}

[Serializable, NetSerializable]
public sealed partial class ConstructionInteractDoAfterEvent : DoAfterEvent
{
    [DataField("clickLocation")]
    public NetCoordinates ClickLocation;

    private ConstructionInteractDoAfterEvent()
    {
    }

    public ConstructionInteractDoAfterEvent(IEntityManager entManager, InteractUsingEvent ev)
    {
        ClickLocation = entManager.GetNetCoordinates(ev.ClickLocation);
    }

    public override DoAfterEvent Clone() => this;
}

[Serializable, NetSerializable]
public sealed partial class ToolRefineDoAfterEvent : SimpleDoAfterEvent
{
}