CServerPlugin Class Reference

Server plugin. More...

#include <2024_10_30.h>

Inheritance diagram for CServerPlugin:

Public Member Functions
CClient	GetClient (Text Login)
CClient	GetClient (CUIConfig UI)
CClient	GetClient (CUser Login)
CClient	GetClientFromWebServicesUserId (Text WebServicesUserId)
CPlayer	GetPlaygroundPlayer (Text Login)
Void	TweakTeamColorsToAvoidHueOverlap ()
Void	TriggerModeScriptEvent (Text Type, Array< Text > Data)
Void	SendModeScriptCommand (Text CommandName, Boolean BoolVal)
Void	SendModeScriptCommand (Text CommandName, Integer IntVal)
Void	SendModeScriptCommand (Text CommandName, Real RealVal)
Void	SendModeScriptCommand (Text CommandName, Text TextVal)
Void	SendModeScriptCommand (Text CommandName, Vec2 Vec2Val)
Void	SendModeScriptCommand (Text CommandName, Vec3 Vec3Val)
Void	SendModeScriptCommand (Text CommandName, Int2 Int2Val)
Void	SendModeScriptCommand (Text CommandName, Int3 Int3Val)
Void	RestartMap ()
Void	NextMap ()
Text	Dbg_DumpDeclareForVariables (CNod Nod, Boolean StatsOnly)
Void	TaskResult_Release (Ident TaskResultId)
CTaskResult_Ghost	Ghost_Download (Text Url)
Void	GhostDriver_Playlist_Clear (CPlayer Player)
Void	GhostDriver_Playlist_Add (CPlayer Player, CGhost Ghost)

Public Attributes
CTitle *const	LoadedTitle
CMapInfo *const	MapInfo
Array< CClient *const >	Clients
Array< CClient *const >	Spectators
Array< CClient *const >	Players
Array< CScore *const >	Scores
Array< CUser *const >	Users
Array< CTeam *const >	Teams
Text	NeutralEmblemUrl
Text	ForcedClubLinkUrl1
Text	ForcedClubLinkUrl2
Array< Integer >	ClansNbPlayers
Array< Integer >	ClanScores
Integer const	Now
Array< CServerPluginEvent *const >	PendingEvents
Boolean const	MapLoaded
Boolean const	MapUnloadRequested
Array< CMapInfo *const >	MapList
Integer const	CurMapIndex
Integer	NextMapIndex
Boolean	HoldMapUnloadRequest
Boolean	Client_ComputeMinimap
CUIConfigMgr *const	UIManager
CServerAdmin *const	ServerAdmin
CXmlRpc *const	XmlRpc
CParsingManager *const	Xml
CHttpManager *const	Http
CSystemPlatform *const	System
Array< CTaskResult *const >	TaskResults
Array< CGhost *const >	Ghosts
Public Attributes inherited from CNod
Ident const	Id

Detailed Description

Server plugin.

Supported declare modes :

• Local
• Persistent

Definition at line 526 of file 2024_10_30.h.

Member Function Documentation

Dbg_DumpDeclareForVariables()

Text CServerPlugin::Dbg_DumpDeclareForVariables	(	CNod	Nod,
		Boolean	StatsOnly
	)

GetClient() [1/3]

CClient CServerPlugin::GetClient

(

CUIConfig

UI

)

GetClient() [2/3]

CClient CServerPlugin::GetClient

(

CUser

Login

)

GetClient() [3/3]

CClient CServerPlugin::GetClient

(

Text

Login

)

GetClientFromWebServicesUserId()

CClient CServerPlugin::GetClientFromWebServicesUserId

(

Text

WebServicesUserId

)

GetPlaygroundPlayer()

CPlayer CServerPlugin::GetPlaygroundPlayer

(

Text

Login

)

Ghost_Download()

CTaskResult_Ghost CServerPlugin::Ghost_Download

(

Text

Url

)

GhostDriver_Playlist_Add()

Void CServerPlugin::GhostDriver_Playlist_Add	(	CPlayer	Player,
		CGhost	Ghost
	)

GhostDriver_Playlist_Clear()

Void CServerPlugin::GhostDriver_Playlist_Clear

(

CPlayer

Player

)

NextMap()

Void CServerPlugin::NextMap

(

)

RestartMap()

Void CServerPlugin::RestartMap

(

)

SendModeScriptCommand() [1/8]

Void CServerPlugin::SendModeScriptCommand	(	Text	CommandName,
		Boolean	BoolVal
	)

SendModeScriptCommand() [2/8]

Void CServerPlugin::SendModeScriptCommand	(	Text	CommandName,
		Int2	Int2Val
	)

SendModeScriptCommand() [3/8]

Void CServerPlugin::SendModeScriptCommand	(	Text	CommandName,
		Int3	Int3Val
	)

SendModeScriptCommand() [4/8]

Void CServerPlugin::SendModeScriptCommand	(	Text	CommandName,
		Integer	IntVal
	)

SendModeScriptCommand() [5/8]

