Rules API for gamemodes. More...

#include <doc.h>

Inheritance diagram for CMode:

Public Types
enum	EMedal { None , Finished , Bronze , Silver , Gold , Author }

Public Member Functions
Void	TaskResult_Release (Ident TaskId)
Void	TweakTeamColorsToAvoidHueOverlap ()
Void	RequestLoadMap ()
Void	RequestUnloadMap ()
Void	Hud_Load (Text ModuleName)
Void	PassOn (CUIConfigEvent EventToPassOn)
Void	Discard (CUIConfigEvent EventToDiscard)
Void	Ladder_OpenMatch_Request ()
Void	Ladder_AddPlayer (CScore PlayerScore)
Void	Ladder_OpenMatch_BeginRequest ()
Void	Ladder_OpenMatch_AddPlayer (CScore PlayerScore)
Void	Ladder_OpenMatch_EndRequest ()
Void	Ladder_CloseMatchRequest ()
Void	Ladder_CancelMatchRequest ()
Void	Ladder_SetResultsVersion (Integer Version)
Void	Ladder_SetMatchMakingMatchId (Integer MatchId)
Void	Ladder_EnableChallengeMode (Boolean Enable)
Void	Trophy_CompetitionMatch_AddResult (Text WebServicesUserId, Integer MatchRank, Integer TrophyRanking)
Void	Trophy_CompetitionMatch_ClearResultList ()
CTaskResult_AccountTrophyGainList	Trophy_CompetitionMatch_SendResultList (Text CompetitionName, Text CompetitionStage, Text CompetitionStageStep, Text CompetitionMatchInfo)
Void	Trophy_LiveTimeAttackAchievement_AddResult (Text WebServicesUserId, Integer MatchRank, Integer TrophyRanking)
Void	Trophy_LiveTimeAttackAchievement_ClearResultList ()
CTaskResult_AccountTrophyGainList	Trophy_LiveTimeAttackAchievement_SendResultList (Integer Duration)
Void	AutoTeamBalance ()
Void	Solo_SetNewRecord (CScore PlayerScore, CMode::EMedal PlayerScore)
Integer	Synchro_AddBarrier ()
Boolean	Synchro_BarrierReached (Integer Barrier)
Boolean	Users_AreAllies (CUser User1, CUser User2)
Void	Users_RequestSwitchToSpectator (CUser User)
CUser	Users_CreateFake (Text NickName, Integer RequestedTeam)
Void	Users_DestroyFake (CUser User)
Void	Users_SetNbFakeUsers (Integer NbTeam1, Integer NbTeam2)
Void	Users_DestroyAllFakes ()
Void	ItemList_Begin ()
Boolean	ItemList_Begin ()
Ident	ItemList_Add (Text ModelName)
Ident	ItemList_AddWithSkin (Text ModelName, Text SkinNameOrUrl)
Ident	ItemList_AddWithSkin (Text ModelName, Text SkinNameOrUrl, Text SkinOptions)
Void	ItemList_End ()
Void	DemoToken_StartUsingToken ()
Void	DemoToken_StopUsingToken ()
Void	DemoToken_GetAndUseToken (CUser User)
Void	ActionList_Begin ()
Boolean	ActionList_Begin ()
Ident	ActionList_Add (Text ActionName)
Void	ActionList_End ()
Void	Replay_Start ()
Void	Replay_Stop ()
Void	Activity_Match_Create_Begin (Text ActivityId)
Void	Activity_Match_Create_AddPlayer (Text WebServicesUserId, Text TeamName)
Void	Activity_Match_Create_AddTeam (Text TeamName)
Void	Activity_Match_Create_End ()
Void	Activity_Match_ReportResult_Begin ()
Void	Activity_Match_ReportResult_SetPlayerResult (Text WebServicesUserId, Integer Rank, Integer Score)
Void	Activity_Match_ReportResult_SetTeamResult (Text TeamName, Integer Rank, Integer Score)
Void	Activity_Match_ReportResult_End ()
Void	Ghost_Release (Ident GhostId)
Void	GhostDriver_Playlist_Clear (CPlayer Player)
Void	GhostDriver_Playlist_Add (CPlayer Player, CGhost Ghost)
Void	GhostDriver_UploadLimits_Begin ()
Void	GhostDriver_UploadLimits_AddLevel (Integer TeamLevel)
CWebServicesTaskResult_GhostDriver_UploadLimits	GhostDriver_UploadLimits_End ()
Void	GhostDriver_Upload_Begin (Integer TeamLevel)
Void	GhostDriver_Upload_TeamMember_Begin ()
Void	GhostDriver_Upload_AddGhost (CGhost Ghost)
Void	GhostDriver_Upload_TeamMember_End ()
CTaskResult	GhostDriver_Upload_End ()
Void	GhostDriver_Download_Begin ()
Void	GhostDriver_Download_AddRange (Integer TeamLevelMin, Integer TeamLevelMax, Integer Count)
CWebServicesTaskResult_GhostDriver_Download	GhostDriver_Download_End ()
CTaskResult_MapRecordList	MapRecord_GetListByMapAndPlayerList (Ident UserId, Array< Text > WebServicesUserIdList, Text MapUid, Text ScopeType, Text ScopeId, Text GameMode, Text GameModeCustomData)
Void	GameScene_ResetAll ()
Text	Dbg_DumpDeclareForVariables (CNod Nod, Boolean StatsOnly)

