CDataFileMgr Struct Reference

#include <big.h>

Inheritance diagram for CDataFileMgr:

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

Public Member Functions
Void	TaskResult_Release (Ident TaskId)
CCampaign	Campaign_Get (Text CampaignId)
Void	Map_RefreshFromDisk ()
CTaskResult_MapList	Map_GetUserList (Ident UserId)
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)
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)
CTaskResult_GhostList	Replay_Load (Text Path)
CTaskResult	Replay_Save (Text Path, CMap Map, CGhost Ghost)
CTaskResult_FileList	Media_GetGameList (EMediaType Type, Text Path, Boolean Flatten)
CTaskResult_FileList	Media_GetGameList (EMediaType Type, Text Path, Boolean Flatten, Boolean SortByNameElseByDate, Boolean SortOrderAsc)
CTaskResult_FileList	Media_GetFilteredGameList (EMediaType Type, Integer Scope, Text Path, Boolean Flatten)
CTaskResult_GameModeList	GameMode_GetGameList (Integer Scope, Text Path, Boolean Flatten)
CTaskResult	Pack_DownloadOrUpdate (Text DisplayName, Text Url)

Public Attributes
const CTaskResult []	TaskResults
const CCampaign []	Campaigns
const CGhost []	Ghosts
Public Attributes inherited from CNod
const Ident	Id

Detailed Description

Script API to manage game data.

Member Enumeration Documentation

EMediaType

enum CDataFileMgr::EMediaType

Enumerator
Image
Sound
Script
MatchSettings
Module
Skins

Member Function Documentation

Campaign_Get()

CCampaign CDataFileMgr::Campaign_Get

(

Text

CampaignId

)

Get a campaign from its id.

GameMode_GetGameList()

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

Ghost_Download()

CTaskResult_Ghost CDataFileMgr::Ghost_Download	(	Text	FileName,
		Text	Url
	)

Ghost_Release()

Void CDataFileMgr::Ghost_Release

(

Ident

GhostId

)

Release a downloaded ghost no longer needed.

Ghost_Upload()

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

Map_GetFilteredGameList()

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

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

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.

Map_GetUserList()

CTaskResult_MapList CDataFileMgr::Map_GetUserList

(

Ident

UserId

)

Get the list of map stored in the user slot/dir.

Map_RefreshFromDisk()

Void CDataFileMgr::Map_RefreshFromDisk

(

)

Media_GetFilteredGameList()

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

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

Media_GetGameList() [1/2]

CTaskResult_FileList CDataFileMgr::Media_GetGameList	(	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	(	EMediaType	Type,
		Text	Path,
		Boolean	Flatten,
		Boolean	SortByNameElseByDate,
		Boolean	SortOrderAsc
	)

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

Pack_DownloadOrUpdate()

CTaskResult CDataFileMgr::Pack_DownloadOrUpdate	(	Text	DisplayName,
		Text	Url
	)

Replay_GetFilteredGameList()

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

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

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_RefreshFromDisk()

Void CDataFileMgr::Replay_RefreshFromDisk

(

)

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

const CCampaign [] CDataFileMgr::Campaigns

Array of campaigns.

Ghosts

const CGhost [] CDataFileMgr::Ghosts

Array of ghosts.

TaskResults

const CTaskResult [] CDataFileMgr::TaskResults

Array of task results.

---

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

• big.h