Script API to manage game data. More...

#include <doc.h>

Inheritance diagram for CDataFileMgr:

Public Types
enum	EMediaType { Image , Sound , Script , MatchSettings , Module , Skins , ItemCollection }

Public Member Functions
Void	TaskResult_Release (Ident TaskId)

CCampaign	Campaign_Get (Text CampaignId)

CTaskResult_NSItemCollection	ItemCollection_Create (Ident UserId, Text ClubId, Text DisplayName, Text FileName)

CTaskResult_NSItemCollection	ItemCollection_CreateVersion (Ident UserId, Text ItemCollectionId, Text FileName)

CTaskResult_NSItemCollection	ItemCollection_Get (Ident UserId, Text ItemCollectionId)

CTaskResult_NSItemCollectionList	ItemCollection_GetList (Ident UserId, Array< Text > ItemCollectionIdList)

CTaskResult_NSItemCollectionList	ItemCollection_GetListByUser (Ident UserId, Text WebServicesUserId)

CTaskResult_NSItemCollection	ItemCollection_SetActivityId (Ident UserId, Text ItemCollectionId, Text ActivityId)

CTaskResult_NSItemCollection	ItemCollection_Update (Ident UserId, Text ItemCollectionId, Text DisplayName)

CTaskResult	ItemCollection_AddFavorite (Ident UserId, Text ItemCollectionId)

CTaskResult_NSItemCollectionList	ItemCollection_GetFavoriteList (Ident UserId)

CTaskResult	ItemCollection_RemoveFavorite (Ident UserId, Text ItemCollectionId)

Void	Map_RefreshFromDisk ()

CTaskResult_MapList	Map_GetGameList (Text Path, Boolean Flatten)

CTaskResult_MapList	Map_GetGameList (Text Path, Boolean Flatten, Boolean SortByNameElseByDate, Boolean SortOrderAsc)

CTaskResult_MapList	Map_GetFilteredGameList (Integer Scope, Text Path, Boolean Flatten, Boolean SortByNameElseByDate, Boolean SortOrderAsc)

CGhost	Map_GetAuthorGhost (CMap Map)

CTaskResult_NSMap	Map_NadeoServices_Get (Ident UserId, Text MapId)

CTaskResult_NSMap	Map_NadeoServices_GetFromUid (Ident UserId, Text MapUid)

CTaskResult_NSMapList	Map_NadeoServices_GetList (Ident UserId, Array< Text > MapIdList)

CTaskResult_NSMapList	Map_NadeoServices_GetListFromUid (Ident UserId, Array< Text > MapUidList)

CTaskResult_NSMapList	Map_NadeoServices_GetListFromUser (Ident UserId, Text WebServicesUserId)

CTaskResult_NSMap	Map_NadeoServices_Register (Ident UserId, Text MapUid)

CTaskResult_NSSkin	Skin_NadeoServices_Get (Ident UserId, Text SkinId)

CTaskResult_NSSkin	Skin_NadeoServices_GetFromChecksum (Ident UserId, Text SkinChecksum)

CTaskResult_NSSkinList	Skin_NadeoServices_GetList (Ident UserId, Array< Text > SkinIdList)

CTaskResult_NSSkinList	Skin_NadeoServices_GetListFromChecksum (Ident UserId, Array< Text > SkinChecksumList)

CTaskResult_NSSkinList	Skin_NadeoServices_GetListFromUser (Ident UserId, Text WebServicesUserId)

CTaskResult_NSSkin	Skin_NadeoServices_Register (Ident UserId, Text SkinDisplayName, Text SkinFileName)

CTaskResult	AccountSkin_NadeoServices_AddFavorite (Ident UserId, Text SkinId)

CTaskResult_NSSkinList	AccountSkin_NadeoServices_GetFavoriteList (Ident UserId)

CTaskResult_NSSkinList	AccountSkin_NadeoServices_GetList (Ident UserId)

CTaskResult_NSSkinList	AccountSkin_NadeoServices_GetListForUser (Ident UserId, Text WebServicesUserId)

CTaskResult	AccountSkin_NadeoServices_RemoveFavorite (Ident UserId, Text SkinId)

CTaskResult_NSSkin	AccountSkin_NadeoServices_Set (Ident UserId, Text SkinId)

CTaskResult	AccountSkin_NadeoServices_Unset (Ident UserId, Text SkinType)

Void	Ghost_Release (Ident GhostId)

CTaskResult_Ghost	Ghost_Download (Text FileName, Text Url)

CTaskResult	Ghost_Upload (Text Url, CGhost Ghost, Text AdditionalHeaders)

Void	Replay_RefreshFromDisk ()

CTaskResult_ReplayList	Replay_GetGameList (Text Path, Boolean Flatten)

CTaskResult_ReplayList	Replay_GetGameList (Text Path, Boolean Flatten, Boolean SortByNameElseByDate, Boolean SortOrderAsc)

CTaskResult_ReplayList	Replay_GetFilteredGameList (Integer Scope, Text Path, Boolean Flatten, Boolean SortByNameElseByDate, Boolean SortOrderAsc)

CTaskResult_GhostList	Replay_Load (Text Path)

CTaskResult	Replay_Save (Text Path, CMap Map, CGhost Ghost)

CTaskResult	Replay_Author_Save (CMap Map, CGhost Ghost)

CTaskResult_FileList	Media_GetGameList (CDataFileMgr::EMediaType Type, Text Path, Boolean Flatten)

CTaskResult_FileList	Media_GetGameList (CDataFileMgr::EMediaType Type, Text Path, Boolean Flatten, Boolean SortByNameElseByDate, Boolean SortOrderAsc)

