Interface IMinecraftPacketTransformationsPluginsRegistry

Namespace: Void.Minecraft.Network.Registries.Transformations
Assembly: Void.Minecraft.dll

Partitions packet transformation registries by contributing plugin.

public interface IMinecraftPacketTransformationsPluginsRegistry

Properties

All

Gets the current plugin-owned transformation registries.

IReadOnlyCollection<IMinecraftPacketTransformationsRegistry> All { get; }

Property Value

IReadOnlyCollection<IMinecraftPacketTransformationsRegistry>

IsEmpty

Gets whether every plugin registry contains no transformation pipelines.

bool IsEmpty { get; }

Property Value

bool

ManagedBy

Gets or sets the plugin responsible for this aggregate registry’s lifecycle.

IPlugin? ManagedBy { get; set; }

Property Value

IPlugin?

ProtocolVersion

Gets or sets the protocol version for which transformations are configured.

ProtocolVersion? ProtocolVersion { get; set; }

Property Value

ProtocolVersion?

Methods

Clear()

Removes all per-plugin transformation registries while preserving metadata.

void Clear()

Clear(Direction, Operation)

Clears transformations for a packet direction in every plugin registry.

void Clear(Direction direction, Operation operation)

Parameters

direction Direction

The packet direction to clear.

operation Operation

Reserved operation selection; currently ignored by the built-in implementation.

Remarks

The built-in implementation currently ignores operation because transformations are not partitioned by operation.

Contains<T>(TransformationType)

Determines whether any plugin registry contains a transformation for a packet type.

bool Contains<T>(TransformationType type) where T : IMinecraftPacket

Parameters

type TransformationType

The transformation direction to query.

Returns

bool

true when a matching transformation exists; otherwise, false.

Type Parameters

T

The packet type to query.

Contains(IMinecraftMessage, TransformationType)

Determines whether any plugin registry contains a transformation for a message.

bool Contains(IMinecraftMessage message, TransformationType type)

Parameters

message IMinecraftMessage

The message to query.

type TransformationType

The transformation direction to query.

Returns

bool

true when a matching transformation exists; otherwise, false.

Contains(Type, TransformationType)

Determines whether any plugin registry contains a transformation for a runtime type.

bool Contains(Type packetType, TransformationType transformationType)

Parameters

packetType Type

The packet type to query.

transformationType TransformationType

The transformation direction to query.

Returns

bool

true when a matching transformation exists; otherwise, false.

Get(IPlugin)

Gets or creates the transformation registry owned by a plugin.

IMinecraftPacketTransformationsRegistry Get(IPlugin plugin)

Parameters

plugin IPlugin

The plugin that owns the returned registry.

Returns

IMinecraftPacketTransformationsRegistry

The existing or newly created registry.

Exceptions

InvalidOperationException

has not been set.

Remove(IPlugin)

Removes the registry owned by a plugin.

void Remove(IPlugin plugin)

Parameters

plugin IPlugin

The plugin to remove.

Reset()

Clears all plugin registries and sets protocol and manager metadata to null.

void Reset()