CMode Class Reference

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 Function Documentation

ItemList_AddWithSkin()

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.

Member Data Documentation

DataFileMgr

CDataFileMgr* const CMode::DataFileMgr

Only available for local solo modes.

Input

CInputManager* const CMode::Input

Only available for local solo modes.

---

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

• doc.h