mirror of
https://github.com/space-wizards/RobustToolbox.git
synced 2026-02-15 03:30:53 +01:00
2183cd7ca1
* Removed the Interfaces folder. * All objects inside the GameObjects subfolders are now in the GameObjects namespace. * Added a Resharper DotSettings file to mark the GameObjects subfolders as not providing namespaces. * Simplified Robust.client.Graphics namespace. * Automated remove redundant using statements.
71 lines
2.9 KiB
C#
71 lines
2.9 KiB
C#
using System;
|
|
using Robust.Shared.Network;
|
|
|
|
namespace Robust.Shared.GameObjects
|
|
{
|
|
/// <summary>
|
|
/// Manages the sending and receiving of network messages between the server and client(s).
|
|
/// </summary>
|
|
public interface IEntityNetworkManager
|
|
{
|
|
/// <summary>
|
|
/// This event is raised when a component message comes in from the network.
|
|
/// </summary>
|
|
event EventHandler<NetworkComponentMessage> ReceivedComponentMessage;
|
|
|
|
/// <summary>
|
|
/// This event is raised when a component message comes in from the network.
|
|
/// </summary>
|
|
event EventHandler<object> ReceivedSystemMessage;
|
|
|
|
/// <summary>
|
|
/// Initializes networking for this manager. This should only be called once.
|
|
/// </summary>
|
|
void SetupNetworking();
|
|
|
|
/// <summary>
|
|
/// Allows a component owned by this entity to send a message to a counterpart component on the
|
|
/// counterpart entities on clients.
|
|
/// </summary>
|
|
/// <param name="channel">
|
|
/// Intended recipient of the message. On Server, if this is null, broadcast the message to all clients.
|
|
/// On clients, this should always be null.
|
|
/// </param>
|
|
/// <param name="entity">Entity sending the message (also entity to send to).</param>
|
|
/// <param name="component">Component that sent the message.</param>
|
|
/// <param name="message">Message to send.</param>
|
|
void SendComponentNetworkMessage(INetChannel? channel, IEntity entity, IComponent component,
|
|
ComponentMessage message);
|
|
|
|
/// <summary>
|
|
/// Sends an Entity System Message to relevant System(s).
|
|
/// Client: Sends the message to the relevant server side System(s).
|
|
/// Server: Sends the message to the relevant systems of all connected clients.
|
|
/// Server: Use the alternative overload to send to a single client.
|
|
/// </summary>
|
|
/// <param name="message">Message that should be sent.</param>
|
|
void SendSystemNetworkMessage(EntitySystemMessage message);
|
|
|
|
void SendSystemNetworkMessage(EntitySystemMessage message, uint sequence)
|
|
{
|
|
throw new NotSupportedException();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Sends an Entity System Message to relevant System on a client.
|
|
/// Server: Sends the message to the relevant systems of the client on <paramref name="channel"/>
|
|
/// </summary>
|
|
/// <param name="message">Message that should be sent.</param>
|
|
/// <param name="channel">The client to send the message to.</param>
|
|
/// <exception cref="NotSupportedException">
|
|
/// Thrown if called on the client.
|
|
/// </exception>
|
|
void SendSystemNetworkMessage(EntitySystemMessage message, INetChannel channel);
|
|
|
|
/// <summary>
|
|
/// Sends out queued messages based on current tick.
|
|
/// </summary>
|
|
void Update();
|
|
}
|
|
}
|