Triggered when a player attempts to connect to the server (before character select).
This event can be cancelled to prevent a player from connecting to the server. More...

Inheritance diagram for Anvil.API.Events.OnClientConnect:

Collaboration diagram for Anvil.API.Events.OnClientConnect:

Classes
class	Factory

Properties
bool	BlockConnection `[get, set]`
	Gets or sets a value indicating whether this client connection should be prevented.

string	CDKey = null! `[get]`
	Gets the public CD Key of the connecting client.

PlayerPlatform	ClientPlatform `[get]`
	Gets the platform of the connecting client.

Version	ClientVersion = null! `[get]`
	Gets the version of the connecting client.

bool	DM `[get]`
	Gets a value indicating whether the client is connecting as a DM (true) or player (false).

string	IP = null! `[get]`
	Gets the IP address of the connecting client.

string?	KickMessage `[get, set]`
	Gets or sets the kick message to send to the client if BlockConnection is set to true.

string	PlayerName = null! `[get]`
	Gets the player name of the connecting client.

Properties inherited from Anvil.API.Events.IEvent

Detailed Description

Triggered when a player attempts to connect to the server (before character select).
This event can be cancelled to prevent a player from connecting to the server.

The documentation for this class was generated from the following file:

NWN.Anvil/src/main/API/Events/Native/ClientEvents/OnClientConnect.cs

Classes

Properties

Detailed Description