engine.filesystemassets Functions

Sort by:

List of functions:

This class represents the subsystem of the Engine's file system that is used to manage assets and runtime files.

FileSystemAssets Class

Members

int isRuntimePath(string path)

Returns a value indicating whether the specified path is a path to a generated runtime file.

Arguments

string path - Any file path.

Return value

1 if the specified path is a path to a generated runtime file; otherwise, 0.

UGUID resolve(UGUID any_guid)

Resolves a given GUID.

Arguments

UGUID any_guid - Any file GUID.

Return value

Return GUID value is determined by the GUID specified in accordance with the following:

Non-native asset file GUID -> GUID of its primary runtime file, if any; otherwise, asset file GUID.
Any other file GUID -> file GUID as is.

Source code (C++)

// if there is a primary runtime generated
resolve(asset_guid);		//	-> primary_guid
resolve(primary_guid);		//	-> primary_guid
resolve(runtime_guid);		//	-> runtime_guid

// if there is no primary runtime generated
resolve(asset_guid);		//	-> asset_guid
resolve(primary_guid);		//	-> primary_guid
resolve(runtime_guid);		//	-> runtime_guid

UGUID resolveAsset(UGUID any_guid)

Resolves a given GUID to a corresponding asset GUID, if any, or keeps the specified GUID as is.

Arguments

UGUID any_guid - Any file GUID.

Return value

Return GUID value is determined by the GUID specified in accordance with the following:

Primary runtime file GUID -> source asset file GUID.
Generated runtime file GUID -> source asset file GUID.
Non-native asset file GUID -> GUID as is.
Any other file GUID -> GUID as is.

Source code (C++)

resolveAsset(asset_guid);		//	-> asset_guid
resolveAsset(primary_guid);		//	-> asset_guid
resolveAsset(runtime_guid);		//	-> asset_guid

UGUID resolvePrimary(UGUID any_guid)

Resolves a given GUID to a corresponding primary runtime GUID, if any.

Arguments

UGUID any_guid - Any file GUID.

Return value

Return GUID value is determined by the GUID specified in accordance with the following:

Any generated runtime file GUID -> GUID of the primary runtime file for the source asset.
Non-native asset file GUID -> GUID of its primary runtime file, if any; otherwise, empty GUID.
Any other file GUID -> empty GUID.

Source code (C++)

// if there is a primary runtime generated
resolvePrimary(asset_guid);		//	-> primary_guid
resolvePrimary(primary_guid);	//	-> primary_guid
resolvePrimary(runtime_guid);	//	-> primary_guid

// if there is no primary runtime generated
resolvePrimary(asset_guid);			//	-> empty guid
resolvePrimary(runtime_guid);		//	-> empty guid

UGUID resolveRuntimeAlias(string path)

Resolves a given alias of a generated runtime file to a corresponding GUID, if any.

Arguments

string path - Runtime file alias.

Return value

GUID of the generated runtime file having the specified alias, af any; otherwise, empty GUID

int isMeta(UGUID any_guid)

Returns a value indicating whether the file with the specified GUID is a *.meta file.

Arguments

UGUID any_guid - Any file GUID.

Return value

1 if the file with the specified GUID is a *.meta file; otherwise, 0.

Last update: 2018-08-10

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)