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 Enumeration Documentation

◆ ESpecMode

enum CServerAdmin::ESpecMode

Enumerator
Selectable
SpectatorForced
PlayerForced
SpectatorSelectable
PlayerSelectable

Member Function Documentation

◆ Authentication_GetToken()

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

Always use NullId as UserId.

◆ AutoTeamBalance()

Void CServerAdmin::AutoTeamBalance ( )

◆ Ban() [1/2]

Boolean CServerAdmin::Ban	(	CClient	Client,
		Text	Reason )

◆ Ban() [2/2]

Boolean CServerAdmin::Ban	(	CUser	User,
		Text	Reason )

◆ ConnectFakePlayer()

Text CServerAdmin::ConnectFakePlayer ( )

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

◆ CustomizeQuitDialog()

Void CServerAdmin::CustomizeQuitDialog	(	Text	ManialinkPage,
		Text	SendToServerUrl,
		Boolean	ProposeAddToFavorites,
		Integer	ForceDelay )

◆ DisconnectFakePlayer()

Void CServerAdmin::DisconnectFakePlayer ( Text Login )

◆ ForcePlayerRequestedTeam() [1/2]

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

Team is 1 or 2.

◆ ForcePlayerRequestedTeam() [2/2]

Boolean CServerAdmin::ForcePlayerRequestedTeam	(	CUser	User,
		Integer	Team )

◆ ForceSpectator() [1/2]

Boolean CServerAdmin::ForceSpectator	(	CClient	Client,
		CServerAdmin::ESpecMode	SpecMode )

◆ ForceSpectator() [2/2]

Boolean CServerAdmin::ForceSpectator	(	CUser	User,
		CServerAdmin::ESpecMode	SpecMode )

◆ Kick() [1/2]

Boolean CServerAdmin::Kick	(	CClient	Client,
		Text	Reason )

◆ Kick() [2/2]

Boolean CServerAdmin::Kick	(	CUser	User,
		Text	Reason )

◆ SendToServerAfterMatch()

Void CServerAdmin::SendToServerAfterMatch ( Text ServerUrl )

◆ SetLobbyInfo()

Void CServerAdmin::SetLobbyInfo	(	Boolean	IsLobby,
		Integer	LobbyPlayerCount,
		Integer	LobbyMaxPlayerCount,
		Real	LobbyPlayersLevel )

◆ SetViewerCount()

Void CServerAdmin::SetViewerCount ( Integer ViewerCount )

Member Data Documentation

◆ Authentication_ErrorCode

Integer const CServerAdmin::Authentication_ErrorCode

◆ Authentication_GetTokenResponseReceived

Boolean const CServerAdmin::Authentication_GetTokenResponseReceived

◆ Authentication_Token

Text const CServerAdmin::Authentication_Token

◆ IsDisableChangeTeams

Boolean CServerAdmin::IsDisableChangeTeams

Disable Team change UI on the clients.

◆ IsDisableProfileSkins

Boolean CServerAdmin::IsDisableProfileSkins

◆ PlayerRestrictions

Text const CServerAdmin::PlayerRestrictions

◆ ServerInfo

CServerInfo* const CServerAdmin::ServerInfo

ServerInfo

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

doc.h

Public Types

Public Member Functions

Public Attributes