Class LinkStartedEvent
Namespace: Void.Proxy.Api.Events.Links
Assembly: Void.Proxy.Api.dll
Signals that a player-to-server link has begun relaying messages.
public record LinkStartedEvent : IScopedEvent, IEvent, IEquatable<LinkStartedEvent>Inheritance
Implements
IScopedEvent, IEvent, IEquatable<LinkStartedEvent>
Inherited Members
object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()
Constructors
LinkStartedEvent(ILink, IPlayer, bool, bool)
Signals that a player-to-server link has begun relaying messages.
public LinkStartedEvent(ILink Link, IPlayer Player, bool IsFirstLink, bool IsAnonymous)Parameters
Link ILink
The link that started.
Player IPlayer
The player associated with the link.
IsFirstLink bool
true when this is the player’s initial server link; false for a redirection.
IsAnonymous bool
true when the connection does not represent an authenticated player session; otherwise, false.
Properties
IsAnonymous
true when the connection does not represent an authenticated player session; otherwise, false.
public bool IsAnonymous { get; init; }Property Value
IsFirstLink
true when this is the player’s initial server link; false for a redirection.
public bool IsFirstLink { get; init; }Property Value
Link
The link that started.
public ILink Link { get; init; }Property Value
Player
The player associated with the link.
public IPlayer Player { get; init; }