ManiaScript Reference  2019-05
CTitleControl Struct Reference
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, ModuleStudio, PixelArt, EditorEditor,
  VehicleAssembler, MaterialEditor
}
 

Public Member Functions

Void PlayMap (Text Map, Text Mode, Text SettingsXml)
 
Void PlayCampaign (CCampaign Campaign, CMapInfo MapInfo, Text Mode, Text SettingsXml)
 
Void PlayMapList (Text[] MapList, Text Mode, Text SettingsXml)
 
Void PlayMatchSettings (CMatchSettings MatchSettings, Text OverrideMode, Text OverrideSettingsXml)
 
Void PlaySplitScreen (ESplitScreenLayout LayoutType, Text[] MapList, Text Mode, Text SettingsXml)
 
Void PlayMultiOnSameScreen (Text[] MapList, Text Mode, Text SettingsXml)
 
Void PlaySplitScreen (ESplitScreenLayout LayoutType, CMatchSettings MatchSettings)
 
Void PlayMultiOnSameScreen (CMatchSettings MatchSettings)
 
Void ViewReplay (Text Replay)
 
Void OpenEditor (Text EditorName, Text MainPluginSettings)
 
Void OpenEditor (EEditorType EditorType)
 
Void EditSkins ()
 
Void EditReplay (Text[] ReplayList)
 
Void EditGhosts (Text Map)
 
Void EditAsset (Text EditorName, Text MainPluginSettingsXml, Text RelativeFileName)
 
Void EditMap (Text Map, Text EditorPluginScript, Text EditorPluginArgument)
 
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 EditNewMapFromBaseMap (Text BaseMapName, Text ModNameOrUrl, Text PlayerModel, Text MapType, Text EditorPluginScript, Text EditorPluginArgument)
 
Void EditBadges ()
 
Void PublishFile (Text FileName)
 
Void ProcessManiaCodeXml (Text ManiaCodeXml)
 
Void DiscoverLocalServers ()
 
Void CreateServer (Text ServerName, Text ServerComment, Integer MaxPlayerCount, Text Password, CMatchSettings MatchSettings, Text PasswordSpectators)
 
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

const Boolean IsReady
 
const EResult LatestResult
 
const Text CustomResultType
 
const Text [] CustomResultData
 
const Boolean CanPublishFiles
 
const CServerInfo [] LocalServers
 
const CServerInfo [] LocalServers_CurrentTitle
 
const CServerInfo GetServerInfo_Result
 
- Public Attributes inherited from CNod
const Ident Id
 

Detailed Description

API for titles menus to control the main loop.

Member Enumeration Documentation

◆ EEditorType

Enumerator
ActionMaker 
ChallengeEditor 
ItemEditor 
InterfaceDesigner 
MeshModeler 
ModuleStudio 
PixelArt 
EditorEditor 
VehicleAssembler 
MaterialEditor 

◆ 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 

◆ ESplitScreenLayout

Enumerator
Horizontal 
Vertical 
Four 

Member Function Documentation

◆ CreateServer() [1/2]

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

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

◆ EditBadges()

Void CTitleControl::EditBadges ( )

◆ EditGhosts()

Void CTitleControl::EditGhosts ( Text  Map)

◆ EditMap()

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

◆ EditNewMap() [1/2]

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

◆ EditNewMap() [2/2]

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

◆ EditNewMapFromBaseMap()

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

◆ EditReplay()

Void CTitleControl::EditReplay ( Text []  ReplayList)

◆ EditSkins()

Void CTitleControl::EditSkins ( )

◆ GetServerInfo() [1/2]

Void CTitleControl::GetServerInfo ( Text  ServerLogin)

Fetch the server info

◆ GetServerInfo() [2/2]

Void CTitleControl::GetServerInfo ( CServerInfo  LocalServer)

◆ 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 ( Text  EditorName,
Text  MainPluginSettings 
)

◆ OpenEditor() [2/2]

Void CTitleControl::OpenEditor ( EEditorType  EditorType)

◆ 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 ( Text []  MapList,
Text  Mode,
Text  SettingsXml 
)

◆ PlayMatchSettings()

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

◆ PlayMultiOnSameScreen() [1/2]

Void CTitleControl::PlayMultiOnSameScreen ( Text []  MapList,
Text  Mode,
Text  SettingsXml 
)

◆ PlayMultiOnSameScreen() [2/2]

Void CTitleControl::PlayMultiOnSameScreen ( CMatchSettings  MatchSettings)

◆ PlaySplitScreen() [1/2]

Void CTitleControl::PlaySplitScreen ( ESplitScreenLayout  LayoutType,
Text []  MapList,
Text  Mode,
Text  SettingsXml 
)

◆ PlaySplitScreen() [2/2]

Void CTitleControl::PlaySplitScreen ( 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

const Boolean CTitleControl::CanPublishFiles

◆ CustomResultData

const Text [] CTitleControl::CustomResultData

◆ CustomResultType

const Text CTitleControl::CustomResultType

◆ GetServerInfo_Result

const CServerInfo CTitleControl::GetServerInfo_Result

◆ IsReady

const Boolean CTitleControl::IsReady

Can a command be issued.

◆ LatestResult

const EResult CTitleControl::LatestResult

Result of the latest command issued.

◆ LocalServers

const CServerInfo [] CTitleControl::LocalServers

◆ LocalServers_CurrentTitle

const CServerInfo [] CTitleControl::LocalServers_CurrentTitle