ManiaScript  2019-10-10
The script language used in ManiaPlanet gaming system
Public Types | Public Member Functions | Public Attributes | List of all members
CTitleEdition Struct Reference

#include <big.h>

Inheritance diagram for CTitleEdition:
CNod

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, 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

const CTitle TitleMaker
 
const CPackCreator PackCreator
 
const Text EditedTitleId
 
const CPackCreatorTitleInfo EditedTitleInfo
 
const Boolean Dialog_IsFinished
 
const Boolean Dialog_Success
 
const Boolean Dialog_Aborted
 
- Public Attributes inherited from CNod
const Ident Id
 

Detailed Description

API for titles in edition mode.

Member Enumeration Documentation

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

const Boolean CTitleEdition::Dialog_Aborted

◆ Dialog_IsFinished

const Boolean CTitleEdition::Dialog_IsFinished

◆ Dialog_Success

const Boolean CTitleEdition::Dialog_Success

◆ EditedTitleId

const Text CTitleEdition::EditedTitleId

◆ EditedTitleInfo

const CPackCreatorTitleInfo CTitleEdition::EditedTitleInfo

◆ PackCreator

const CPackCreator CTitleEdition::PackCreator

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

◆ TitleMaker

const CTitle CTitleEdition::TitleMaker

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