ManiaScript Trackmania 2020  30/10/2024
CTitleControl Class Reference

API for titles menus to control the main loop. More...

#include <2024_10_30.h>

Inheritance diagram for CTitleControl:
CNod

Public Types

enum  ESplitScreenLayout { Horizontal, Vertical, Four }
 
enum  EResult {
  Success, Error_Internal, Error_DataMgr, Error_Net_ServerNotFound,
  Error_Net_ServerUnreachable, Error_Net_Disconnected, Error_Net_WrongPassword, Error_Network_OnlineExpired,
  Error_Network_ServerFull, Error_Abort
}
 
enum  EEditorType {
  ActionMaker, ChallengeEditor, ItemEditor, InterfaceDesigner,
  MeshModeler
}
 
enum  EReplayEditType { None, Edit, View, Shoot }
 

Public Member Functions

Void PlayMap (Text Map, Text Mode, Text SettingsXml)
 
Void PlayCampaign (CCampaign Campaign, CMapInfo MapInfo, Text Mode, Text SettingsXml)
 
Void PlayMapList (Array< Text > MapList, Text Mode, Text SettingsXml)
 
Void PlayMatchSettings (CMatchSettings MatchSettings, Text OverrideMode, Text OverrideSettingsXml)
 
Void PlayAgainstReplay (Text Replay, Text Mode, Text SettingsXml)
 
Void PlaySplitScreen (CTitleControl::ESplitScreenLayout LayoutType, Array< Text > MapList, Text Mode, Text SettingsXml)
 
Void PlayMultiOnSameScreen (Array< Text > MapList, Text Mode, Text SettingsXml)
 
Void PlaySplitScreen (CTitleControl::ESplitScreenLayout LayoutType, CMatchSettings MatchSettings)
 
Void PlayMultiOnSameScreen (CMatchSettings MatchSettings)
 
Void ViewReplay (Text Replay)
 
Void OpenEditor (Text EditorName, Text MainPluginSettings)
 
Void OpenEditor (CTitleControl::EEditorType EditorType)
 
Void EditSkins ()
 
Void EditSkinsFromFileName (Text SkinFilePath)
 
Void EditReplay (Array< Text > ReplayList)
 
Void EditReplay (Array< Text > ReplayList, CTitleControl::EReplayEditType EditType)
 
Void EditGhosts (Text Map)
 
Void EditAsset (Text EditorName, Text MainPluginSettingsXml, Text RelativeFileName)
 
Void EditMap (Text Map, Text EditorPluginScript, Text EditorPluginArgument)
 
Void EditMap (Text Map, Text Decoration, Text ModNameOrUrl, Text PlayerModel, Text EditorPluginScript, Text EditorPluginArgument)
 
Void EditMap (Text Map, Text Decoration, Text ModNameOrUrl, Text PlayerModel, Text EditorPluginScript, Text EditorPluginArgument, Boolean UpgradeToAdvancedEditor)
 
Void EditMap (Text Map, Text Decoration, Text ModNameOrUrl, Text PlayerModel, Array< Text > EditorPluginsScripts, Array< Text > EditorPluginsArguments, Boolean UpgradeToAdvancedEditor)
 
Void EditMap (Text Map, Text Decoration, Text ModNameOrUrl, Text PlayerModel, Array< Text > EditorPluginsScripts, Array< Text > EditorPluginsArguments, Boolean UpgradeToAdvancedEditor, Boolean OnlyUseForcedPlugins)
 
Void EditNewMap (Text Environment, Text Decoration, Text ModNameOrUrl, Text PlayerModel, Text MapType, Text EditorPluginScript, Text EditorPluginArgument)
 
Void EditNewMap (Text Environment, Text Decoration, Text ModNameOrUrl, Text PlayerModel, Text MapType, Boolean UseSimpleEditor, Text EditorPluginScript, Text EditorPluginArgument)
 