CTaskResult_FileList	Media_GetFilteredGameList (CDataFileMgr::EMediaType Type, Integer Scope, Text Path, Boolean Flatten, Boolean SortByNameElseByDate, Boolean SortOrderAsc)

Void	Media_RefreshFromDisk (CDataFileMgr::EMediaType Type, Integer Scope)

CTaskResult_GameModeList	GameMode_GetGameList (Integer Scope, Text Path, Boolean Flatten)

CTaskResult	Pack_DownloadOrUpdate (Text DisplayName, Text Url)

CTaskResult	UserSave_DeleteFile (Text Path)

Public Attributes
Array< CTaskResult *const >	TaskResults

Array< CCampaign *const >	Campaigns

Array< CGhost *const >	Ghosts

Integer const	UserSave_AvailableSpace

Boolean const	UserSave_IsWriting

Public Attributes inherited from CNod
Ident const	Id

Detailed Description

Script API to manage game data.

Member Function Documentation

◆ Campaign_Get()

CCampaign CDataFileMgr::Campaign_Get ( Text CampaignId )

Get a campaign from its id.

◆ Ghost_Release()

Void CDataFileMgr::Ghost_Release ( Ident GhostId )

Release a downloaded ghost no longer needed.

◆ Map_GetFilteredGameList()

CTaskResult_MapList CDataFileMgr::Map_GetFilteredGameList	(	Integer	Scope,
		Text	Path,
		Boolean	Flatten,
		Boolean	SortByNameElseByDate,
		Boolean	SortOrderAsc )

Get the list of map stored in the specified path. Scope is used to specify if the list is retrieved from game data (1), title data (2) or user data (4), which can be added).

◆ Map_GetGameList() [1/2]

CTaskResult_MapList CDataFileMgr::Map_GetGameList	(	Text	Path,
		Boolean	Flatten )

Get the list of map stored in the specified path.

◆ Map_GetGameList() [2/2]

CTaskResult_MapList CDataFileMgr::Map_GetGameList	(	Text	Path,
		Boolean	Flatten,
		Boolean	SortByNameElseByDate,
		Boolean	SortOrderAsc )

Get the list of map stored according to the filters in the specified path.

◆ Media_GetFilteredGameList()

CTaskResult_FileList CDataFileMgr::Media_GetFilteredGameList	(	CDataFileMgr::EMediaType	Type,
		Integer	Scope,
		Text	Path,
		Boolean	Flatten,
		Boolean	SortByNameElseByDate,
		Boolean	SortOrderAsc )

Get the list of media stored in the specified path. Scope is used to specify if the list is retrieved from game data (1), title data (2) or user data (4), which can be added.

◆ Media_GetGameList() [1/2]

CTaskResult_FileList CDataFileMgr::Media_GetGameList	(	CDataFileMgr::EMediaType	Type,
		Text	Path,
		Boolean	Flatten )

Get the list of media stored in the specified path.

◆ Media_GetGameList() [2/2]

CTaskResult_FileList CDataFileMgr::Media_GetGameList	(	CDataFileMgr::EMediaType	Type,
		Text	Path,
		Boolean	Flatten,
		Boolean	SortByNameElseByDate,
		Boolean	SortOrderAsc )

Get the list of media stored according to the filters in the specified path.

◆ Media_RefreshFromDisk()

Void CDataFileMgr::Media_RefreshFromDisk	(	CDataFileMgr::EMediaType	Type,
		Integer	Scope )

Refresh the list of media stored in the specified path. Scope is used to specify if the list is retrieved from game data (1), title data (2) or user data (4), which can be added.

◆ Replay_GetFilteredGameList()

CTaskResult_ReplayList CDataFileMgr::Replay_GetFilteredGameList	(	Integer	Scope,
		Text	Path,
		Boolean	Flatten,
		Boolean	SortByNameElseByDate,
		Boolean	SortOrderAsc )

Get the list of replay stored in the specified path. Scope is used to specify if the list is retrieved from game data (1), title data (2) or user data (4), which can be added.

◆ Replay_GetGameList() [1/2]

CTaskResult_ReplayList CDataFileMgr::Replay_GetGameList	(	Text	Path,
		Boolean	Flatten )

Get the list of replay stored in the specified path.

◆ Replay_GetGameList() [2/2]

CTaskResult_ReplayList CDataFileMgr::Replay_GetGameList	(	Text	Path,
		Boolean	Flatten,
		Boolean	SortByNameElseByDate,
		Boolean	SortOrderAsc )

Get the list of replay stored according to the filters in the specified path.

◆ Replay_Load()

CTaskResult_GhostList CDataFileMgr::Replay_Load ( Text Path )

Get the list of ghosts from the replay stored at the specified file path.

◆ Replay_Save()

CTaskResult CDataFileMgr::Replay_Save	(	Text	Path,
		CMap	Map,
		CGhost	Ghost )

Save the map and the ghost into a replay file stored at the specified path.

◆ TaskResult_Release()

Void CDataFileMgr::TaskResult_Release ( Ident TaskId )

Release a task result no more used.

Member Data Documentation

◆ Campaigns

Array<CCampaign* const > CDataFileMgr::Campaigns

Array of campaigns.

◆ Ghosts

Array<CGhost* const > CDataFileMgr::Ghosts

Array of ghosts.

◆ TaskResults

Array<CTaskResult* const > CDataFileMgr::TaskResults

Array of task results.

◆ UserSave_AvailableSpace

Integer const CDataFileMgr::UserSave_AvailableSpace

Available space for user files, in kilobytes. (clamped to 1Gb)

◆ UserSave_IsWriting

Boolean const CDataFileMgr::UserSave_IsWriting

Background write to usersave in progress. Do not switch off the console.

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

doc.h

Public Types

Public Member Functions

Public Attributes