Inheritance diagram for Revision:

Public Member Functions
void	~Revision ()

proto external bool	IsCorrupted ()
	Returns true if any local files are corrupted or missing. DownloadableItem.VerifyIntegrity() needs to be called first.

proto external bool	IsDownloaded ()
	Returns true if this specific revision is already downloaded.

proto external string	GetVersion ()
	Returns version of asset as string.

proto external void	GetVersionArray (out notnull array< int > version)
	Returns version of asset as array.

proto external string	GetGameVersion ()
	Returns game version on which asset was uploaded as string.

proto external void	GetGameVersionArray (out notnull array< int > version)
	Returns game version on which asset was uploaded as array.

proto external void	LoadDependencies (BackendCallback pCallback)
	Request list of all dependencies for this Revision.

proto external int	GetDependencies (out notnull array< Dependency > dependencies)
	Will insert all instances of Dependency for this revision into outputDependencies.

proto external void	LoadScenarios (BackendCallback pCallback)
	Request list of all scenarios for this Revision.

proto external int	GetScenarios (out notnull array< MissionWorkshopItem > scenarios)
	Will insert all instances of MissionWorkshopItem for this revision into scenarios.

proto external void	LoadChangelog (BackendCallback pCallback)
	Request changelog for this Revision.

proto external string	ChangeLog ()
	Returns changelog of this Revision.

proto external float	GetTotalSize ()
	Returns total size of this revision.

proto external float	GetSizeBytes ()

proto external void	ComputePatchSize (BackendCallback pCallback)
	Will request download of manifests for this Revision to compute patch sizes.

proto bool	GetPatchSize (out float size)
	Get size of update patch from currently downloaded revision to this revision in bytes.

proto external int	GetFiles (out notnull array< string > aFiles)
	Get array containing names of all files in this Revision.

proto external int	CompareTo (Revision rev)
	Compare this Revision to another one.

proto external int	GetLoadFlags ()
	Describes which data are not loaded yet.

proto external ERevisionAvailability	GetAvailability ()
	Returns availability status of this Revision as enum ERevisionAvailability().

Public Member Functions inherited from Managed
proto external ref Managed	Clone ()
	Return shallow copy of object, or null if it is not allowed (not public constructor)

Static Public Member Functions
static proto bool	AreEqual (Revision a, Revision b)
	Returns true if both revisions are equal.

Static Public Attributes
static const int	INVALID_MAJOR_VERSION = -1

Constructor & Destructor Documentation

◆ ~Revision()

void Revision.~Revision ( )

Member Function Documentation

◆ AreEqual()

static proto bool Revision.AreEqual	(	Revision	a,
		Revision	b )

static

Returns true if both revisions are equal.

◆ ChangeLog()

proto external string Revision.ChangeLog ( )

Returns changelog of this Revision.

Changelog is available only if ELS_CHANGELOG data are loaded. See GetLoadFlags() for more.

◆ CompareTo()

proto external int Revision.CompareTo ( Revision rev )

Compare this Revision to another one.

◆ ComputePatchSize()

proto external void Revision.ComputePatchSize ( BackendCallback pCallback )

Will request download of manifests for this Revision to compute patch sizes.

Parameters

pCallback - Is script callback where you will receive result/error when request finishes

◆ GetAvailability()

proto external ERevisionAvailability Revision.GetAvailability ( )

Returns availability status of this Revision as enum ERevisionAvailability().

◆ GetDependencies()

proto external int Revision.GetDependencies ( out notnull array< Dependency > dependencies )

Will insert all instances of Dependency for this revision into outputDependencies.

Dependencies are available only if ELS_DEPENDENCIES data are loaded. See GetLoadFlags() for more.

Parameters

[out] dependencies - output for array of dependencies

◆ GetFiles()

proto external int Revision.GetFiles ( out notnull array< string > aFiles )

Get array containing names of all files in this Revision.

◆ GetGameVersion()

proto external string Revision.GetGameVersion ( )

Returns game version on which asset was uploaded as string.

◆ GetGameVersionArray()

proto external void Revision.GetGameVersionArray ( out notnull array< int > version )

Returns game version on which asset was uploaded as array.

Parameters

[out] version - output for array of 4 Integers which represents numbers between dots

◆ GetLoadFlags()

proto external int Revision.GetLoadFlags ( )

Describes which data are not loaded yet.

Returns: int - bitmask which should be compared with enum EPendingLoadState().

◆ GetPatchSize()

proto bool Revision.GetPatchSize ( out float size )

Get size of update patch from currently downloaded revision to this revision in bytes.

If no other Revision of same asset is downloaded then size will be total size of Revision. If this Revision is already downloaded then size will be 0.

Parameters

[out] size - size of patch in bytes

Returns: true if size was successfully calculated. false if we could not get size and result should not be used

◆ GetScenarios()

proto external int Revision.GetScenarios ( out notnull array< MissionWorkshopItem > scenarios )

Will insert all instances of MissionWorkshopItem for this revision into scenarios.

Scenarios are available only if ELS_SCENARIOS data are loaded. See GetLoadFlags() for more.

Parameters

[out] scenarios - output for array of scenarios

◆ GetSizeBytes()

proto external float Revision.GetSizeBytes ( )

◆ GetTotalSize()

proto external float Revision.GetTotalSize ( )

Returns total size of this revision.

Size is available only if ELS_FILES data are loaded. See GetLoadFlags() for more.

◆ GetVersion()

proto external string Revision.GetVersion ( )

Returns version of asset as string.

◆ GetVersionArray()

proto external void Revision.GetVersionArray ( out notnull array< int > version )

Returns version of asset as array.

Parameters

[out] version - output for array of 3 Integers which represents numbers between dots

◆ IsCorrupted()

proto external bool Revision.IsCorrupted ( )

Returns true if any local files are corrupted or missing. DownloadableItem.VerifyIntegrity() needs to be called first.

◆ IsDownloaded()

proto external bool Revision.IsDownloaded ( )

Returns true if this specific revision is already downloaded.

◆ LoadChangelog()

proto external void Revision.LoadChangelog ( BackendCallback pCallback )

Request changelog for this Revision.

Parameters

pCallback - Is script callback where you will receive result/error when request finishes

◆ LoadDependencies()

proto external void Revision.LoadDependencies ( BackendCallback pCallback )

Request list of all dependencies for this Revision.

Parameters

pCallback - Is script callback where you will receive result/error when request finishes

◆ LoadScenarios()

proto external void Revision.LoadScenarios ( BackendCallback pCallback )

Request list of all scenarios for this Revision.

Parameters

pCallback - Is script callback where you will receive result/error when request finishes

Member Data Documentation

◆ INVALID_MAJOR_VERSION

const int Revision.INVALID_MAJOR_VERSION = -1

static

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

GameLib/generated/online/Revision.c

Public Member Functions

Static Public Member Functions

Static Public Attributes

Constructor & Destructor Documentation

◆ ~Revision()

Member Function Documentation

◆ AreEqual()

◆ ChangeLog()

◆ CompareTo()

◆ ComputePatchSize()

◆ GetAvailability()

◆ GetDependencies()

◆ GetFiles()

◆ GetGameVersion()

◆ GetGameVersionArray()

◆ GetLoadFlags()

◆ GetPatchSize()

◆ GetScenarios()

◆ GetSizeBytes()

◆ GetTotalSize()

◆ GetVersion()

◆ GetVersionArray()

◆ IsCorrupted()

◆ IsDownloaded()

◆ LoadChangelog()

◆ LoadDependencies()

◆ LoadScenarios()

Member Data Documentation

◆ INVALID_MAJOR_VERSION