Public Attributes
Array< CTaskResult *const >	TaskResults
Text	ModeStatusMessage
CTitle *const	LoadedTitle
Text const	ServerLogin
Text const	ServerName
Text const	ServerModeName
Text const	MapName
CMap *const	Map
Text const	MapPlayerModelName
Boolean const	HasPodium
Array< CUser *const >	Users
Array< CTeam *const >	Teams
Text	NeutralEmblemUrl
Text const	ForcedClubLinkUrl1
Text const	ForcedClubLinkUrl2
Text	ClientManiaAppUrl
Integer const	Now
Integer const	Period
Boolean	MatchEndRequested
Boolean const	ServerShutdownRequested
Boolean const	MapLoaded
Array< CMapInfo *const >	MapList
Integer	NextMapIndex
CUIConfigMgr *const	UIManager
CModulePlaygroundHud *const	Hud
Boolean const	Ladder_RequestInProgress
CServerAdmin *const	ServerAdmin
Boolean const	Solo_NewRecordSequenceInProgress
CXmlRpc *const	XmlRpc
CParsingManager *const	Xml
CHttpManager *const	Http
CInputManager *const	Input
CDataFileMgr *const	DataFileMgr
CScoreMgr *const	ScoreMgr
CSystemPlatform *const	System
CUserV2Manager *const	UserMgr
Boolean	UseMinimap
Boolean	Replay_AutoStart
CModeTurretManager *const	TurretsManager
CModeVehicleManager *const	VehiclesManager
CActionManager *const	ActionsManager
Boolean	EnableGhostRecording
Array< CGhost *const >	Ghosts
Integer const	UiUpdatePeriod
Public Attributes inherited from CNod
Ident const	Id

Detailed Description

Rules API for gamemodes.

Supported declare modes :

Local
Persistent

Member Enumeration Documentation

◆ EMedal

enum CMode::EMedal

Enumerator
None
Finished
Bronze
Silver
Gold
Author

Member Function Documentation

◆ ActionList_Add()

Ident CMode::ActionList_Add ( Text ActionName )

◆ ActionList_Begin() [1/2]

Boolean CMode::ActionList_Begin ( )

◆ ActionList_Begin() [2/2]

Void CMode::ActionList_Begin ( )

◆ ActionList_End()

Void CMode::ActionList_End ( )

◆ Activity_Match_Create_AddPlayer()

Void CMode::Activity_Match_Create_AddPlayer	(	Text	WebServicesUserId,
		Text	TeamName )

◆ Activity_Match_Create_AddTeam()

Void CMode::Activity_Match_Create_AddTeam ( Text TeamName )

◆ Activity_Match_Create_Begin()

Void CMode::Activity_Match_Create_Begin ( Text ActivityId )

