ManiaScript Trackmania 2020  14/07/2025
CPlaygroundClient Class Reference

API for plugins to get playground info. More...

#include <2025_07_14.h>

Inheritance diagram for CPlaygroundClient:
CNod

Public Types

enum  ESpectatorCameraType {
  Replay, Follow, Free, StandardCount,
  NotUsed0, NotUsed1, NotUsed2, NotUsed3,
  NotUsed4, NotUsed5, NotUsed6, NotUsed7,
  NotUsed8, NotUsed9, FollowForced, DontChange
}
 
enum  ESpectatorTargetType { None, Single, AllPlayers, AllMap }
 

Public Member Functions

Void QuitServer (Boolean Silent)
 
Void QuitServerAndSetResult (Boolean Silent, Text Type, Array< Text > Data)
 
Void JoinTeam1 ()
 
Void JoinTeam2 ()
 
Void RequestSpectatorClient (Boolean Spectator)
 
Void SetSpectateTarget (Text Player)
 
Void ShowProfile (Text Player)
 
Boolean SaveReplay (Text FileName)
 
Boolean SavePrevReplay (Text FileName)
 
Boolean SaveMap (Text FileName)
 
Void MapList_Request ()
 
CPlaygroundClient::ESpectatorCameraType GetSpectatorCameraType ()
 
CPlaygroundClient::ESpectatorTargetType GetSpectatorTargetType ()
 
Void SetWantedSpectatorCameraType (CPlaygroundClient::ESpectatorCameraType CameraType)
 
Void RequestRestartMap ()
 
Void RequestNextMap ()
 
Void RequestGotoMap (Text MapUid)
 
Void RequestSetNextMap (Text MapUid)
 
Void RequestAutoTeamBalance ()
 
Void RequestChangeModeScriptSettings (Text SettingsXml)
 
Void Vote_Cast (Boolean Answer)
 

Public Attributes

CMap *const Map
 
Integer const GameTime
 
CUser *const LocalUser
 
CUIConfig *const UI
 
CServerInfo *const ServerInfo
 
Ident const SettingsPlayerModelId
 
Boolean const HasPodium
 
Boolean const IsSpectator
 
Boolean const IsSpectatorClient
 
Boolean const UseClans
 
Boolean const UseForcedClans
 
Boolean const IsLoadingScreen
 
Boolean const IsServerOrSolo
 
Boolean const IsInGameMenuDisplayed
 
Array< CTeam *const > Teams
 
Boolean const MapList_IsInProgress
 
Array< TextMapList_Names
 
Array< TextMapList_MapUids
 
Boolean const Request_IsInProgress
 
Boolean const Request_Success
 
Text const Vote_Question
 
Boolean const Vote_CanVote
 
- Public Attributes inherited from CNod
Ident const Id
 

Detailed Description

API for plugins to get playground info.

Supported declare modes :

  • Local
  • Persistent

Definition at line 18302 of file 2025_07_14.h.

Member Enumeration Documentation

◆ ESpectatorCameraType

Enumerator
Replay 
Follow 
Free 
StandardCount 
NotUsed0 
NotUsed1 
NotUsed2 
NotUsed3 
NotUsed4 
NotUsed5 
NotUsed6 
NotUsed7 
NotUsed8 
NotUsed9 
FollowForced 
DontChange 

Definition at line 18307 of file 2025_07_14.h.

18307  {
18308  Replay,
18309  Follow,
18310  Free,
18311  StandardCount,
18312  NotUsed0,
18313  NotUsed1,
18314  NotUsed2,
18315  NotUsed3,
18316  NotUsed4,
18317  NotUsed5,
18318  NotUsed6,
18319  NotUsed7,
18320  NotUsed8,
18321  NotUsed9,
18322  FollowForced,
18323  DontChange,
18324  };

◆ ESpectatorTargetType

Enumerator
None 
Single 
AllPlayers 
AllMap 

Definition at line 18328 of file 2025_07_14.h.

18328  {
18329  None,
18330  Single,
18331  AllPlayers,
18332  AllMap,
18333  };

Member Function Documentation

◆ GetSpectatorCameraType()

