C# Class SharpMod.Server

A class that represents the running Server

Datei anzeigen Open project: txdv/sharpmod

Public Methods

Method	Description
EnqueueCommand ( string command ) : void	Enques a command in the server command queue. Server.ExecuteEnqueuedCommands() is needed to execute all enqueued commands. If you want to call multiple commands at once, use the newline character in order to seperate the commands
ExecuteCommand ( string command ) : void	Enques and executes a command.
ExecuteEnqueuedCommands ( ) : void	Executes all enqueued commands.
IsMapValid ( string map ) : bool	Uses the engine function to check if a map is valid.
LoadMapListFromDirectory ( ) : string[]	Returns a list of all valid maps in the directory.
LoadMapListFromMapcycle ( ) : string[]	Returns a list of all valid maps in the mapcycle.
Log ( string message ) : void	Logs a plain message. Doesn't use any decoration.
LogConsole ( string message ) : void	Logs a plain message to the console, not in the files.
LogDeveloper ( string message ) : void
LogError ( string message ) : void	Logs an error message, uses date, mod, Error prefix.
PrecacheSound ( string filename ) : int	Precaches sound
Print ( string message ) : void
RegisterCommand ( string str, CommandDelegate cmd ) : bool

Private Methods

Method	Description
CommandWrapper ( ) : void
Init ( ) : void
Server ( ) : System
SetMaxPlayers ( int maxplayers ) : void

Method Details

EnqueueCommand() public static method

Enques a command in the server command queue. Server.ExecuteEnqueuedCommands() is needed to execute all enqueued commands. If you want to call multiple commands at once, use the newline character in order to seperate the commands

public static EnqueueCommand ( string command ) : void
command	string	/// The command to execute ///
return	void

ExecuteCommand() public static method

Enques and executes a command.

public static ExecuteCommand ( string command ) : void
command	string	/// The command to be executed ///
return	void

ExecuteEnqueuedCommands() public static method

Executes all enqueued commands.

public static ExecuteEnqueuedCommands ( ) : void
return	void

IsMapValid() public static method

Uses the engine function to check if a map is valid.

public static IsMapValid ( string map ) : bool
map	string	/// Name of the map ///
return	bool

LoadMapListFromDirectory() public static method

Returns a list of all valid maps in the directory.

public static LoadMapListFromDirectory ( ) : string[]
return	string[]

LoadMapListFromMapcycle() public static method

Returns a list of all valid maps in the mapcycle.

public static LoadMapListFromMapcycle ( ) : string[]
return	string[]

Log() public static method

Logs a plain message. Doesn't use any decoration.

public static Log ( string message ) : void
message	string	/// Log message ///
return	void

LogConsole() public static method

Logs a plain message to the console, not in the files.

public static LogConsole ( string message ) : void
message	string	/// A ///
return	void

LogDeveloper() public static method

public static LogDeveloper ( string message ) : void
message	string
return	void

LogError() public static method

Logs an error message, uses date, mod, Error prefix.

public static LogError ( string message ) : void
message	string	/// Error message. ///
return	void

PrecacheSound() public static method

Precaches sound

public static PrecacheSound ( string filename ) : int
filename	string	/// A string representing the filename ///
return	int

Print() public static method

public static Print ( string message ) : void
message	string
return	void

RegisterCommand() public static method

public static RegisterCommand ( string str, CommandDelegate cmd ) : bool
str	string
cmd	CommandDelegate
return	bool