Class ChannelCreatedEvent

Namespace: Void.Proxy.Api.Events.Channels
Assembly: Void.Proxy.Api.dll

Represents an event published after a network channel has been created for a player connection.

public record ChannelCreatedEvent : IScopedEvent, IEvent, IEquatable<ChannelCreatedEvent>

Inheritance

object ← ChannelCreatedEvent

Implements

IScopedEvent, IEvent, IEquatable<ChannelCreatedEvent>

Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()

Remarks

The event is raised after the channel instance is built and before the creating API returns it to the caller. A value identifies the player-facing channel stored on the player’s context, while identifies a backend server channel created for the same player.

Constructors

ChannelCreatedEvent(IPlayer, Side, INetworkChannel)

Represents an event published after a network channel has been created for a player connection.

public ChannelCreatedEvent(IPlayer Player, Side Side, INetworkChannel Channel)

Parameters

Player IPlayer

The player whose connection owns or initiated the created channel.

Side Side

The connection side represented by Channel.

Channel INetworkChannel

The created channel instance that handlers can inspect or configure.

Remarks

The event is raised after the channel instance is built and before the creating API returns it to the caller. A value identifies the player-facing channel stored on the player’s context, while identifies a backend server channel created for the same player.

Properties

Channel

The created channel instance that handlers can inspect or configure.

public INetworkChannel Channel { get; init; }

Property Value

INetworkChannel

Player

The player whose connection owns or initiated the created channel.

public IPlayer Player { get; init; }

Property Value

IPlayer

Side

The connection side represented by Channel.

public Side Side { get; init; }

Property Value

Side