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. More...

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

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

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

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

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

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

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

Properties inherited from Anvil.API.Events.IEvent
NwObject?	Context `[get]`

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.

Property Documentation

◆ BlockConnection

bool Anvil.API.Events.OnClientConnect.BlockConnection

getset

Gets or sets a value indicating whether this client connection should be prevented.

◆ CDKey

string Anvil.API.Events.OnClientConnect.CDKey = null!

get

Gets the public CD Key of the connecting client.

◆ ClientPlatform

PlayerPlatform Anvil.API.Events.OnClientConnect.ClientPlatform

get

Gets the platform of the connecting client.

◆ ClientVersion

Version Anvil.API.Events.OnClientConnect.ClientVersion = null!

get

Gets the version of the connecting client.

◆ DM

bool Anvil.API.Events.OnClientConnect.DM

get

Gets a value indicating whether the client is connecting as a DM (true) or player (false).

◆ IP

string Anvil.API.Events.OnClientConnect.IP = null!

get

Gets the IP address of the connecting client.

◆ KickMessage

string? Anvil.API.Events.OnClientConnect.KickMessage

getset

Gets or sets the kick message to send to the client if BlockConnection is set to true.

◆ PlayerName

string Anvil.API.Events.OnClientConnect.PlayerName = null!

get

Gets the player name of the connecting client.

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

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

Classes

Properties