130 lines
3.5 KiB
C#
130 lines
3.5 KiB
C#
using System;
|
|
using Content.Shared.Eui;
|
|
using Robust.Server.Player;
|
|
using Robust.Shared.IoC;
|
|
using Robust.Shared.Network;
|
|
|
|
|
|
namespace Content.Server.EUI
|
|
{
|
|
/// <summary>
|
|
/// Base class to implement server-side for an EUI.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// An EUI is a system for making a relatively-easy connection between client and server
|
|
/// for the purposes of UIs.
|
|
/// </remarks>
|
|
/// <remarks>
|
|
/// An equivalently named class much exist server side for an EUI to work.
|
|
/// It will be instantiated, opened and closed automatically.
|
|
/// </remarks>
|
|
public abstract class BaseEui
|
|
{
|
|
private bool _isStateDirty = false;
|
|
|
|
/// <summary>
|
|
/// The player that this EUI is open for.
|
|
/// </summary>
|
|
public IPlayerSession Player { get; private set; } = default!;
|
|
public bool IsShutDown { get; private set; }
|
|
public EuiManager Manager { get; private set; } = default!;
|
|
public uint Id { get; private set; }
|
|
|
|
/// <summary>
|
|
/// Called when the UI has been opened. Do initializing logic here.
|
|
/// </summary>
|
|
public virtual void Opened()
|
|
{
|
|
|
|
}
|
|
|
|
/// <summary>
|
|
/// Called when the UI has been closed.
|
|
/// </summary>
|
|
public virtual void Closed()
|
|
{
|
|
|
|
}
|
|
|
|
/// <summary>
|
|
/// Called when a message comes in from the client.
|
|
/// </summary>
|
|
public virtual void HandleMessage(EuiMessageBase msg)
|
|
{
|
|
}
|
|
|
|
/// <summary>
|
|
/// Mark the current UI state as dirty and queue for an update.
|
|
/// </summary>
|
|
/// <seealso cref="GetNewState"/>
|
|
public void StateDirty()
|
|
{
|
|
if (_isStateDirty)
|
|
{
|
|
return;
|
|
}
|
|
|
|
_isStateDirty = true;
|
|
Manager.QueueStateUpdate(this);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Called some time after <see cref="StateDirty"/> has been called
|
|
/// to get a new UI state that can be sent to the client.
|
|
/// </summary>
|
|
public virtual EuiStateBase GetNewState()
|
|
{
|
|
throw new NotSupportedException();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Send a message to the client-side EUI.
|
|
/// </summary>
|
|
public void SendMessage(EuiMessageBase message)
|
|
{
|
|
var netMgr = IoCManager.Resolve<IServerNetManager>();
|
|
var msg = netMgr.CreateNetMessage<MsgEuiMessage>();
|
|
msg.Id = Id;
|
|
msg.Message = message;
|
|
|
|
netMgr.ServerSendMessage(msg, Player.ConnectedClient);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Close the EUI, breaking the connection between client and server.
|
|
/// </summary>
|
|
public void Close()
|
|
{
|
|
Manager.CloseEui(this);
|
|
}
|
|
|
|
internal void Shutdown()
|
|
{
|
|
Closed();
|
|
IsShutDown = true;
|
|
}
|
|
|
|
internal void DoStateUpdate()
|
|
{
|
|
_isStateDirty = false;
|
|
|
|
var state = GetNewState();
|
|
|
|
var netMgr = IoCManager.Resolve<IServerNetManager>();
|
|
var msg = netMgr.CreateNetMessage<MsgEuiState>();
|
|
msg.Id = Id;
|
|
msg.State = state;
|
|
|
|
netMgr.ServerSendMessage(msg, Player.ConnectedClient);
|
|
}
|
|
|
|
internal void Initialize(EuiManager manager, IPlayerSession player, uint id)
|
|
{
|
|
Manager = manager;
|
|
Player = player;
|
|
Id = id;
|
|
Opened();
|
|
}
|
|
}
|
|
}
|