Search Results for

    Show / Hide Table of Contents

    Class KickingEventArgs

    Contains all information before kicking a player from the server.

    Inheritance
    System.Object
    KickingEventArgs
    BanningEventArgs
    Implements
    IPlayerEvent
    IDeniableEvent
    IExiledEvent
    Inherited Members
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Exiled.Events.EventArgs.Player
    Assembly: Exiled.Events.dll
    Syntax
    public class KickingEventArgs : IPlayerEvent, IDeniableEvent, IExiledEvent

    Constructors

    | Improve this Doc View Source

    KickingEventArgs(Player, Player, String, String, Boolean)

    Initializes a new instance of the KickingEventArgs class.

    Declaration
    public KickingEventArgs(Player target, Player issuer, string reason, string fullMessage, bool isAllowed = true)
    Parameters
    Type Name Description
    Player target
    Player issuer
    System.String reason
    System.String fullMessage
    System.Boolean isAllowed

    Properties

    | Improve this Doc View Source

    FullMessage

    Gets or sets the full kick message.

    Declaration
    public string FullMessage { get;
    
        [Obsolete("this will be remove use Reason instead of FullMessage")]
    
        set;
    
    }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    IsAllowed

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

    Declaration
    public bool IsAllowed { get; set; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    Player

    Gets or sets the ban issuer.

    Declaration
    public Player Player { get; set; }
    Property Value
    Type Description
    Player
    | Improve this Doc View Source

    Reason

    Gets or sets the kick reason.

    Declaration
    public string Reason { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    Target

    Gets or sets the ban target.

    Declaration
    public Player Target { get; set; }
    Property Value
    Type Description
    Player

    Methods

    | Improve this Doc View Source

    LogBanChange(String, String)

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

    Declaration
    protected void LogBanChange(string assemblyName, string message)
    Parameters
    Type Name Description
    System.String assemblyName

    The name of the calling assembly.

    System.String message

    The message to be logged.

    Implements

    IPlayerEvent
    IDeniableEvent
    IExiledEvent

    Extension Methods

    ReflectionExtensions.CopyProperties(Object, Object)
    • Improve this Doc
    • View Source
    In This Article
    Back to top Generated by DocFX