ManiaScript Reference  2019-05
CMode Struct Reference
Inheritance diagram for CMode:
CNod CSmMode CTmMode

Public Types

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

Public Member Functions

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 AutoTeamBalance ()
 
Void Solo_SetNewRecord (CScore PlayerScore, 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)
 
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 ()
 
Text Dbg_DumpDeclareForVariables (CNod Nod, Boolean StatsOnly)
 

Public Attributes

Text ModeStatusMessage
 
const CTitle LoadedTitle
 
const Text ServerLogin
 
const Text ServerName
 
const Text ServerModeName
 
const Text MapName
 
const CMap Map
 
const Text MapPlayerModelName
 
const CUser [] Users
 
const CTeam [] Teams
 
Text NeutralEmblemUrl
 
const Text ForcedClubLinkUrl1
 
const Text ForcedClubLinkUrl2
 
Text ClientManiaAppUrl
 
const Integer Now
 
const Integer Period
 
Boolean MatchEndRequested
 
const Boolean ServerShutdownRequested
 
const Boolean MapLoaded
 
const CMapInfo [] MapList
 
Integer NextMapIndex
 
const CUIConfigMgr UIManager
 
const CModulePlaygroundHud Hud
 
const Boolean Ladder_RequestInProgress
 
const CServerAdmin ServerAdmin
 
const Boolean Solo_NewRecordSequenceInProgress
 
const CXmlRpc XmlRpc
 
const CParsingManager Xml
 
const CHttpManager Http
 
const CInputManager Input
 
const CDataFileMgr DataFileMgr
 
const CScoreMgr ScoreMgr
 
const CSystemPlatform System
 
Boolean UseMinimap
 
Boolean Replay_AutoStart
 
const CAchievementsManager AchievementsManager
 
const CModeTurretManager TurretsManager
 
const CModeVehicleManager VehiclesManager
 
const CActionManager ActionsManager
 
- Public Attributes inherited from CNod
const Ident Id
 

Detailed Description

Supported declare modes : Local Persistent Rules API for gamemodes.

Member Enumeration Documentation

◆ EMedal

Enumerator
None 
Finished 
Bronze 
Silver 
Gold 
Author 

Member Function Documentation

◆ ActionList_Add()

Ident CMode::ActionList_Add ( Text  ActionName)

◆ ActionList_Begin() [1/2]

Void CMode::ActionList_Begin ( )

◆ ActionList_Begin() [2/2]

Boolean CMode::ActionList_Begin ( )

◆ ActionList_End()

Void CMode::ActionList_End ( )

◆ 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)

◆ Hud_Load()

Void CMode::Hud_Load ( Text  ModuleName)

◆ ItemList_Add()

Ident CMode::ItemList_Add ( Text  ModelName)

◆ 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.

◆ ItemList_Begin() [1/2]

Void CMode::ItemList_Begin ( )

◆ ItemList_Begin() [2/2]

Boolean 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)

◆ 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,
EMedal  PlayerScore 
)

◆ Synchro_AddBarrier()

Integer CMode::Synchro_AddBarrier ( )

◆ Synchro_BarrierReached()

Boolean CMode::Synchro_BarrierReached ( Integer  Barrier)

◆ 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

◆ AchievementsManager

const CAchievementsManager CMode::AchievementsManager

◆ ActionsManager

const CActionManager CMode::ActionsManager

◆ ClientManiaAppUrl

Text CMode::ClientManiaAppUrl

◆ DataFileMgr

const CDataFileMgr CMode::DataFileMgr

Only available for local solo modes.

◆ ForcedClubLinkUrl1

const Text CMode::ForcedClubLinkUrl1

◆ ForcedClubLinkUrl2

const Text CMode::ForcedClubLinkUrl2

◆ Http

const CHttpManager CMode::Http

◆ Hud

const CModulePlaygroundHud CMode::Hud

◆ Input

const CInputManager CMode::Input

Only available for local solo modes.

◆ Ladder_RequestInProgress

const Boolean CMode::Ladder_RequestInProgress

◆ LoadedTitle

const CTitle CMode::LoadedTitle

◆ Map

const CMap CMode::Map

◆ MapList

const CMapInfo [] CMode::MapList

◆ MapLoaded

const Boolean CMode::MapLoaded

◆ MapName

const Text CMode::MapName

◆ MapPlayerModelName

const Text CMode::MapPlayerModelName

◆ MatchEndRequested

Boolean CMode::MatchEndRequested

◆ ModeStatusMessage

Text CMode::ModeStatusMessage

◆ NeutralEmblemUrl

Text CMode::NeutralEmblemUrl

◆ NextMapIndex

Integer CMode::NextMapIndex

◆ Now

const Integer CMode::Now

◆ Period

const Integer CMode::Period

◆ Replay_AutoStart

Boolean CMode::Replay_AutoStart

◆ ScoreMgr

const CScoreMgr CMode::ScoreMgr

◆ ServerAdmin

const CServerAdmin CMode::ServerAdmin

◆ ServerLogin

const Text CMode::ServerLogin

◆ ServerModeName

const Text CMode::ServerModeName

◆ ServerName

const Text CMode::ServerName

◆ ServerShutdownRequested

const Boolean CMode::ServerShutdownRequested

◆ Solo_NewRecordSequenceInProgress

const Boolean CMode::Solo_NewRecordSequenceInProgress

◆ System

const CSystemPlatform CMode::System

◆ Teams

const CTeam [] CMode::Teams

◆ TurretsManager

const CModeTurretManager CMode::TurretsManager

◆ UIManager

const CUIConfigMgr CMode::UIManager

◆ UseMinimap

Boolean CMode::UseMinimap

◆ Users

const CUser [] CMode::Users

◆ VehiclesManager

const CModeVehicleManager CMode::VehiclesManager

◆ Xml

const CParsingManager CMode::Xml

◆ XmlRpc

const CXmlRpc CMode::XmlRpc