Void EditNewMap (Text Environment, Text Decoration, Text ModNameOrUrl, Text PlayerModel, Text MapType, Boolean UseSimpleEditor, Array< Text > EditorPluginsScripts, Array< Text > EditorPluginsArguments)
 
Void EditNewMap (Text Environment, Text Decoration, Text ModNameOrUrl, Text PlayerModel, Text MapType, Boolean UseSimpleEditor, Array< Text > EditorPluginsScripts, Array< Text > EditorPluginsArguments, Boolean OnlyUseForcedPlugins)
 
Void EditNewMapFromBaseMap (Text BaseMapName, Text ModNameOrUrl, Text PlayerModel, Text MapType, Text EditorPluginScript, Text EditorPluginArgument)
 
Void EditNewMapFromBaseMap (Text BaseMapName, Text Decoration, Text ModNameOrUrl, Text PlayerModel, Text MapType, Text EditorPluginScript, Text EditorPluginArgument)
 
Void EditNewMapFromBaseMap (Text BaseMapName, Text Decoration, Text ModNameOrUrl, Text PlayerModel, Text MapType, Array< Text > EditorPluginsScripts, Array< Text > EditorPluginsArguments, Boolean OnlyUseForcedPlugins)
 
Void PublishFile (Text FileName)
 
Void ProcessManiaCodeXml (Text ManiaCodeXml)
 
Void DiscoverLocalServers ()
 
Void CreateServer (Text ServerName, Text ServerComment, Integer MaxPlayerCount, Text Password, Text PasswordSpectators, CMatchSettings MatchSettings)
 
Void CreateServer (Text ServerName, Text ServerComment, Integer MaxPlayerCount, Text Password, Text PasswordSpectators, CMatchSettings MatchSettings, Boolean LocalOnly)
 
Void GetServerInfo (Text ServerLogin)
 
Void GetServerInfo (CServerInfo LocalServer)
 
Void GetServerInfo_Abort ()
 
Void Join_GetServerInfo_Result (Boolean AsSpectator, Text Password)
 
Void JoinServer (Text ServerLogin, Boolean AsSpectator, Text Password)
 
Void Quit ()
 

Public Attributes

Boolean const IsReady
 
CTitleControl::EResult const LatestResult
 
Text const CustomResultType
 
Array< TextCustomResultData
 
Boolean const CanPublishFiles
 
Array< CServerInfo *const > LocalServers
 
Array< CServerInfo *const > LocalServers_CurrentTitle
 
CServerInfo *const GetServerInfo_Result
 
Boolean JoinServer_DisableSystemDialogs
 
- Public Attributes inherited from CNod
Ident const Id
 

Detailed Description

API for titles menus to control the main loop.

Definition at line 13137 of file 2024_10_30.h.

Member Enumeration Documentation

◆ EEditorType

Enumerator
ActionMaker 
ChallengeEditor 
ItemEditor 
InterfaceDesigner 
MeshModeler 

Definition at line 13165 of file 2024_10_30.h.

13165  {
13166  ActionMaker,
13168  ItemEditor,
13170  MeshModeler,
13171  };

◆ EReplayEditType

Enumerator
None 
Edit 
View 
Shoot 

Definition at line 13175 of file 2024_10_30.h.

13175  {
13176  None,
13177  Edit,
13178  View,
13179  Shoot,
13180  };

◆ EResult

Enumerator
Success 
Error_Internal 
Error_DataMgr 
Error_Net_ServerNotFound 
Error_Net_ServerUnreachable 
Error_Net_Disconnected 
Error_Net_WrongPassword 
Error_Network_OnlineExpired 
Error_Network_ServerFull 
Error_Abort 

Definition at line 13150 of file 2024_10_30.h.

◆ ESplitScreenLayout

Enumerator
Horizontal 
Vertical 
Four 

Definition at line 13142 of file 2024_10_30.h.

13142  {
13143  Horizontal,
13144  Vertical,
13145  Four,
13146  };

Member Function Documentation

◆ CreateServer() [1/2]

