CPlaygroundClient Class Reference

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

#include <2024_10_30.h>

Inheritance diagram for CPlaygroundClient:

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< Text >	MapList_Names
Array< Text >	MapList_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 18274 of file 2024_10_30.h.

Member Enumeration Documentation

ESpectatorCameraType

enum CPlaygroundClient::ESpectatorCameraType

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

Definition at line 18279 of file 2024_10_30.h.

                              {
        Replay,
        Follow,
        Free,
        StandardCount,
        NotUsed0,
        NotUsed1,
        NotUsed2,
        NotUsed3,
        NotUsed4,
        NotUsed5,
        NotUsed6,
        NotUsed7,
        NotUsed8,
        NotUsed9,
        FollowForced,
        DontChange,
    };

ESpectatorTargetType

enum CPlaygroundClient::ESpectatorTargetType

Enumerator
None
Single
AllPlayers
AllMap

Definition at line 18300 of file 2024_10_30.h.

                              {
        None,
        Single,
        AllPlayers,
        AllMap,
    };

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 18313 of file 2024_10_30.h.

HasPodium

Boolean const CPlaygroundClient::HasPodium

Definition at line 18333 of file 2024_10_30.h.

IsInGameMenuDisplayed

Boolean const CPlaygroundClient::IsInGameMenuDisplayed

Definition at line 18369 of file 2024_10_30.h.

IsLoadingScreen

Boolean const CPlaygroundClient::IsLoadingScreen

Definition at line 18353 of file 2024_10_30.h.

IsServerOrSolo

Boolean const CPlaygroundClient::IsServerOrSolo

Definition at line 18357 of file 2024_10_30.h.

IsSpectator

Boolean const CPlaygroundClient::IsSpectator

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

Definition at line 18337 of file 2024_10_30.h.

IsSpectatorClient

Boolean const CPlaygroundClient::IsSpectatorClient

Client actually desires to spectate instead of playing.

Definition at line 18341 of file 2024_10_30.h.

LocalUser

CUser* const CPlaygroundClient::LocalUser

Definition at line 18317 of file 2024_10_30.h.

Map

CMap* const CPlaygroundClient::Map

Null when no map loaded.

Definition at line 18309 of file 2024_10_30.h.

MapList_IsInProgress

Boolean const CPlaygroundClient::MapList_IsInProgress

Definition at line 18425 of file 2024_10_30.h.

MapList_MapUids

Array<Text> CPlaygroundClient::MapList_MapUids

Definition at line 18433 of file 2024_10_30.h.

MapList_Names

Array<Text> CPlaygroundClient::MapList_Names

Definition at line 18429 of file 2024_10_30.h.

Request_IsInProgress

Boolean const CPlaygroundClient::Request_IsInProgress

Definition at line 18437 of file 2024_10_30.h.

Request_Success

Boolean const CPlaygroundClient::Request_Success

Definition at line 18441 of file 2024_10_30.h.

ServerInfo

CServerInfo* const CPlaygroundClient::ServerInfo

Definition at line 18325 of file 2024_10_30.h.

SettingsPlayerModelId

Ident const CPlaygroundClient::SettingsPlayerModelId

Definition at line 18329 of file 2024_10_30.h.

Teams

Array<CTeam* const > CPlaygroundClient::Teams

Definition at line 18381 of file 2024_10_30.h.

UI

CUIConfig* const CPlaygroundClient::UI

Definition at line 18321 of file 2024_10_30.h.

UseClans

Boolean const CPlaygroundClient::UseClans

Definition at line 18345 of file 2024_10_30.h.

UseForcedClans

Boolean const CPlaygroundClient::UseForcedClans

Definition at line 18349 of file 2024_10_30.h.

Vote_CanVote

Boolean const CPlaygroundClient::Vote_CanVote

Definition at line 18474 of file 2024_10_30.h.

Vote_Question

Text const CPlaygroundClient::Vote_Question

Definition at line 18470 of file 2024_10_30.h.

---

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

• Sources/2024_10_30.h