◆ Activity_Match_Create_End()

Void CMode::Activity_Match_Create_End ( )

◆ Activity_Match_ReportResult_Begin()

Void CMode::Activity_Match_ReportResult_Begin ( )

◆ Activity_Match_ReportResult_End()

Void CMode::Activity_Match_ReportResult_End ( )

◆ Activity_Match_ReportResult_SetPlayerResult()

Void CMode::Activity_Match_ReportResult_SetPlayerResult	(	Text	WebServicesUserId,
		Integer	Rank,
		Integer	Score )

◆ Activity_Match_ReportResult_SetTeamResult()

Void CMode::Activity_Match_ReportResult_SetTeamResult	(	Text	TeamName,
		Integer	Rank,
		Integer	Score )

◆ AutoTeamBalance()

Void CMode::AutoTeamBalance ( )

◆ Dbg_DumpDeclareForVariables()

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

◆ DemoToken_GetAndUseToken()

Void CMode::DemoToken_GetAndUseToken ( CUser User )

◆ DemoToken_StartUsingToken()

Void CMode::DemoToken_StartUsingToken ( )

◆ DemoToken_StopUsingToken()

Void CMode::DemoToken_StopUsingToken ( )

◆ Discard()

Void CMode::Discard ( CUIConfigEvent EventToDiscard )

◆ GameScene_ResetAll()

Void CMode::GameScene_ResetAll ( )

◆ Ghost_Release()

Void CMode::Ghost_Release ( Ident GhostId )

◆ GhostDriver_Download_AddRange()

Void CMode::GhostDriver_Download_AddRange	(	Integer	TeamLevelMin,
		Integer	TeamLevelMax,
		Integer	Count )

◆ GhostDriver_Download_Begin()

Void CMode::GhostDriver_Download_Begin ( )

◆ GhostDriver_Download_End()

CWebServicesTaskResult_GhostDriver_Download CMode::GhostDriver_Download_End ( )

◆ GhostDriver_Playlist_Add()

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

◆ GhostDriver_Playlist_Clear()

Void CMode::GhostDriver_Playlist_Clear ( CPlayer Player )

◆ GhostDriver_Upload_AddGhost()

Void CMode::GhostDriver_Upload_AddGhost ( CGhost Ghost )

◆ GhostDriver_Upload_Begin()

Void CMode::GhostDriver_Upload_Begin ( Integer TeamLevel )

◆ GhostDriver_Upload_End()

CTaskResult CMode::GhostDriver_Upload_End ( )

◆ GhostDriver_Upload_TeamMember_Begin()

Void CMode::GhostDriver_Upload_TeamMember_Begin ( )

◆ GhostDriver_Upload_TeamMember_End()

Void CMode::GhostDriver_Upload_TeamMember_End ( )

◆ GhostDriver_UploadLimits_AddLevel()

Void CMode::GhostDriver_UploadLimits_AddLevel ( Integer TeamLevel )

◆ GhostDriver_UploadLimits_Begin()

Void CMode::GhostDriver_UploadLimits_Begin ( )

◆ GhostDriver_UploadLimits_End()

CWebServicesTaskResult_GhostDriver_UploadLimits CMode::GhostDriver_UploadLimits_End ( )

◆ Hud_Load()

Void CMode::Hud_Load ( Text ModuleName )

◆ ItemList_Add()

Ident CMode::ItemList_Add ( Text ModelName )

◆ ItemList_AddWithSkin() [1/2]

Ident CMode::ItemList_AddWithSkin	(	Text	ModelName,
		Text	SkinNameOrUrl )

SkinNameOrUrl: can be 'Skins/Model/....', 'http://....', 'Default' (or '') for item default skin, 'Profile' for the user choice for the model. ModelName: 'DefaultPlayerModel' for the default map model, or the item filename.

◆ ItemList_AddWithSkin() [2/2]

Ident CMode::ItemList_AddWithSkin	(	Text	ModelName,
		Text	SkinNameOrUrl,
		Text	SkinOptions )

◆ ItemList_Begin() [1/2]