Void CTitleControl::CreateServer ( Text  ServerName,
Text  ServerComment,
Integer  MaxPlayerCount,
Text  Password,
Text  PasswordSpectators,
CMatchSettings  MatchSettings 
)

◆ CreateServer() [2/2]

Void CTitleControl::CreateServer ( Text  ServerName,
Text  ServerComment,
Integer  MaxPlayerCount,
Text  Password,
Text  PasswordSpectators,
CMatchSettings  MatchSettings,
Boolean  LocalOnly 
)

◆ DiscoverLocalServers()

Void CTitleControl::DiscoverLocalServers ( )

◆ EditAsset()

Void CTitleControl::EditAsset ( Text  EditorName,
Text  MainPluginSettingsXml,
Text  RelativeFileName 
)

◆ EditGhosts()

Void CTitleControl::EditGhosts ( Text  Map)

◆ EditMap() [1/5]

Void CTitleControl::EditMap ( Text  Map,
Text  Decoration,
Text  ModNameOrUrl,
Text  PlayerModel,
Array< Text EditorPluginsScripts,
Array< Text EditorPluginsArguments,
Boolean  UpgradeToAdvancedEditor 
)

◆ EditMap() [2/5]

Void CTitleControl::EditMap ( Text  Map,
Text  Decoration,
Text  ModNameOrUrl,
Text  PlayerModel,
Array< Text EditorPluginsScripts,
Array< Text EditorPluginsArguments,
Boolean  UpgradeToAdvancedEditor,
Boolean  OnlyUseForcedPlugins 
)

◆ EditMap() [3/5]

Void CTitleControl::EditMap ( Text  Map,
Text  Decoration,
Text  ModNameOrUrl,
Text  PlayerModel,
Text  EditorPluginScript,
Text  EditorPluginArgument 
)

◆ EditMap() [4/5]

Void CTitleControl::EditMap ( Text  Map,
Text  Decoration,
Text  ModNameOrUrl,
Text  PlayerModel,
Text  EditorPluginScript,
Text  EditorPluginArgument,
Boolean  UpgradeToAdvancedEditor 
)

◆ EditMap() [5/5]

Void CTitleControl::EditMap ( Text  Map,
Text  EditorPluginScript,
Text  EditorPluginArgument 
)

◆ EditNewMap() [1/4]

Void CTitleControl::EditNewMap ( Text  Environment,
Text  Decoration,
Text  ModNameOrUrl,
Text  PlayerModel,
Text  MapType,
Boolean  UseSimpleEditor,
Array< Text EditorPluginsScripts,
Array< Text EditorPluginsArguments 
)

◆ EditNewMap() [2/4]

Void CTitleControl::EditNewMap ( Text  Environment,
Text  Decoration,
Text  ModNameOrUrl,
Text  PlayerModel,
Text  MapType,
Boolean  UseSimpleEditor,
Array< Text EditorPluginsScripts,
Array< Text EditorPluginsArguments,
Boolean  OnlyUseForcedPlugins 
)

◆ EditNewMap() [3/4]

Void CTitleControl::EditNewMap ( Text  Environment,
Text  Decoration,
Text  ModNameOrUrl,
Text  PlayerModel,
Text  MapType,
Boolean  UseSimpleEditor,
Text  EditorPluginScript,
Text  EditorPluginArgument 
)

◆ EditNewMap() [4/4]

Void CTitleControl::EditNewMap ( Text  Environment,
Text  Decoration,
Text  ModNameOrUrl,
Text  PlayerModel,
Text  MapType,
Text  EditorPluginScript,
Text  EditorPluginArgument 
)

◆ EditNewMapFromBaseMap() [1/3]

Void CTitleControl::EditNewMapFromBaseMap ( Text  BaseMapName,
Text  Decoration,
Text  ModNameOrUrl,
Text  PlayerModel,
Text  MapType,
Array< Text EditorPluginsScripts,
Array< Text EditorPluginsArguments,
Boolean  OnlyUseForcedPlugins 
)

