Anvil.API.NwServer Class Reference

Inheritance diagram for Anvil.API.NwServer:

Collaboration diagram for Anvil.API.NwServer:

Public Member Functions
void	AddBannedCDKey (string cdKey)
	Bans the provided public CD key.
void	AddBannedIP (string ip)
	Bans the provided IP.
void	AddBannedPlayerName (string playerName)
	Bans the provided player/community name.
bool	DeletePlayerTURD (string playerId, string characterName)
	Delete the TURD of playerName + characterName.
string	GetAliasPath (string alias)
	Gets the absolute path defined for the given directory alias (see nwn.ini).
void	RemoveBannedCDKey (string cdKey)
	Removes the ban on the provided public CD key.
void	RemoveBannedIP (string ip)
	Removes the ban on the provided IP.
void	RemoveBannedPlayer (string playerName)
	Removes the ban on the provided player/community name.
void	ShutdownServer ()
	Signals the server to immediately shutdown.

Properties
string	BannedList [get]
	Gets a list of all banned IPs/Keys/names as a string.
bool	DebugCombat [get, set]
	Gets or sets if combat debugging is enabled. This prints additional information to the combat log for hit and damage calculation.
bool	DebugHitDie [get, set]
	Gets or sets if hit die debugging is enabled.
bool	DebugMode [get, set]
	Gets or sets if debug mode is enabled, allowing all players to use DM commands and enabling various other debug behaviours.
bool	DebugMoveSpeed [get, set]
	Gets or sets if move speed debugging is enabled. This causes all alive creatures to periodically say a message of their current movement speed.
bool	DebugSaveThrows [get, set]
	Gets or sets if saving throw debugging is enabled.
string	DMPassword [get, set]
	Gets or sets the current DM password.
static NwServer	Instance = null! [get]
bool	IsActivePaused [get, set]
	Gets or sets if the server is "active" paused - same as if a player requested pause.
bool	IsTimestopPaused [get]
	Gets if the server is paused as a result of Effect.TimeStop.
string	PlayerPassword [get, set]
	Gets or sets the current player password.
ServerInfo	ServerInfo = null! [get]
	Gets server configuration and display info.
Version	ServerVersion = null! [get, set]
	Gets the version of this server.
string	UserDirectory = null! [get, set]
	Gets the absolute path of the server's home directory (-userDirectory).
WorldTimer	WorldTimer = null! [get]
	Gets the server world timer.

Member Function Documentation

AddBannedCDKey()

void Anvil.API.NwServer.AddBannedCDKey ( string cdKey )

inline

Bans the provided public CD key.

Parameters

cdKey

The public CD key to ban.

AddBannedIP()

void Anvil.API.NwServer.AddBannedIP ( string ip )

inline

Bans the provided IP.

Parameters

ip	The IP address to ban.

AddBannedPlayerName()

void Anvil.API.NwServer.AddBannedPlayerName ( string playerName )

inline

Bans the provided player/community name.

Warning

Players can change their player name at will.

Parameters

playerName

The player name to ban.

DeletePlayerTURD()

bool Anvil.API.NwServer.DeletePlayerTURD ( string playerId, string characterName )

inline

Delete the TURD of playerName + characterName.

At times a PC may get stuck in a permanent crash loop when attempting to login. This function allows administrators to delete their Temporary User Resource Data where the PC's current location is stored allowing them to log into the starting area.

Parameters

playerId	The community (login name) of the player. If CD Key TURDs are enabled (NWNX_TWEAKS_TURD_BY_CDKEY), this is the player's CD key.
characterName	The character name.

Returns

true if the TURD was successfully deleted.

GetAliasPath()

string Anvil.API.NwServer.GetAliasPath ( string alias )

inline

Gets the absolute path defined for the given directory alias (see nwn.ini).

Parameters

alias

The alias name.

Returns

The path defined for the specified alias, otherwise null if the alias could not be found.

RemoveBannedCDKey()

void Anvil.API.NwServer.RemoveBannedCDKey ( string cdKey )

inline

Removes the ban on the provided public CD key.

Parameters

cdKey

The public CD key to unban.

RemoveBannedIP()

void Anvil.API.NwServer.RemoveBannedIP ( string ip )

inline

Removes the ban on the provided IP.

Parameters

ip	The IP Address to unban.

RemoveBannedPlayer()

void Anvil.API.NwServer.RemoveBannedPlayer ( string playerName )

inline

Removes the ban on the provided player/community name.

Parameters

playerName

The player name to unban.

---

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

• NWN.Anvil/src/main/API/Server/NwServer.cs