Boolean CMode::ItemList_Begin ( )

◆ ItemList_Begin() [2/2]

Void CMode::ItemList_Begin ( )

◆ ItemList_End()

Void CMode::ItemList_End ( )

◆ Ladder_AddPlayer()

Void CMode::Ladder_AddPlayer ( CScore PlayerScore )

◆ Ladder_CancelMatchRequest()

Void CMode::Ladder_CancelMatchRequest ( )

◆ Ladder_CloseMatchRequest()

Void CMode::Ladder_CloseMatchRequest ( )

◆ Ladder_EnableChallengeMode()

Void CMode::Ladder_EnableChallengeMode ( Boolean Enable )

◆ Ladder_OpenMatch_AddPlayer()

Void CMode::Ladder_OpenMatch_AddPlayer ( CScore PlayerScore )

◆ Ladder_OpenMatch_BeginRequest()

Void CMode::Ladder_OpenMatch_BeginRequest ( )

◆ Ladder_OpenMatch_EndRequest()

Void CMode::Ladder_OpenMatch_EndRequest ( )

◆ Ladder_OpenMatch_Request()

Void CMode::Ladder_OpenMatch_Request ( )

◆ Ladder_SetMatchMakingMatchId()

Void CMode::Ladder_SetMatchMakingMatchId ( Integer MatchId )

◆ Ladder_SetResultsVersion()

Void CMode::Ladder_SetResultsVersion ( Integer Version )

◆ MapRecord_GetListByMapAndPlayerList()

CTaskResult_MapRecordList CMode::MapRecord_GetListByMapAndPlayerList	(	Ident	UserId,
		Array< Text >	WebServicesUserIdList,
		Text	MapUid,
		Text	ScopeType,
		Text	ScopeId,
		Text	GameMode,
		Text	GameModeCustomData )

◆ PassOn()

Void CMode::PassOn ( CUIConfigEvent EventToPassOn )

◆ Replay_Start()

Void CMode::Replay_Start ( )

◆ Replay_Stop()

Void CMode::Replay_Stop ( )

◆ RequestLoadMap()

Void CMode::RequestLoadMap ( )

◆ RequestUnloadMap()

Void CMode::RequestUnloadMap ( )

◆ Solo_SetNewRecord()

Void CMode::Solo_SetNewRecord	(	CScore	PlayerScore,
		CMode::EMedal	PlayerScore )

◆ Synchro_AddBarrier()

Integer CMode::Synchro_AddBarrier ( )

◆ Synchro_BarrierReached()

Boolean CMode::Synchro_BarrierReached ( Integer Barrier )

◆ TaskResult_Release()

Void CMode::TaskResult_Release ( Ident TaskId )

◆ Trophy_CompetitionMatch_AddResult()

Void CMode::Trophy_CompetitionMatch_AddResult	(	Text	WebServicesUserId,
		Integer	MatchRank,
		Integer	TrophyRanking )

◆ Trophy_CompetitionMatch_ClearResultList()

Void CMode::Trophy_CompetitionMatch_ClearResultList ( )

◆ Trophy_CompetitionMatch_SendResultList()

CTaskResult_AccountTrophyGainList CMode::Trophy_CompetitionMatch_SendResultList	(	Text	CompetitionName,
		Text	CompetitionStage,
		Text	CompetitionStageStep,
		Text	CompetitionMatchInfo )

◆ Trophy_LiveTimeAttackAchievement_AddResult()

Void CMode::Trophy_LiveTimeAttackAchievement_AddResult	(	Text	WebServicesUserId,
		Integer	MatchRank,
		Integer	TrophyRanking )

◆ Trophy_LiveTimeAttackAchievement_ClearResultList()

Void CMode::Trophy_LiveTimeAttackAchievement_ClearResultList ( )

◆ Trophy_LiveTimeAttackAchievement_SendResultList()

CTaskResult_AccountTrophyGainList CMode::Trophy_LiveTimeAttackAchievement_SendResultList ( Integer Duration )

◆ TweakTeamColorsToAvoidHueOverlap()

