IServer

Namespace: uModCommon

Assembly: uMod.Common.dll

Implements INameable, ISingleton

Summary

Represents a generic server hosting the game instance

Properties

Name

Summary

Address

Gets the public-facing IP address of the server, if known

FrameRate

Gets the current or average frame rate of the server

Language

Gets the language for the server

LocalAddress

Gets the internal IP address of the server, if known

MaxPlayers

Gets/sets the maximum players allowed on the server

Name

Gets/sets the public-facing name of the server

PlayerManager

Gets or sets player manager

Players

Gets the total of players currently on the server

Port

Gets the public-facing network port of the server, if known

Protocol

Gets the network protocol version of the server

SaveInfo

Gets information on the currently loaded save file

TargetFrameRate

Gets/sets the target frame rate for the server

Time

Gets/sets the current in-game time on the server

Version

Gets the version or build number of the server

Methods

Name

Summary

Ban (String, String, TimeSpan)

Bans the player for the specified reason and duration

BanTimeRemaining (String)

Gets the amount of time remaining on the player's ban

Broadcast (String, String, Object[])

Broadcasts the specified chat message and prefix to all players

Broadcast (String)

Broadcasts the specified chat message to all players

Command (String, Object[])

Runs the specified server command

IsBanned (String)

Gets if the player is banned

Save ()

Saves the server and any related information

Shutdown (Boolean, Int32)

Unban (String)

Unbans the player