API for titles in edition mode. More...

#include <doc.h>

Inheritance diagram for CTitleEdition:

Public Types
enum	EDrive { TitleReadable , Title , User }

Public Member Functions
Void	File_ImportFromUser (Text FileName)

Void	File_Move (Text OrigName, Text DestNameOrFolder, Boolean KeepOriginalCopy)

Boolean	File_Exists (Text FileName, CTitleEdition::EDrive InDrive)

Void	File_Delete (Text Name)

Void	File_WriteText (Text FileName, Text Text)

Text	File_ReadText (Text FileName)

Void	Dialog_ImportFiles ()

Void	OpenTitleFolderInExplorer ()

Void	ReloadTitleDesc ()

Void	SaveTitleDesc ()

Void	SetTitleCampaign (Integer CampaignNum, Text ScoreContext, Text MapsFolderNameOrPlayListName, Boolean OfficialRecordEnabled)

Void	SetTitleCampaign (Integer CampaignNum, Text ScoreContext, Text MapsFolderNameOrPlayListName, Boolean OfficialRecordEnabled, Boolean DisableUnlockSystem)

Public Attributes
CTitle *const	TitleMaker

CPackCreator *const	PackCreator

Text const	EditedTitleId

CPackCreatorTitleInfo *const	EditedTitleInfo

Boolean const	Dialog_IsFinished

Boolean const	Dialog_Success

Boolean const	Dialog_Aborted

Public Attributes inherited from CNod
Ident const	Id

Detailed Description

API for titles in edition mode.

Member Enumeration Documentation

◆ EDrive

enum CTitleEdition::EDrive

Enumerator
TitleReadable
Title
User

Member Function Documentation

◆ Dialog_ImportFiles()

Void CTitleEdition::Dialog_ImportFiles ( )

◆ File_Delete()

Void CTitleEdition::File_Delete ( Text Name )

◆ File_Exists()

Boolean CTitleEdition::File_Exists	(	Text	FileName,
		CTitleEdition::EDrive	InDrive )

◆ File_ImportFromUser()

Void CTitleEdition::File_ImportFromUser ( Text FileName )

Will copy file 'FileName' from the UserDir to the TitleDir, including its dependencies.

◆ File_Move()

Void CTitleEdition::File_Move	(	Text	OrigName,
		Text	DestNameOrFolder,
		Boolean	KeepOriginalCopy )

Will move or copy file 'OrigName' to 'DestName'. If DestName is a '\' terminated folder path, keeps the orginial short name.

◆ File_ReadText()

Text CTitleEdition::File_ReadText ( Text FileName )

◆ File_WriteText()

Void CTitleEdition::File_WriteText	(	Text	FileName,
		Text	Text )

◆ OpenTitleFolderInExplorer()

Void CTitleEdition::OpenTitleFolderInExplorer ( )

◆ ReloadTitleDesc()

Void CTitleEdition::ReloadTitleDesc ( )

◆ SaveTitleDesc()

Void CTitleEdition::SaveTitleDesc ( )

◆ SetTitleCampaign() [1/2]

Void CTitleEdition::SetTitleCampaign	(	Integer	CampaignNum,
		Text	ScoreContext,
		Text	MapsFolderNameOrPlayListName,
		Boolean	OfficialRecordEnabled )

nb: The maps from the campaign are automatically added to the pack, no need to Build_AddFile().

◆ SetTitleCampaign() [2/2]

Void CTitleEdition::SetTitleCampaign	(	Integer	CampaignNum,
		Text	ScoreContext,
		Text	MapsFolderNameOrPlayListName,
		Boolean	OfficialRecordEnabled,
		Boolean	DisableUnlockSystem )

Member Data Documentation

◆ Dialog_Aborted

Boolean const CTitleEdition::Dialog_Aborted

◆ Dialog_IsFinished

Boolean const CTitleEdition::Dialog_IsFinished

◆ Dialog_Success

Boolean const CTitleEdition::Dialog_Success

◆ EditedTitleId

Text const CTitleEdition::EditedTitleId

◆ EditedTitleInfo

CPackCreatorTitleInfo* const CTitleEdition::EditedTitleInfo

◆ PackCreator

CPackCreator* const CTitleEdition::PackCreator

PackCreator - only available when the title author is the current logged user.

◆ TitleMaker

CTitle* const CTitleEdition::TitleMaker

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

doc.h

Public Types

Public Member Functions

Public Attributes