Void CMode::TweakTeamColorsToAvoidHueOverlap ( )

◆ Users_AreAllies()

Boolean CMode::Users_AreAllies	(	CUser	User1,
		CUser	User2 )

◆ Users_CreateFake()

CUser CMode::Users_CreateFake	(	Text	NickName,
		Integer	RequestedTeam )

◆ Users_DestroyAllFakes()

Void CMode::Users_DestroyAllFakes ( )

◆ Users_DestroyFake()

Void CMode::Users_DestroyFake ( CUser User )

◆ Users_RequestSwitchToSpectator()

Void CMode::Users_RequestSwitchToSpectator ( CUser User )

◆ Users_SetNbFakeUsers()

Void CMode::Users_SetNbFakeUsers	(	Integer	NbTeam1,
		Integer	NbTeam2 )

Member Data Documentation

◆ ActionsManager

CActionManager* const CMode::ActionsManager

◆ ClientManiaAppUrl

Text CMode::ClientManiaAppUrl

◆ DataFileMgr

CDataFileMgr* const CMode::DataFileMgr

Only available for local solo modes.

◆ EnableGhostRecording

Boolean CMode::EnableGhostRecording

◆ ForcedClubLinkUrl1

Text const CMode::ForcedClubLinkUrl1

◆ ForcedClubLinkUrl2

Text const CMode::ForcedClubLinkUrl2

◆ Ghosts

Array<CGhost* const > CMode::Ghosts

◆ HasPodium

Boolean const CMode::HasPodium

◆ Http

CHttpManager* const CMode::Http

◆ Hud

CModulePlaygroundHud* const CMode::Hud

◆ Input

CInputManager* const CMode::Input

Only available for local solo modes.

◆ Ladder_RequestInProgress

Boolean const CMode::Ladder_RequestInProgress

◆ LoadedTitle

CTitle* const CMode::LoadedTitle

◆ Map

CMap* const CMode::Map

◆ MapList

Array<CMapInfo* const > CMode::MapList

◆ MapLoaded

Boolean const CMode::MapLoaded

◆ MapName

Text const CMode::MapName

◆ MapPlayerModelName

Text const CMode::MapPlayerModelName

◆ MatchEndRequested

Boolean CMode::MatchEndRequested

◆ ModeStatusMessage

Text CMode::ModeStatusMessage

◆ NeutralEmblemUrl

Text CMode::NeutralEmblemUrl

◆ NextMapIndex

Integer CMode::NextMapIndex

◆ Now

Integer const CMode::Now

◆ Period

Integer const CMode::Period

◆ Replay_AutoStart

Boolean CMode::Replay_AutoStart

◆ ScoreMgr

CScoreMgr* const CMode::ScoreMgr

◆ ServerAdmin

CServerAdmin* const CMode::ServerAdmin

◆ ServerLogin

Text const CMode::ServerLogin

◆ ServerModeName

Text const CMode::ServerModeName

◆ ServerName

Text const CMode::ServerName

◆ ServerShutdownRequested

Boolean const CMode::ServerShutdownRequested

◆ Solo_NewRecordSequenceInProgress

Boolean const CMode::Solo_NewRecordSequenceInProgress

◆ System

CSystemPlatform* const CMode::System

◆ TaskResults

Array<CTaskResult* const > CMode::TaskResults

◆ Teams

Array<CTeam* const > CMode::Teams

◆ TurretsManager

CModeTurretManager* const CMode::TurretsManager

◆ UIManager

CUIConfigMgr* const CMode::UIManager

◆ UiUpdatePeriod

Integer const CMode::UiUpdatePeriod

◆ UseMinimap

Boolean CMode::UseMinimap

◆ UserMgr

CUserV2Manager* const CMode::UserMgr

◆ Users

Array<CUser* const > CMode::Users

◆ VehiclesManager

CModeVehicleManager* const CMode::VehiclesManager

◆ Xml

CParsingManager* const CMode::Xml

◆ XmlRpc

CXmlRpc* const CMode::XmlRpc

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

doc.h

Public Types

Public Member Functions

Public Attributes