swiftlys2/docs/api/ai/
API Reference › NetMessages

INetMessageService

Interface
Namespace: SwiftlyS2.Shared.NetMessages · Assembly: SwiftlyS2.CS2.dll
public interface INetMessageService
View source

Methods

Create<T>()

Creates a new net message of specified type.

T Create<T>() where T : ITypedProtobuf<T>, INetMessage<T>, IDisposable
Returns
T
The new net message.

HookClientMessage<T>(ClientNetMessageHandler<T>)

Hooks a client net message.

Guid HookClientMessage<T>(INetMessageService.ClientNetMessageHandler<T> callback) where T : ITypedProtobuf<T>, INetMessage<T>, IDisposable
Parameters
  • callbackINetMessageService.ClientNetMessageHandler<T>The callback to handle the net message.
Returns
Guid
The unique Guid for the handler. Can be used to unhook it later.

HookServerMessage<T>(ServerNetMessageHandler<T>)

Hooks a server net message.

Guid HookServerMessage<T>(INetMessageService.ServerNetMessageHandler<T> callback) where T : ITypedProtobuf<T>, INetMessage<T>, IDisposable
Parameters
  • callbackINetMessageService.ServerNetMessageHandler<T>The callback to handle the net message.
Returns
Guid
The unique Guid for the handler. Can be used to unhook it later.

HookServerMessageInternal<T>(ServerNetMessageInternalHandler<T>)

Hooks a client net message internally.

Guid HookServerMessageInternal<T>(INetMessageService.ServerNetMessageInternalHandler<T> callback) where T : ITypedProtobuf<T>, INetMessage<T>, IDisposable
Parameters
Returns
Guid

Send<T>(Action<T>)

Sends a net message to players with configured recipient filter.

void Send<T>(Action<T> configureMessage) where T : ITypedProtobuf<T>, INetMessage<T>, IDisposable
Parameters
  • configureMessageAction<T>The action to configure the net message and recipient filter.

Unhook(Guid)

Unhooks a net message handler.

void Unhook(Guid guid)
Parameters
  • guidGuidThe unique Guid for the handler.

UnhookClientMessage<T>()

Unhooks all client net message handlers with specified type.

void UnhookClientMessage<T>() where T : ITypedProtobuf<T>, INetMessage<T>, IDisposable

UnhookServerMessage<T>()

Unhooks all server net message handlers with specified type.

void UnhookServerMessage<T>() where T : ITypedProtobuf<T>, INetMessage<T>, IDisposable

UnhookServerMessageInternal<T>()

Unhooks all internal server net message handlers with specified type.

void UnhookServerMessageInternal<T>() where T : ITypedProtobuf<T>, INetMessage<T>, IDisposable
INetMessageService.ServerNetMessageInternalHandler`1IProtobufAccessor