Class PlayerKickEvent
Namespace: Void.Proxy.Api.Events.Player
Assembly: Void.Proxy.Api.dll
Requests that a player be disconnected from the proxy.
public record PlayerKickEvent : IScopedEventWithResult<bool>, IScopedEvent, IEventWithResult<bool>, IEvent, IEquatable<PlayerKickEvent>Inheritance
Derived
Implements
IScopedEventWithResult<bool>, IScopedEvent, IEventWithResult<bool>, IEvent, IEquatable<PlayerKickEvent>
Inherited Members
object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()
Constructors
PlayerKickEvent(IPlayer, string?)
Requests that a player be disconnected from the proxy.
public PlayerKickEvent(IPlayer Player, string? Text = null)Parameters
Player IPlayer
The player to disconnect.
Text string?
The optional disconnect message; null uses the implementation’s default message.
Properties
Player
The player to disconnect.
public IPlayer Player { get; init; }Property Value
Result
true if kick was made; otherwise, false.
public bool Result { get; set; }Property Value
Text
The optional disconnect message; null uses the implementation’s default message.
public string? Text { get; init; }