CPlaygroundClient::ESpectatorCameraType CPlaygroundClient::GetSpectatorCameraType ( )

◆ GetSpectatorTargetType()

CPlaygroundClient::ESpectatorTargetType CPlaygroundClient::GetSpectatorTargetType ( )

◆ JoinTeam1()

Void CPlaygroundClient::JoinTeam1 ( )

◆ JoinTeam2()

Void CPlaygroundClient::JoinTeam2 ( )

◆ MapList_Request()

Void CPlaygroundClient::MapList_Request ( )

◆ QuitServer()

Void CPlaygroundClient::QuitServer ( Boolean  Silent)

◆ QuitServerAndSetResult()

Void CPlaygroundClient::QuitServerAndSetResult ( Boolean  Silent,
Text  Type,
Array< Text Data 
)

◆ RequestAutoTeamBalance()

Void CPlaygroundClient::RequestAutoTeamBalance ( )

◆ RequestChangeModeScriptSettings()

Void CPlaygroundClient::RequestChangeModeScriptSettings ( Text  SettingsXml)

Change some settings from the mode with new values. No need to include unchanged settings. ex: '<script_settings><setting name="S_TimeLimit" type="integer" value="300"/><script_settings/>' nb: you can use TriggerPageAction('maniaplanet:editsettings'); to use the legacy UI.

◆ RequestGotoMap()

Void CPlaygroundClient::RequestGotoMap ( Text  MapUid)

◆ RequestNextMap()

Void CPlaygroundClient::RequestNextMap ( )

◆ RequestRestartMap()

Void CPlaygroundClient::RequestRestartMap ( )

◆ RequestSetNextMap()

Void CPlaygroundClient::RequestSetNextMap ( Text  MapUid)

◆ RequestSpectatorClient()

Void CPlaygroundClient::RequestSpectatorClient ( Boolean  Spectator)

Request change of IsSpectatorClient (not immediate, and it may be refused). Caveat: will not set Request_Success

◆ SaveMap()

Boolean CPlaygroundClient::SaveMap ( Text  FileName)

Save the current map to a file (if the server IsMapDownloadAllowed). Filename is optional.

◆ SavePrevReplay()

Boolean CPlaygroundClient::SavePrevReplay ( Text  FileName)

◆ SaveReplay()

Boolean CPlaygroundClient::SaveReplay ( Text  FileName)

Save the current replay to a file. Filename is optional.

◆ SetSpectateTarget()

Void CPlaygroundClient::SetSpectateTarget ( Text  Player)

◆ SetWantedSpectatorCameraType()

Void CPlaygroundClient::SetWantedSpectatorCameraType ( CPlaygroundClient::ESpectatorCameraType  CameraType)

◆ ShowProfile()

Void CPlaygroundClient::ShowProfile ( Text  Player)

◆ Vote_Cast()

Void CPlaygroundClient::Vote_Cast ( Boolean  Answer)

Member Data Documentation

◆ GameTime

Integer const CPlaygroundClient::GameTime

Definition at line 18341 of file 2025_07_14.h.

◆ HasPodium

Boolean const CPlaygroundClient::HasPodium

Definition at line 18361 of file 2025_07_14.h.

◆ IsInGameMenuDisplayed

Boolean const CPlaygroundClient::IsInGameMenuDisplayed

Definition at line 18397 of file 2025_07_14.h.

◆ IsLoadingScreen

Boolean const CPlaygroundClient::IsLoadingScreen

Definition at line 18381 of file 2025_07_14.h.

◆ IsServerOrSolo

Boolean const CPlaygroundClient::IsServerOrSolo

Definition at line 18385 of file 2025_07_14.h.

◆ IsSpectator

Boolean const CPlaygroundClient::IsSpectator

Is in spectator mode - may be only for a short time between rounds.

Definition at line 18365 of file 2025_07_14.h.

◆ IsSpectatorClient

Boolean const CPlaygroundClient::IsSpectatorClient

Client actually desires to spectate instead of playing.

Definition at line 18369 of file 2025_07_14.h.

◆ LocalUser

CUser* const CPlaygroundClient::LocalUser

