Class KickingEventArgs

Namespace

Exiled.Events.EventArgs.Player

Assembly

Exiled.Events.dll

Contains all information before kicking a player from the server.

public class KickingEventArgs : IPlayerEvent, IDeniableEvent, IExiledEvent

Inheritance

object

KickingEventArgs

Implements

IPlayerEvent

IDeniableEvent

IExiledEvent

Derived

BanningEventArgs

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

ReflectionExtensions.CopyProperties(object, object)

Constructors

KickingEventArgs(Player, Player, ICommandSender, string, string, bool)

Initializes a new instance of the KickingEventArgs class.

public KickingEventArgs(Player target, Player issuer, ICommandSender commandSender, string reason, string fullMessage, bool isAllowed = true)

Parameters

target Player

issuer Player

commandSender ICommandSender

reason string

fullMessage string

isAllowed bool

Properties

CommandSender

Gets the command sender.

public ICommandSender CommandSender { get; }

Property Value

ICommandSender

FullMessage

Gets the full kick message.

public string FullMessage { get; }

Property Value

string

IsAllowed

Gets or sets a value indicating whether action is taken against the target.

public bool IsAllowed { get; set; }

Property Value

bool

Player

Gets or sets the ban issuer.

public Player Player { get; set; }

Property Value

Player

Reason

Gets or sets the kick reason.

public string Reason { get; set; }

Property Value

string

Target

Gets or sets the ban target.

public Player Target { get; set; }

Property Value

Player

Methods

LogBanChange(string, string)

Logs the kick, anti-backdoor protection from malicious plugins.

protected void LogBanChange(string assemblyName, string message)

Parameters

assemblyName string

The name of the calling assembly.

message string

The message to be logged.