CTitleControl Class Reference

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

#include <doc.h>

Inheritance diagram for CTitleControl:

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< Text >	CustomResultData
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.

Member Enumeration Documentation

EEditorType

enum CTitleControl::EEditorType

Enumerator
ActionMaker
ChallengeEditor
ItemEditor
InterfaceDesigner
MeshModeler

EReplayEditType

enum CTitleControl::EReplayEditType

Enumerator
None
Edit
View
Shoot

EResult

enum CTitleControl::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

enum CTitleControl::ESplitScreenLayout

Enumerator
Horizontal
Vertical
Four

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

CustomResultData

Array<Text> CTitleControl::CustomResultData

CustomResultType

Text const CTitleControl::CustomResultType

GetServerInfo_Result

CServerInfo* const CTitleControl::GetServerInfo_Result

IsReady

Boolean const CTitleControl::IsReady

Can a command be issued.

JoinServer_DisableSystemDialogs

Boolean CTitleControl::JoinServer_DisableSystemDialogs

LatestResult

CTitleControl::EResult const CTitleControl::LatestResult

Result of the latest command issued.

LocalServers

Array<CServerInfo* const > CTitleControl::LocalServers

LocalServers_CurrentTitle

Array<CServerInfo* const > CTitleControl::LocalServers_CurrentTitle

---

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

• doc.h