Void CServerPlugin::SendModeScriptCommand	(	Text	CommandName,
		Real	RealVal
	)

SendModeScriptCommand() [6/8]

Void CServerPlugin::SendModeScriptCommand	(	Text	CommandName,
		Text	TextVal
	)

SendModeScriptCommand() [7/8]

Void CServerPlugin::SendModeScriptCommand	(	Text	CommandName,
		Vec2	Vec2Val
	)

SendModeScriptCommand() [8/8]

Void CServerPlugin::SendModeScriptCommand	(	Text	CommandName,
		Vec3	Vec3Val
	)

TaskResult_Release()

Void CServerPlugin::TaskResult_Release

(

Ident

TaskResultId

)

TriggerModeScriptEvent()

Void CServerPlugin::TriggerModeScriptEvent	(	Text	Type,
		Array< Text >	Data
	)

TweakTeamColorsToAvoidHueOverlap()

Void CServerPlugin::TweakTeamColorsToAvoidHueOverlap

(

)

Member Data Documentation

ClanScores

Array<Integer> CServerPlugin::ClanScores

Definition at line 603 of file 2024_10_30.h.

ClansNbPlayers

Array<Integer> CServerPlugin::ClansNbPlayers

Definition at line 599 of file 2024_10_30.h.

Client_ComputeMinimap

Boolean CServerPlugin::Client_ComputeMinimap

Enable minimap on the clients, even if the mode does not do it.

Definition at line 683 of file 2024_10_30.h.

Clients

Array<CClient* const > CServerPlugin::Clients

Currently connected Users.

Definition at line 555 of file 2024_10_30.h.

CurMapIndex

Integer const CServerPlugin::CurMapIndex

Definition at line 663 of file 2024_10_30.h.

ForcedClubLinkUrl1

Text CServerPlugin::ForcedClubLinkUrl1

Definition at line 587 of file 2024_10_30.h.

ForcedClubLinkUrl2

Text CServerPlugin::ForcedClubLinkUrl2

Definition at line 591 of file 2024_10_30.h.

Ghosts

Array<CGhost* const > CServerPlugin::Ghosts

Definition at line 723 of file 2024_10_30.h.

HoldMapUnloadRequest

Boolean CServerPlugin::HoldMapUnloadRequest

Definition at line 679 of file 2024_10_30.h.

Http

CHttpManager* const CServerPlugin::Http

Definition at line 703 of file 2024_10_30.h.

LoadedTitle

CTitle* const CServerPlugin::LoadedTitle

Definition at line 531 of file 2024_10_30.h.

MapInfo

CMapInfo* const CServerPlugin::MapInfo

Definition at line 535 of file 2024_10_30.h.

MapList

Array<CMapInfo* const > CServerPlugin::MapList

Definition at line 659 of file 2024_10_30.h.

MapLoaded

Boolean const CServerPlugin::MapLoaded

Definition at line 651 of file 2024_10_30.h.

MapUnloadRequested

Boolean const CServerPlugin::MapUnloadRequested

Definition at line 655 of file 2024_10_30.h.

NeutralEmblemUrl

Text CServerPlugin::NeutralEmblemUrl

Definition at line 583 of file 2024_10_30.h.

NextMapIndex

Integer CServerPlugin::NextMapIndex

Definition at line 667 of file 2024_10_30.h.

Now

Integer const CServerPlugin::Now

Definition at line 607 of file 2024_10_30.h.

PendingEvents

Array<CServerPluginEvent* const > CServerPlugin::PendingEvents

Definition at line 611 of file 2024_10_30.h.

Players

Array<CClient* const > CServerPlugin::Players

Users connected as players.

Definition at line 563 of file 2024_10_30.h.

Scores

Array<CScore* const > CServerPlugin::Scores

Sorted scores.

Definition at line 571 of file 2024_10_30.h.

ServerAdmin

CServerAdmin* const CServerPlugin::ServerAdmin

Definition at line 691 of file 2024_10_30.h.

Spectators

Array<CClient* const > CServerPlugin::Spectators

Users connected as spectators.

Definition at line 559 of file 2024_10_30.h.

System

CSystemPlatform* const CServerPlugin::System

Definition at line 707 of file 2024_10_30.h.

TaskResults

Array<CTaskResult* const > CServerPlugin::TaskResults

Definition at line 715 of file 2024_10_30.h.

Teams

Array<CTeam* const > CServerPlugin::Teams

Definition at line 579 of file 2024_10_30.h.

UIManager

CUIConfigMgr* const CServerPlugin::UIManager

Definition at line 687 of file 2024_10_30.h.

Users

Array<CUser* const > CServerPlugin::Users

Definition at line 575 of file 2024_10_30.h.

Xml

CParsingManager* const CServerPlugin::Xml

Definition at line 699 of file 2024_10_30.h.

XmlRpc

CXmlRpc* const CServerPlugin::XmlRpc

Definition at line 695 of file 2024_10_30.h.

---

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

• Sources/2024_10_30.h