CServerAdmin Class Reference

API for server control when playing online. More...

#include <doc.h>

Inheritance diagram for CServerAdmin:

Public Types
enum	ESpecMode {   Selectable , SpectatorForced , PlayerForced , SpectatorSelectable ,   PlayerSelectable }

Public Member Functions
Void	AutoTeamBalance ()
Boolean	Kick (CUser User, Text Reason)
Boolean	Kick (CClient Client, Text Reason)
Boolean	Ban (CUser User, Text Reason)
Boolean	Ban (CClient Client, Text Reason)
Boolean	ForceSpectator (CUser User, CServerAdmin::ESpecMode SpecMode)
Boolean	ForceSpectator (CClient Client, CServerAdmin::ESpecMode SpecMode)
Boolean	ForcePlayerRequestedTeam (CUser User, Integer Team)
Boolean	ForcePlayerRequestedTeam (CClient Client, Integer Team)
Text	ConnectFakePlayer ()
Void	DisconnectFakePlayer (Text Login)
Void	SetLobbyInfo (Boolean IsLobby, Integer LobbyPlayerCount, Integer LobbyMaxPlayerCount, Real LobbyPlayersLevel)
Void	SendToServerAfterMatch (Text ServerUrl)
Void	CustomizeQuitDialog (Text ManialinkPage, Text SendToServerUrl, Boolean ProposeAddToFavorites, Integer ForceDelay)
Void	Authentication_GetToken (Ident UserId, Text AppLogin)
Void	SetViewerCount (Integer ViewerCount)

Public Attributes
CServerInfo *const	ServerInfo
Boolean	IsDisableChangeTeams
Boolean	IsDisableProfileSkins
Boolean const	Authentication_GetTokenResponseReceived
Integer const	Authentication_ErrorCode
Text const	Authentication_Token
Text const	PlayerRestrictions
Public Attributes inherited from CNod
Ident const	Id

Detailed Description

API for server control when playing online.

Member Function Documentation

Authentication_GetToken()

Void CServerAdmin::Authentication_GetToken	(	Ident	UserId,
		Text	AppLogin )

Always use NullId as UserId.

ConnectFakePlayer()

Text CServerAdmin::ConnectFakePlayer

(

)

Connect a fake player (to help with debugging game modes)

ForcePlayerRequestedTeam()

Boolean CServerAdmin::ForcePlayerRequestedTeam	(	CClient	Client,
		Integer	Team )

Team is 1 or 2.

Member Data Documentation

IsDisableChangeTeams

Boolean CServerAdmin::IsDisableChangeTeams

Disable Team change UI on the clients.

ServerInfo

CServerInfo* const CServerAdmin::ServerInfo

ServerInfo

---

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

• doc.h