using System;
using Robust.Shared.GameObjects;
using Robust.Shared.Map;
using Robust.Shared.Serialization;
using Robust.Shared.Timing;
namespace Robust.Shared.Input
{
///
/// Abstract class that all Input Commands derive from.
///
[Serializable, NetSerializable]
public abstract class InputCmdMessage : EntitySystemMessage, IComparable
{
///
/// Client tick this was created.
///
public GameTick Tick { get; }
///
/// The function this command is changing.
///
public KeyFunctionId InputFunctionId { get; }
///
/// Sequence number of this input command.
///
public uint InputSequence { get; set; }
///
/// Creates an instance of .
///
/// Client tick this was created.
/// Function this command is changing.
public InputCmdMessage(GameTick tick, KeyFunctionId inputFunctionId)
{
Tick = tick;
InputFunctionId = inputFunctionId;
}
public int CompareTo(InputCmdMessage other)
{
if (ReferenceEquals(this, other)) return 0;
if (ReferenceEquals(null, other)) return 1;
return InputSequence.CompareTo(other.InputSequence);
}
}
///
/// An Input Command for a function that has a state.
///
[Serializable, NetSerializable]
public class StateInputCmdMessage : InputCmdMessage
{
///
/// New state of the Input Function.
///
public BoundKeyState State { get; }
///
/// Creates an instance of .
///
/// Client tick this was created.
/// Function this command is changing.
/// New state of the Input Function.
public StateInputCmdMessage(GameTick tick, KeyFunctionId inputFunctionId, BoundKeyState state)
: base(tick, inputFunctionId)
{
State = state;
}
}
///
/// A OneShot Input Command that does not have a state.
///
[Serializable, NetSerializable]
public class EventInputCmdMessage : InputCmdMessage
{
///
/// Creates an instance of .
///
/// Client tick this was created.
/// Function this command is changing.
public EventInputCmdMessage(GameTick tick, KeyFunctionId inputFunctionId)
: base(tick, inputFunctionId) { }
}
///
/// A OneShot Input Command that also contains pointer info.
///
[Serializable, NetSerializable]
public class PointerInputCmdMessage : EventInputCmdMessage
{
///
/// Local Coordinates of the pointer when the command was created.
///
public GridCoordinates Coordinates { get; }
///
/// Entity that was under the pointer when the command was created (if any).
///
public EntityUid Uid { get; }
///
/// Creates an instance of .
///
/// Client tick this was created.
/// Function this command is changing.
/// Local Coordinates of the pointer when the command was created.
public PointerInputCmdMessage(GameTick tick, KeyFunctionId inputFunctionId, GridCoordinates coordinates)
: this(tick, inputFunctionId, coordinates, EntityUid.Invalid) { }
///
/// Creates an instance of with an optional Entity reference.
///
/// Client tick this was created.
/// Function this command is changing.
/// Local Coordinates of the pointer when the command was created.
/// Entity that was under the pointer when the command was created.
public PointerInputCmdMessage(GameTick tick, KeyFunctionId inputFunctionId, GridCoordinates coordinates, EntityUid uid)
: base(tick, inputFunctionId)
{
Coordinates = coordinates;
Uid = uid;
}
}
///
/// An input command that has both state and pointer info.
///
[Serializable, NetSerializable]
public class FullInputCmdMessage : InputCmdMessage
{
///
/// New state of the Input Function.
///
public BoundKeyState State { get; }
///
/// Local Coordinates of the pointer when the command was created.
///
public GridCoordinates Coordinates { get; }
///
/// Screen Coordinates of the pointer when the command was created.
///
public ScreenCoordinates ScreenCoordinates { get; }
///
/// Entity that was under the pointer when the command was created (if any).
///
public EntityUid Uid { get; }
///
/// Creates an instance of .
///
/// Client tick this was created.
///
/// Function this command is changing.
/// New state of the Input Function.
/// Local Coordinates of the pointer when the command was created.
///
public FullInputCmdMessage(GameTick tick, int inputSequence, KeyFunctionId inputFunctionId, BoundKeyState state, GridCoordinates coordinates, ScreenCoordinates screenCoordinates)
: this(tick, inputFunctionId, state, coordinates, screenCoordinates, EntityUid.Invalid) { }
///
/// Creates an instance of with an optional Entity reference.
///
/// Client tick this was created.
/// Function this command is changing.
/// New state of the Input Function.
/// Local Coordinates of the pointer when the command was created.
///
/// Entity that was under the pointer when the command was created.
public FullInputCmdMessage(GameTick tick, KeyFunctionId inputFunctionId, BoundKeyState state, GridCoordinates coordinates, ScreenCoordinates screenCoordinates, EntityUid uid)
: base(tick, inputFunctionId)
{
State = state;
Coordinates = coordinates;
ScreenCoordinates = screenCoordinates;
Uid = uid;
}
}
}