Class PreAuthenticatingEventArgs
Contains all information before pre-authenticating a player.
Inheritance
Implements
Inherited Members
Namespace: Exiled.Events.EventArgs.Player
Assembly: Exiled.Events.dll
Syntax
public class PreAuthenticatingEventArgs : IExiledEvent
Constructors
| Improve this Doc View SourcePreAuthenticatingEventArgs(String, String, Int64, CentralAuthPreauthFlags, String, Byte[], ConnectionRequest, Int32)
Initializes a new instance of the PreAuthenticatingEventArgs class.
Declaration
public PreAuthenticatingEventArgs(string userId, string ipAddress, long expiration, CentralAuthPreauthFlags flags, string country, byte[] signature, ConnectionRequest request, int readerStartPosition)
Parameters
Type | Name | Description |
---|---|---|
System.String | userId | |
System.String | ipAddress | |
System.Int64 | expiration | |
CentralAuthPreauthFlags | flags | |
System.String | country | |
System.Byte[] | signature | |
LiteNetLib.ConnectionRequest | request | |
System.Int32 | readerStartPosition |
Properties
| Improve this Doc View SourceCountry
Gets the player's country.
Declaration
public string Country { get; }
Property Value
Type | Description |
---|---|
System.String |
Expiration
Gets the request's expiration.
Declaration
public long Expiration { get; }
Property Value
Type | Description |
---|---|
System.Int64 |
Flags
Gets the flags.
Declaration
public CentralAuthPreauthFlags Flags { get; }
Property Value
Type | Description |
---|---|
CentralAuthPreauthFlags |
IpAddress
Gets the player's IP address.
Declaration
public string IpAddress { get; }
Property Value
Type | Description |
---|---|
System.String |
IsAllowed
Gets a value indicating whether the player can be authenticated or not.
Declaration
public bool IsAllowed { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
ReaderStartPosition
Gets the reader starting position for reading the preauth.
Declaration
public int ReaderStartPosition { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
Request
Gets the connection request.
Declaration
public ConnectionRequest Request { get; }
Property Value
Type | Description |
---|---|
LiteNetLib.ConnectionRequest |
Signature
Gets the request's signature.
Declaration
public byte[] Signature { get; }
Property Value
Type | Description |
---|---|
System.Byte[] |
UserId
Gets the player's user id.
Declaration
public string UserId { get; }
Property Value
Type | Description |
---|---|
System.String |
Methods
| Improve this Doc View SourceDelay(Byte, Boolean)
Delays a pre-authentincating player.
Declaration
public void Delay(byte seconds, bool isForced)
Parameters
Type | Name | Description |
---|---|---|
System.Byte | seconds | The seconds of delay. |
System.Boolean | isForced | Indicates whether the delay is forced or not. |
Redirect(UInt16, Boolean)
Redirects a pre-authentincating player.
Declaration
public void Redirect(ushort port, bool isForced)
Parameters
Type | Name | Description |
---|---|---|
System.UInt16 | port | The redirection port. |
System.Boolean | isForced | Indicates whether the redirection is forced or not. |
Reject(RejectionReason, Boolean)
Rejects a pre-authentincating player.
Declaration
public void Reject(RejectionReason reason, bool isForced)
Parameters
Type | Name | Description |
---|---|---|
RejectionReason | reason | The RejectionReason. |
System.Boolean | isForced | Indicates whether the rejection is forced or not. |
Reject(String, Boolean)
Rejects a pre-authentincating player.
Declaration
public void Reject(string customReason, bool isForced)
Parameters
Type | Name | Description |
---|---|---|
System.String | customReason | The rejection custom reason. |
System.Boolean | isForced | Indicates whether the rejection is forced or not. |
RejectBanned(String, DateTime, Boolean)
Rejects a pre-authentincating banned player.
Declaration
public void RejectBanned(string banReason, DateTime expiration, bool isForced)
Parameters
Type | Name | Description |
---|---|---|
System.String | banReason | The ban reason. |
System.DateTime | expiration | The ban System.DateTime expiration. |
System.Boolean | isForced | Indicates whether the rejection is forced or not. |
RejectBanned(String, Int64, Boolean)
Rejects a pre-authentincating banned player.
Declaration
public void RejectBanned(string banReason, long expiration, bool isForced)
Parameters
Type | Name | Description |
---|---|---|
System.String | banReason | The ban reason. |
System.Int64 | expiration | The ban expiration. |
System.Boolean | isForced | Indicates whether the rejection is forced or not. |