Definition at line 18345 of file 2025_07_14.h.

◆ Map

CMap* const CPlaygroundClient::Map

Null when no map loaded.

Definition at line 18337 of file 2025_07_14.h.

◆ MapList_IsInProgress

Boolean const CPlaygroundClient::MapList_IsInProgress

Definition at line 18453 of file 2025_07_14.h.

◆ MapList_MapUids

Array<Text> CPlaygroundClient::MapList_MapUids

Definition at line 18461 of file 2025_07_14.h.

◆ MapList_Names

Array<Text> CPlaygroundClient::MapList_Names

Definition at line 18457 of file 2025_07_14.h.

◆ Request_IsInProgress

Boolean const CPlaygroundClient::Request_IsInProgress

Definition at line 18465 of file 2025_07_14.h.

◆ Request_Success

Boolean const CPlaygroundClient::Request_Success

Definition at line 18469 of file 2025_07_14.h.

◆ ServerInfo

CServerInfo* const CPlaygroundClient::ServerInfo

Definition at line 18353 of file 2025_07_14.h.

◆ SettingsPlayerModelId

Ident const CPlaygroundClient::SettingsPlayerModelId

Definition at line 18357 of file 2025_07_14.h.

◆ Teams

Array<CTeam* const > CPlaygroundClient::Teams

Definition at line 18409 of file 2025_07_14.h.

◆ UI

CUIConfig* const CPlaygroundClient::UI

Definition at line 18349 of file 2025_07_14.h.

◆ UseClans

Boolean const CPlaygroundClient::UseClans

Definition at line 18373 of file 2025_07_14.h.

◆ UseForcedClans

Boolean const CPlaygroundClient::UseForcedClans

Definition at line 18377 of file 2025_07_14.h.

◆ Vote_CanVote

Boolean const CPlaygroundClient::Vote_CanVote

Definition at line 18502 of file 2025_07_14.h.

◆ Vote_Question

Text const CPlaygroundClient::Vote_Question

Definition at line 18498 of file 2025_07_14.h.


The documentation for this class was generated from the following file:
CPlaygroundClient::NotUsed6
@ NotUsed6
Definition: 2025_07_14.h:18318
CPlaygroundClient::NotUsed1
@ NotUsed1
Definition: 2025_07_14.h:18313
CPlaygroundClient::AllMap
@ AllMap
Definition: 2025_07_14.h:18332
CPlaygroundClient::NotUsed0
@ NotUsed0
Definition: 2025_07_14.h:18312
CPlaygroundClient::AllPlayers
@ AllPlayers
Definition: 2025_07_14.h:18331
CPlaygroundClient::DontChange
@ DontChange
Definition: 2025_07_14.h:18323
CPlaygroundClient::Replay
@ Replay
Definition: 2025_07_14.h:18308
CPlaygroundClient::NotUsed3
@ NotUsed3
Definition: 2025_07_14.h:18315
CPlaygroundClient::NotUsed4
@ NotUsed4
Definition: 2025_07_14.h:18316
CPlaygroundClient::Follow
@ Follow
Definition: 2025_07_14.h:18309
CPlaygroundClient::NotUsed9
@ NotUsed9
Definition: 2025_07_14.h:18321
CPlaygroundClient::Free
@ Free
Definition: 2025_07_14.h:18310
CPlaygroundClient::NotUsed8
@ NotUsed8
Definition: 2025_07_14.h:18320
CPlaygroundClient::NotUsed2
@ NotUsed2
Definition: 2025_07_14.h:18314
CPlaygroundClient::None
@ None
Definition: 2025_07_14.h:18329
CPlaygroundClient::StandardCount
@ StandardCount
Definition: 2025_07_14.h:18311
CPlaygroundClient::NotUsed7
@ NotUsed7
Definition: 2025_07_14.h:18319
CPlaygroundClient::NotUsed5
@ NotUsed5
Definition: 2025_07_14.h:18317
CPlaygroundClient::FollowForced
@ FollowForced
Definition: 2025_07_14.h:18322
CPlaygroundClient::Single
@ Single
Definition: 2025_07_14.h:18330