ManiaScript Reference  2019-05
CServerAdmin Struct Reference
Inheritance diagram for CServerAdmin:
CNod

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, ESpecMode SpecMode)
 
Boolean ForceSpectator (CClient Client, ESpecMode SpecMode)
 
Boolean ForcePlayerRequestedTeam (CUser User, Integer Team)
 
Boolean ForcePlayerRequestedTeam (CClient Client, Integer Team)
 
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)
 

Public Attributes

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

Detailed Description

API for server control when playing online.

Member Enumeration Documentation

◆ 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 ( CUser  User,
Text  Reason 
)

◆ Ban() [2/2]

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

◆ CustomizeQuitDialog()

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

◆ ForcePlayerRequestedTeam() [1/2]

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

◆ ForcePlayerRequestedTeam() [2/2]

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

Team is 1 or 2.

◆ ForceSpectator() [1/2]

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

◆ ForceSpectator() [2/2]

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

◆ Kick() [1/2]

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

◆ Kick() [2/2]

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

◆ SendToServerAfterMatch()

Void CServerAdmin::SendToServerAfterMatch ( Text  ServerUrl)

◆ SetLobbyInfo()

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

Member Data Documentation

◆ Authentication_ErrorCode

const Integer CServerAdmin::Authentication_ErrorCode

◆ Authentication_GetTokenResponseReceived

const Boolean CServerAdmin::Authentication_GetTokenResponseReceived

◆ Authentication_Token

const Text CServerAdmin::Authentication_Token

◆ IsDisableChangeTeams

Boolean CServerAdmin::IsDisableChangeTeams

Disable Team change UI on the clients.

◆ ServerInfo

const CServerInfo CServerAdmin::ServerInfo

ServerInfo