◆ EditNewMapFromBaseMap() [2/3]

Void CTitleControl::EditNewMapFromBaseMap ( Text  BaseMapName,
Text  Decoration,
Text  ModNameOrUrl,
Text  PlayerModel,
Text  MapType,
Text  EditorPluginScript,
Text  EditorPluginArgument 
)

◆ EditNewMapFromBaseMap() [3/3]

Void CTitleControl::EditNewMapFromBaseMap ( Text  BaseMapName,
Text  ModNameOrUrl,
Text  PlayerModel,
Text  MapType,
Text  EditorPluginScript,
Text  EditorPluginArgument 
)

◆ EditReplay() [1/2]

Void CTitleControl::EditReplay ( Array< Text ReplayList)

◆ EditReplay() [2/2]

Void CTitleControl::EditReplay ( Array< Text ReplayList,
CTitleControl::EReplayEditType  EditType 
)

◆ EditSkins()

Void CTitleControl::EditSkins ( )

◆ EditSkinsFromFileName()

Void CTitleControl::EditSkinsFromFileName ( Text  SkinFilePath)

◆ GetServerInfo() [1/2]

Void CTitleControl::GetServerInfo ( CServerInfo  LocalServer)

◆ GetServerInfo() [2/2]

Void CTitleControl::GetServerInfo ( Text  ServerLogin)

Fetch the server info, from the account id, or 'IP:xxx.xxx.xxx.xxx' with LAN ip

◆ GetServerInfo_Abort()

Void CTitleControl::GetServerInfo_Abort ( )

◆ Join_GetServerInfo_Result()

Void CTitleControl::Join_GetServerInfo_Result ( Boolean  AsSpectator,
Text  Password 
)

◆ JoinServer()

Void CTitleControl::JoinServer ( Text  ServerLogin,
Boolean  AsSpectator,
Text  Password 
)

Join a server

◆ OpenEditor() [1/2]

Void CTitleControl::OpenEditor ( CTitleControl::EEditorType  EditorType)

◆ OpenEditor() [2/2]

Void CTitleControl::OpenEditor ( Text  EditorName,
Text  MainPluginSettings 
)

◆ PlayAgainstReplay()

Void CTitleControl::PlayAgainstReplay ( Text  Replay,
Text  Mode,
Text  SettingsXml 
)

◆ PlayCampaign()

Void CTitleControl::PlayCampaign ( CCampaign  Campaign,
CMapInfo  MapInfo,
Text  Mode,
Text  SettingsXml 
)

◆ PlayMap()

Void CTitleControl::PlayMap ( Text  Map,
Text  Mode,
Text  SettingsXml 
)

◆ PlayMapList()

Void CTitleControl::PlayMapList ( Array< Text MapList,
Text  Mode,
Text  SettingsXml 
)

◆ PlayMatchSettings()

Void CTitleControl::PlayMatchSettings ( CMatchSettings  MatchSettings,
Text  OverrideMode,
Text  OverrideSettingsXml 
)

◆ PlayMultiOnSameScreen() [1/2]

Void CTitleControl::PlayMultiOnSameScreen ( Array< Text MapList,
Text  Mode,
Text  SettingsXml 
)

◆ PlayMultiOnSameScreen() [2/2]

Void CTitleControl::PlayMultiOnSameScreen ( CMatchSettings  MatchSettings)

◆ PlaySplitScreen() [1/2]

Void CTitleControl::PlaySplitScreen ( CTitleControl::ESplitScreenLayout  LayoutType,
Array< Text MapList,
Text  Mode,
Text  SettingsXml 
)

◆ PlaySplitScreen() [2/2]

Void CTitleControl::PlaySplitScreen ( CTitleControl::ESplitScreenLayout  LayoutType,
CMatchSettings  MatchSettings 
)

◆ ProcessManiaCodeXml()

Void CTitleControl::ProcessManiaCodeXml ( Text  ManiaCodeXml)

◆ PublishFile()

Void CTitleControl::PublishFile ( Text  FileName)

Set FileName='' to open a file select dialog.

◆ Quit()

Void CTitleControl::Quit ( )

◆ ViewReplay()

Void CTitleControl::ViewReplay ( Text  Replay)

Member Data Documentation

◆ CanPublishFiles

Boolean const CTitleControl::CanPublishFiles

Definition at line 13320 of file 2024_10_30.h.

◆ CustomResultData

Array<Text> CTitleControl::CustomResultData

Definition at line 13196 of file 2024_10_30.h.

◆ CustomResultType

Text const CTitleControl::CustomResultType

Definition at line 13192 of file 2024_10_30.h.

◆ GetServerInfo_Result

CServerInfo* const CTitleControl::GetServerInfo_Result

Definition at line 13364 of file 2024_10_30.h.

◆ IsReady

Boolean const CTitleControl::IsReady

Can a command be issued.

Definition at line 13184 of file 2024_10_30.h.

◆ JoinServer_DisableSystemDialogs

Boolean CTitleControl::JoinServer_DisableSystemDialogs

Definition at line 13376 of file 2024_10_30.h.

◆ LatestResult

CTitleControl::EResult const CTitleControl::LatestResult

Result of the latest command issued.

Definition at line 13188 of file 2024_10_30.h.

◆ LocalServers

Array<CServerInfo* const > CTitleControl::LocalServers

Definition at line 13332 of file 2024_10_30.h.

◆ LocalServers_CurrentTitle

Array<CServerInfo* const > CTitleControl::LocalServers_CurrentTitle

Definition at line 13336 of file 2024_10_30.h.


The documentation for this class was generated from the following file:
CTitleControl::ChallengeEditor
@ ChallengeEditor
Definition: 2024_10_30.h:13167
CTitleControl::Horizontal
@ Horizontal
Definition: 2024_10_30.h:13143
CTitleControl::Error_Net_WrongPassword
@ Error_Net_WrongPassword
Definition: 2024_10_30.h:13157
CTitleControl::Error_Internal
@ Error_Internal
Definition: 2024_10_30.h:13152
CTitleControl::InterfaceDesigner
@ InterfaceDesigner
Definition: 2024_10_30.h:13169
CTitleControl::Four
@ Four
Definition: 2024_10_30.h:13145
CTitleControl::ActionMaker
@ ActionMaker
Definition: 2024_10_30.h:13166
CTitleControl::MeshModeler
@ MeshModeler
Definition: 2024_10_30.h:13170
CTitleControl::Error_Net_ServerUnreachable
@ Error_Net_ServerUnreachable
Definition: 2024_10_30.h:13155
CTitleControl::Error_DataMgr
@ Error_DataMgr
Definition: 2024_10_30.h:13153
CTitleControl::Success
@ Success
Definition: 2024_10_30.h:13151
CTitleControl::None
@ None
Definition: 2024_10_30.h:13176
CTitleControl::Error_Abort
@ Error_Abort
Definition: 2024_10_30.h:13160
CTitleControl::Error_Net_Disconnected
@ Error_Net_Disconnected
Definition: 2024_10_30.h:13156
CTitleControl::Error_Network_OnlineExpired
@ Error_Network_OnlineExpired
Definition: 2024_10_30.h:13158
CTitleControl::Vertical
@ Vertical
Definition: 2024_10_30.h:13144
CTitleControl::Edit
@ Edit
Definition: 2024_10_30.h:13177
CTitleControl::Shoot
@ Shoot
Definition: 2024_10_30.h:13179
CTitleControl::Error_Net_ServerNotFound
@ Error_Net_ServerNotFound
Definition: 2024_10_30.h:13154
CTitleControl::View
@ View
Definition: 2024_10_30.h:13178
CTitleControl::Error_Network_ServerFull
@ Error_Network_ServerFull
Definition: 2024_10_30.h:13159
CTitleControl::ItemEditor
@ ItemEditor
Definition: 2024_10_30.h:13168