Unigine.FileSystemAssets Class

Methods:

Name	Description View: Sort by:
IsAsset	Returns a value indicating whether the file with the specified GUID is a non-native asset (has runtime files generated for it).
GetAssetGUID	Returns a GUID of a non-native asset (having generated runtime file or files) for the specified path.
GetNumRuntimes	Returns a number of runtime files for a non-native asset having the specified path.
IsPrimary	Returns a value indicating whether the runtime file corresponding to the specified path is a primary one.
GetPrimaryGUID	Returns the GUID of the primary runtime file for the specified file GUID if it exists.
IsMeta	Returns a value indicating whether the file with the specified GUID is a *.meta file.
IsRuntime	Returns a value indicating whether the file corresponding to the specified path is a generated runtime file.
IsRuntimePath	Returns a value indicating whether the specified path is a path to a generated runtime file.
GetRuntimeAlias	Returns the alias of the generated runtime file, specified by the given path.
SetRuntimeGUID	Sets a new GUID for the generated runtime file with a given path.
GetRuntimeGUID	Returns the current GUID for the generated runtime file, specified by the given non-native asset path and runtime index.
AddRuntime	Creates a new runtime file for the asset with a given path.
ClearRuntimes	Deletes all generated runtime files for the asset with the specified path.
CopyRuntime	Adds a copy of the generated runtime file with the specified path to another asset with the specified path.
RemoveRuntime	Deletes the specified generated runtime file and removes it from the list of runtimes of the corresponding asset.
Resolve	Resolves a given GUID.
ResolveAsset	Resolves a given GUID to a corresponding asset GUID, if any, or keeps the specified GUID as is.
ResolvePrimary	Resolves a given GUID to a corresponding primary runtime GUID, if any.
ResolveRuntimeAlias	Resolves a given alias of a generated runtime file to a corresponding GUID, if any.
SetRuntimeAlias	Sets a new alias for the generated runtime file, specified by the given non-native asset GUID and runtime index.
SetRuntimePrimary	Sets or unsets the generated runtime file, specified by the given non-native asset path and runtime index, as a primary one.
SetRuntimeParameter	Sets a new parameter with a given name and value for the generated runtime file specified by the non-native asset GUID.
GetRuntimeParameter	Returns the value of the specified parameter of the specified runtime file, or an empty string if such parameter does not exist.
HasRuntimeParameter	Checks if the specified runtime file has the specified parameter.
RemoveRuntimeParameter	Removes the specified parameter of the runtime file of the asset with the specified GUID.

FileSystemAssets Class

Members

bool IsAsset ( UGUID any_guid ) #

Returns a value indicating whether the file with the specified GUID is a non-native asset (has runtime files generated for it).

Arguments

UGUID any_guid - Any file GUID.

Return value

true if the file with the specified GUID is a non-native asset; otherwise, false.

bool IsAsset ( string path ) #

Returns a value indicating whether the file with the specified path is a non-native asset (has runtime files generated for it).

Arguments

string path - Path to a file.

Return value

true if the file with the specified path is a non-native asset; otherwise, false.

UGUID GetAssetGUID ( string path ) #

Returns a GUID of a non-native asset (having generated runtime file or files) for the specified path.

Arguments

string path - Path to a runtime or asset file.

Return value

GUID of a non-native asset corresponding to the specified path if it exists; otherwise, empty GUID.

NoticeThis method will return an empty GUID for any asset having no runtimes generated for it.

UGUID GetAssetGUID ( UGUID any_guid ) #

Returns a GUID of a non-native asset (having generated runtime file or files) for the specified GUID.

Arguments

UGUID any_guid - Any file GUID.

Return value

GUID of a non-native asset corresponding to the specified path if it exists; otherwise, empty GUID.

NoticeThis method will return an empty GUID for any asset having no runtimes generated for it.

int GetNumRuntimes ( string asset_path ) #

Returns a number of runtime files for a non-native asset having the specified path.

Arguments

string asset_path - Path to an asset file.

Return value

Number of runtime files generated for the specified asset.

int GetNumRuntimes ( UGUID asset_path ) #

Returns a number of runtime files for a non-native asset having the specified GUID.

Arguments

UGUID asset_path - Asset file GUID.

Return value

Number of runtime files generated for the specified asset.

bool IsPrimary ( string path ) #

Returns a value indicating whether the runtime file corresponding to the specified path is a primary one.

Arguments

string path - Path to a runtime file.

Return value

true if the runtime file corresponding to the specified path is a primary one; otherwise, false.

bool IsPrimary ( UGUID any_guid ) #

Returns a value indicating whether the runtime file corresponding to the specified GUID is a primary one.

Arguments

UGUID any_guid - Runtime file GUID.

Return value

true if the runtime file corresponding to the specified GUID is a primary one; otherwise, false.

UGUID GetPrimaryGUID ( UGUID any_guid ) #

Returns the GUID of the primary runtime file for the specified file GUID if it exists.

Arguments

UGUID any_guid - Any file GUID.

Return value

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

Asset file GUID -> GUID of its primary runtime file, if any; otherwise empty GUID.
Primary runtime file GUID -> GUID of this primary runtime file.
Runtime file GUID -> GUID of the primary runtime file for its asset, if any; otherwise empty GUID.
Any other file GUID -> empty GUID.

UGUID GetPrimaryGUID ( string path ) #

Returns the GUID of the primary runtime file for the specified file path if it exists.

Arguments

string path - Any file path.

Return value

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

Asset file path -> GUID of its primary runtime file, if any; otherwise empty GUID.
Primary runtime file path -> GUID of this primary runtime file.
Runtime file path -> GUID of the primary runtime file for its asset, if any; otherwise empty GUID.
Any other file path -> empty GUID.

bool 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

true if the file with the specified GUID is a *.meta file; otherwise, false.

bool IsRuntime ( string path ) #

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

Arguments

string path - Any file path.

Return value

true if the file corresponding to the specified path is a generated runtime file; otherwise, false.

Notice

This method will return 0 for any native asset.

bool IsRuntime ( UGUID any_guid ) #

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

Arguments

UGUID any_guid - Any file GUID.

Return value

true if the file corresponding to the specified path is a generated runtime file; otherwise, false.

Notice

This method will return 0 for any native asset.

bool 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

true if the specified path is a path to a generated runtime file; otherwise, false.

string GetRuntimeAlias ( string runtime_path ) #

Returns the alias of the generated runtime file, specified by the given path.

Arguments

string runtime_path - Path to the generated runtime file.

Return value

Alias set for the specified generated runtime file, if it exists; otherwise nullptr.

string GetRuntimeAlias ( UGUID runtime_guid ) #

Returns the alias of the generated runtime file, specified by the given GUID.

Arguments

UGUID runtime_guid - GUID of the generated runtime file.

Return value

Alias set for the specified generated runtime file, if it exists; otherwise nullptr.

string GetRuntimeAlias ( string asset_path, int index ) #

Returns the alias of the generated runtime file, specified by the given non-native asset path and runtime index.

Arguments

string asset_path - Path to a non-native asset.
int index - Index of the generated runtime file.

Return value

Alias set for the specified generated runtime file, if it exists; otherwise nullptr.

string GetRuntimeAlias ( UGUID asset_guid, int index ) #

Returns the alias of the generated runtime file, specified by the given non-native asset GUID and runtime index.

Arguments

UGUID asset_guid - GUID of a non-native asset.
int index - Index of the generated runtime file.

Return value

Alias set for the specified generated runtime file, if it exists; otherwise nullptr.

bool SetRuntimeGUID ( string runtime_path, UGUID new_runtime_guid ) #

Sets a new GUID for the generated runtime file with a given path.

Arguments

string runtime_path - Path to the generated runtime file.
UGUID new_runtime_guid - New GUID to be set.

Return value

true if a new GUID is successfully set; otherwise, false.

bool SetRuntimeGUID ( UGUID runtime_guid, UGUID new_runtime_guid ) #

Sets a new GUID for the generated runtime file with a given GUID.

Arguments

UGUID runtime_guid - GUID of the generated runtime file.
UGUID new_runtime_guid - New GUID to be set.

Return value

true if a new GUID is successfully set; otherwise, false.

bool SetRuntimeGUID ( string asset_path, int index, UGUID new_runtime_guid ) #

Sets a new GUID for the generated runtime file, specified by the given non-native asset path and runtime index.

Arguments

string asset_path - Path to a non-native asset.
int index - Index of the generated runtime file.
UGUID new_runtime_guid - New GUID to be set.

Return value

true if a new GUID is successfully set; otherwise, false.

bool SetRuntimeGUID ( UGUID asset_guid, int index, UGUID new_runtime_guid ) #

Sets a new GUID for the generated runtime file, specified by the given non-native asset GUID and runtime index.

Arguments

UGUID asset_guid - GUID of a non-native asset.
int index - Index of the generated runtime file.
UGUID new_runtime_guid - New GUID to be set.

Return value

true if a new GUID is successfully set; otherwise, false.

UGUID GetRuntimeGUID ( string asset_path, int index ) #

Returns the current GUID for the generated runtime file, specified by the given non-native asset path and runtime index.

Arguments

string asset_path - Path to a non-native asset.
int index - Index of the generated runtime file.

Return value

Current generated runtime file GUID for the given asset and runtime index, if any; otherwise, empty GUID.

UGUID GetRuntimeGUID ( UGUID asset_guid, int index ) #

Returns the current GUID for the generated runtime file, specified by the given non-native asset GUID and runtime index.

Arguments

UGUID asset_guid - GUID of a non-native asset.
int index - Index of the generated runtime file.

Return value

Current generated runtime file GUID for the given asset and runtime index, if any; otherwise, empty GUID.

UGUID AddRuntime ( string asset_path, string alias, int primary = 0 ) #

Creates a new runtime file for the asset with a given path. A new GUID will be generated for the new runtime file.

Arguments

string asset_path - Path to the asset for which a new runtime is to be created.
string alias - Alias for the new runtime file.
int primary - Use 1 to create a new runtime as a primary one; otherwise, 0.

Return value

GUID of the new created runtime, if it was successfully created, or an empty GUID, otherwise.

UGUID AddRuntime ( UGUID asset_guid, string alias, int primary = 0 ) #

Creates a new runtime file for the asset with a given GUID. A new GUID will be generated for the new runtime file.

Arguments

UGUID asset_guid - GUID of the asset for which a new runtime is to be created.
string alias - Alias for the new runtime file.
int primary - Use 1 to create a new runtime as a primary one; otherwise, 0.

Return value

GUID of the new created runtime, if it was successfully created, or an empty GUID, otherwise.

bool AddRuntime ( string asset_path, string alias, UGUID runtime_guid, int primary = 0 ) #

Creates a new runtime file for the asset with a given path. The specified GUID will be assigned to the new runtime file.

Arguments

string asset_path - Path to the asset for which a new runtime is to be created.
string alias - Alias for the new runtime file.
UGUID runtime_guid - GUID for the new runtime file.
int primary - Use 1 to create a new runtime as a primary one; otherwise, 0.

Return value

true if a new runtime file is successfully created; otherwise, false.

bool AddRuntime ( UGUID asset_guid, string alias, UGUID runtime_guid, int primary = 0 ) #

Creates a new runtime file for the asset with a given GUID. The specified GUID will be assigned to the new runtime file.

Arguments

UGUID asset_guid - GUID of the asset for which a new runtime is to be created.
string alias - Alias for the new runtime file.
UGUID runtime_guid - GUID for the new runtime file.
int primary - Use 1 to create a new runtime as a primary one; otherwise, 0.

Return value

true if a new runtime file is successfully created; otherwise, false.

bool ClearRuntimes ( string asset_path ) #

Deletes all generated runtime files for the asset with the specified path.

Arguments

string asset_path - Path to the asset for which all generated runtime files are to be deleted.

Return value

true if all generated runtime files for the specified asset are successfully deleted; otherwise, false.

bool ClearRuntimes ( UGUID asset_guid ) #

Deletes all generated runtime files for the asset with the specified GUID.

Arguments

UGUID asset_guid - GUID of the asset for which all generated runtime files are to be deleted.

Return value

true if all generated runtime files for the specified asset are successfully deleted; otherwise, false.

UGUID CopyRuntime ( string runtime_path, string new_asset_path ) #

Adds a copy of the generated runtime file with the specified path to another asset with the specified path.

Notice

A new GUID will be generated for the created runtime file copy.

Arguments

string runtime_path - Path to the generated runtime file to be copied.
string new_asset_path - Path to another asset for which a copy of the generated runtime file is to be added.

Return value

GUID of the new runtime file copy, if it is created successfully; otherwise, empty GUID.

UGUID CopyRuntime ( string runtime_path, UGUID new_asset_guid ) #

Adds a copy of the generated runtime file with the specified path to another asset having the specified GUID.

Notice

A new GUID will be generated for the created runtime file copy.

Arguments

string runtime_path - Path to the generated runtime file to be copied.
UGUID new_asset_guid - GUID of the asset for which a copy of the generated runtime file is to be added.

Return value

GUID of the new runtime file copy, if it is created successfully; otherwise, empty GUID.

UGUID CopyRuntime ( UGUID runtime_guid, string new_asset_path ) #

Adds a copy of the generated runtime file with the specified path to another asset having the specified path.

Notice

A new GUID will be generated for the created runtime file copy.

Arguments

UGUID runtime_guid - GUID of the generated runtime file to be copied.
string new_asset_path - Path to another asset for which a copy of the generated runtime file is to be added.

Return value

GUID of the new runtime file copy, if it is created successfully; otherwise, empty GUID.

UGUID CopyRuntime ( UGUID runtime_guid, UGUID new_asset_guid ) #

Adds a copy of the generated runtime file with the specified GUID to another asset specified by GUID.

Notice

A new GUID will be generated for the created runtime file copy.

Arguments

UGUID runtime_guid - GUID of the generated runtime file to be copied.
UGUID new_asset_guid - GUID of the asset for which a copy of the generated runtime file is to be added.

Return value

GUID of the new runtime file copy, if it is created successfully; otherwise, empty GUID.

UGUID CopyRuntime ( string asset_path, int index, string new_asset_path ) #

Adds a copy of the runtime file with the specified index, generated for the asset specified by path, to another asset having the specified path.

Notice

A new GUID will be generated for the created runtime file copy.

Arguments

string asset_path - Path to the asset file to which the generated runtime file to be copied belongs.
int index - Index of the generated runtime file to be copied in the range from 0 to the total number of runtimes generated for the asset.
string new_asset_path - Path to another asset for which a copy of the generated runtime file is to be added.

Return value

GUID of the new runtime file copy, if it is created successfully; otherwise, empty GUID.

UGUID CopyRuntime ( string asset_path, int index, UGUID new_asset_guid ) #

Adds a copy of the runtime file with the specified index, generated for the asset specified by path, to another asset having the specified GUID.

Notice

A new GUID will be generated for the created runtime file copy.

Arguments

string asset_path - Path to the asset file to which the generated runtime file to be copied belongs.
int index - Index of the generated runtime file to be copied in the range from 0 to the total number of runtimes generated for the asset.
UGUID new_asset_guid - GUID of the asset for which a copy of the generated runtime file is to be added.

Return value

GUID of the new runtime file copy, if it is created successfully; otherwise, empty GUID.

UGUID CopyRuntime ( UGUID asset_guid, int index, string new_asset_path ) #

Adds a copy of the runtime file with the specified index, generated for the asset specified by GUID, to another asset having the specified path.

Notice

A new GUID will be generated for the created runtime file copy.

Arguments

UGUID asset_guid - GUID of the asset file to which the generated runtime file to be copied belongs.
int index - Index of the generated runtime file to be copied in the range from 0 to the total number of runtimes generated for the asset.
string new_asset_path - Path to another asset for which a copy of the generated runtime file is to be added.

Return value

GUID of the new runtime file copy, if it is created successfully; otherwise, empty GUID.

UGUID CopyRuntime ( UGUID asset_guid, int index, UGUID new_asset_guid ) #

Adds a copy of the runtime file with the specified index, generated for the asset specified by GUID, to another asset having the specified GUID.

Notice

A new GUID will be generated for the created runtime file copy.

Arguments

UGUID asset_guid - GUID of the asset file to which the generated runtime file to be copied belongs.
int index - Index of the generated runtime file to be copied in the range from 0 to the total number of runtimes generated for the asset.
UGUID new_asset_guid - GUID of the asset for which a copy of the generated runtime file is to be added.

Return value

GUID of the new runtime file copy, if it is created successfully; otherwise, empty GUID.

bool CopyRuntime ( string runtime_path, string new_asset_path, UGUID new_runtime_guid ) #

Adds a copy of the generated runtime file specified by path, to another asset having the specified path.

NoticeThe created runtime file copy will have the specified runtime GUID assigned.

Arguments

string runtime_path - Path to the generated runtime file to be copied.
string new_asset_path - Path to another asset for which a copy of the generated runtime file is to be added.
UGUID new_runtime_guid - GUID to be set for the new runtime file copy.

Return value

true if the specified runtime file is successfully copied; otherwise, false.

bool CopyRuntime ( string runtime_path, UGUID new_asset_guid, UGUID new_runtime_guid ) #

Adds a copy of the generated runtime file specified by path, to another asset having the specified GUID.

NoticeThe created runtime file copy will have the specified runtime GUID assigned.

Arguments

string runtime_path - Path to the generated runtime file to be copied.
UGUID new_asset_guid - GUID of the asset for which a copy of the generated runtime file is to be added.
UGUID new_runtime_guid - GUID to be set for the new runtime file copy.

Return value

true if the specified runtime file is successfully copied; otherwise, false.

bool CopyRuntime ( UGUID runtime_guid, string new_asset_path, UGUID new_runtime_guid ) #

Adds a copy of the generated runtime file specified by GUID, to another asset having the specified path.

NoticeThe created runtime file copy will have the specified runtime GUID assigned.

Arguments

UGUID runtime_guid - GUID of the asset file to which the generated runtime file to be copied belongs.
string new_asset_path - Path to another asset for which a copy of the generated runtime file is to be added.
UGUID new_runtime_guid - GUID to be set for the new runtime file copy.

Return value

true if the specified runtime file is successfully copied; otherwise, false.

bool CopyRuntime ( UGUID runtime_guid, UGUID new_asset_guid, UGUID new_runtime_guid ) #

Adds a copy of the generated runtime file specified by GUID, to another asset having the specified GUID.

NoticeThe created runtime file copy will have the specified runtime GUID assigned.

Arguments

UGUID runtime_guid - GUID of the generated runtime file to be copied.
UGUID new_asset_guid - GUID of the asset for which a copy of the generated runtime file is to be added.
UGUID new_runtime_guid - GUID to be set for the new runtime file copy.

Return value

true if the specified runtime file is successfully copied; otherwise, false.

bool CopyRuntime ( string asset_path, int index, string new_asset_path, UGUID new_runtime_guid ) #

Adds a copy of the runtime file with the specified index, generated for the asset specified by path, to another asset having the specified path.

NoticeThe created runtime file copy will have the specified runtime GUID assigned.

Arguments

string asset_path - Path to the asset file to which the generated runtime file to be copied belongs.
int index - Index of the generated runtime file to be copied in the range from 0 to the total number of runtimes generated for the asset.
string new_asset_path - Path to another asset for which a copy of the generated runtime file is to be added.
UGUID new_runtime_guid - GUID to be set for the new runtime file copy.

Return value

true if the specified runtime file is successfully copied; otherwise, false.

bool CopyRuntime ( string asset_path, int index, UGUID new_asset_guid, UGUID new_runtime_guid ) #

Adds a copy of the runtime file with the specified index, generated for the asset specified by path, to another asset having the specified GUID.

NoticeThe created runtime file copy will have the specified runtime GUID assigned.

Arguments

string asset_path - Path to the asset file to which the generated runtime file to be copied belongs.
int index - Index of the generated runtime file to be copied in the range from 0 to the total number of runtimes generated for the asset.
UGUID new_asset_guid - GUID of the asset for which a copy of the generated runtime file is to be added.
UGUID new_runtime_guid - GUID to be set for the new runtime file copy.

Return value

true if the specified runtime file is successfully copied; otherwise, false.

bool CopyRuntime ( UGUID asset_guid, int index, string new_asset_path, UGUID new_runtime_guid ) #

Adds a copy of the runtime file with the specified index, generated for the asset specified by GUID, to another asset having the specified path.

NoticeThe created runtime file copy will have the specified runtime GUID assigned.

Arguments

UGUID asset_guid - GUID of the asset file to which the generated runtime file to be copied belongs.
int index - Index of the generated runtime file to be copied in the range from 0 to the total number of runtimes generated for the asset.
string new_asset_path - Path to another asset for which a copy of the generated runtime file is to be added.
UGUID new_runtime_guid - GUID to be set for the new runtime file copy.

Return value

true if the specified runtime file is successfully copied; otherwise, false.

bool CopyRuntime ( UGUID asset_guid, int index, UGUID new_asset_guid, UGUID new_runtime_guid ) #

Adds a copy of the runtime file with the specified index, generated for the asset specified by GUID, to another asset having the specified GUID.

NoticeThe created runtime file copy will have the specified runtime GUID assigned.

Arguments

UGUID asset_guid - GUID of the asset file to which the generated runtime file to be copied belongs.
int index - Index of the generated runtime file to be copied in the range from 0 to the total number of runtimes generated for the asset.
UGUID new_asset_guid - GUID of the asset for which a copy of the generated runtime file is to be added.
UGUID new_runtime_guid - GUID to be set for the new runtime file copy.

Return value

true if the specified runtime file is successfully copied; otherwise, false.

bool RemoveRuntime ( string runtime_path ) #

Deletes the specified generated runtime file and removes it from the list of runtimes of the corresponding asset.

Arguments

string runtime_path - Path to the generated runtime file to be deleted.

Return value

true if the specified runtime file is successfully deleted; otherwise, false.

bool RemoveRuntime ( UGUID runtime_guid ) #

Deletes the specified generated runtime file and removes it from the list of runtimes of the corresponding asset.

Arguments

UGUID runtime_guid - GUID of the generated runtime file to be deleted.

Return value

true if the specified runtime file is successfully deleted; otherwise, false.

bool RemoveRuntime ( string asset_path, int index ) #

Deletes the generated runtime file with the specified index, and removes it from the list of runtimes of the asset specified by path.

Arguments

string asset_path - Path to the asset file for which the specified generated runtime file is to be deleted.
int index - Index of the generated runtime file to be deleted in the range from 0 to the total number of runtimes generated for the asset.

Return value

true if the specified runtime file is successfully deleted; otherwise, false.

bool RemoveRuntime ( UGUID asset_guid, int index ) #

Deletes the generated runtime file with the specified index, and removes it from the list of runtimes of the asset specified by GUID.

Arguments

UGUID asset_guid - GUID of the asset file for which the specified generated runtime file is to be deleted.
int index - Index of the generated runtime file to be deleted in the range from 0 to the total number of runtimes generated for the asset.

Return value

true if the specified runtime file is successfully deleted; otherwise, false.

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

bool SetRuntimeAlias ( UGUID asset_guid, int index, string new_alias ) #

Sets a new alias for the generated runtime file, specified by the given non-native asset GUID and runtime index.

Arguments

UGUID asset_guid - GUID of a non-native asset.
int index - Index of the generated runtime file.
string new_alias - New alias to be set.

Return value

true if a new alias is successfully set; otherwise, false.

bool SetRuntimeAlias ( UGUID runtime_guid, string new_alias ) #

Sets a new alias for the generated runtime file with a given GUID.

Arguments

UGUID runtime_guid - GUID of the generated runtime file.
string new_alias - New alias to be set.

Return value

true if a new alias is successfully set; otherwise, false.

bool SetRuntimeAlias ( string runtime_path, string new_alias ) #

Sets a new alias for the generated runtime file with a given path.

Arguments

string runtime_path - Path to the generated runtime file.
string new_alias - New alias to be set.

Return value

true if a new alias is successfully set; otherwise, false.

bool SetRuntimeAlias ( string asset_path, int index, string new_alias ) #

Sets a new alias for the generated runtime file, specified by the given non-native asset path and runtime index.

Arguments

string asset_path - Path to a non-native asset.
int index - Index of the generated runtime file.
string new_alias - New alias to be set.

Return value

true if a new alias is successfully set; otherwise, false.

bool SetRuntimePrimary ( string asset_path, int index, int primary ) #

Sets or unsets the generated runtime file, specified by the given non-native asset path and runtime index, as a primary one.

Arguments

string asset_path - Path to a non-native asset.
int index - Index of the generated runtime file.
int primary - 1 to make the runtime file primary; 0 to unmake, if it is already set.

Return value

true if the runtime file is successfully set as a primary one; otherwise, false.

NoticeThere can be the only one primary runtime file, so when a new runtime file is set as the primary, the previous one is unset.

bool SetRuntimePrimary ( string runtime_path, int primary ) #

Sets or unsets the generated runtime file with a given path as a primary one.

Arguments

string runtime_path - Path to the generated runtime file.
int primary - 1 to make the runtime file primary; 0 to unmake, if it is already set.

Return value

true if the runtime file is successfully set as a primary one; otherwise, false.

NoticeThere can be the only one primary runtime file, so when a new runtime file is set as the primary, the previous one is unset.

bool SetRuntimePrimary ( UGUID runtime_guid, int primary ) #

Sets or unsets the generated runtime file with a given GUID as a primary one.

Arguments

UGUID runtime_guid - GUID of the generated runtime file.
int primary - 1 to make the runtime file primary; 0 to unmake, if it is already set.

Return value

true if the runtime file is successfully set as a primary one; otherwise, false.

NoticeThere can be the only one primary runtime file, so when a new runtime file is set as the primary, the previous one is unset.

bool SetRuntimePrimary ( UGUID asset_guid, int index, int primary ) #

Sets or unsets the generated runtime file, specified by the given non-native asset GUID and runtime index, as a primary one.

Arguments

UGUID asset_guid - GUID of a non-native asset.
int index - Index of the generated runtime file.
int primary - 1 to make the runtime file primary; 0 to unmake, if it is already set.

Return value

true if the runtime file is successfully set as a primary one; otherwise, false.

NoticeThere can be the only one primary runtime file, so when a new runtime file is set as the primary, the previous one is unset.

bool SetRuntimeParameter ( UGUID asset_guid, int index, string parameter_name, string new_parameter_value ) #

Sets a new parameter with a given name and value for the generated runtime file specified by the non-native asset GUID.

Arguments

UGUID asset_guid - GUID of a non-native asset.
int index - Index of the generated runtime file in the range from 0 to the total number of runtimes generated for the asset.
string parameter_name - Name of the parameter to be set.
string new_parameter_value - Value of the parameter to be set.

Return value

true if a new parameter for the runtime is successfully set; otherwise, false.

bool SetRuntimeParameter ( string asset_path, int index, string parameter_name, string new_parameter_value ) #

Sets a new parameter with a given name and value for the generated runtime file specified by the given non-native asset path.

Arguments

string asset_path - Path to a non-native asset.
int index - Index of the generated runtime file in the range from 0 to the total number of runtimes generated for the asset.
string parameter_name - Name of the parameter to be set.
string new_parameter_value - Value of the parameter to be set.

Return value

true if a new parameter for the runtime is successfully set; otherwise, false.

bool SetRuntimeParameter ( UGUID runtime_guid, string parameter_name, string new_parameter_value ) #

Sets a new parameter with a given name and value for the generated runtime file with a given GUID.

Arguments

UGUID runtime_guid - GUID of the generated runtime file.
string parameter_name - Name of the parameter to be set.
string new_parameter_value - Value of the parameter to be set.

Return value

true if a new parameter for the runtime is successfully set; otherwise, false.

bool SetRuntimeParameter ( string runtime_path, string parameter_name, string new_parameter_value ) #

Sets a new parameter with a given name and value for the generated runtime file with the specified path.

Arguments

string runtime_path - Path to the generated runtime file.
string parameter_name - Name of the parameter to be set.
string new_parameter_value - Value of the parameter to be set.

Return value

true if a new parameter for the runtime is successfully set; otherwise, false.

string GetRuntimeParameter ( UGUID asset_guid, int index, string parameter_name ) #

Returns the value of the specified parameter of the specified runtime file, or an empty string if such parameter does not exist.

Arguments

UGUID asset_guid - GUID of the asset file for the runtime file of which the parameter is returned.
int index - Index of the generated runtime file in the range from 0 to the total number of runtimes generated for the asset.
string parameter_name - Name of the parameter to be returned.

Return value

Value of the specified parameter, or an empty string if such parameter does not exist.

string GetRuntimeParameter ( string asset_path, int index, string parameter_name ) #

Returns the value of the specified parameter of the specified runtime file, or an empty string if such parameter does not exist.

Arguments

string asset_path - Path to a non-native asset.
int index - Index of the generated runtime file in the range from 0 to the total number of runtimes generated for the asset.
string parameter_name - Name of the parameter to be returned.

Return value

Value of the specified parameter, or an empty string if such parameter does not exist.

string GetRuntimeParameter ( UGUID runtime_guid, string parameter_name ) #

Returns the value of the specified parameter of the specified runtime file, or an empty string if such parameter does not exist.

Arguments

UGUID runtime_guid - GUID of the generated runtime file.
string parameter_name - Name of the parameter to be returned.

Return value

Value of the specified parameter, or an empty string if such parameter does not exist.

string GetRuntimeParameter ( string runtime_path, string parameter_name ) #

Returns the value of the specified parameter of the specified runtime file, or an empty string if such parameter does not exist.

Arguments

string runtime_path - Path to the generated runtime file.
string parameter_name - Name of the parameter to be returned.

Return value

Value of the specified parameter, or an empty string if such parameter does not exist.

bool HasRuntimeParameter ( UGUID asset_guid, int index, string parameter_name ) #

Checks if the specified runtime file has the specified parameter.

Arguments

UGUID asset_guid - GUID of the asset file for the runtime file of which the parameter is checked.
int index - Index of the generated runtime file in the range from 0 to the total number of runtimes generated for the asset.
string parameter_name - Name of the parameter to be checked.

Return value

true if the runtime file has the specified parameter; otherwise, false.

bool HasRuntimeParameter ( string asset_path, int index, string parameter_name ) #

Checks if the specified runtime file has the specified parameter.

Arguments

string asset_path - Path to a non-native asset.
int index - Index of the generated runtime file in the range from 0 to the total number of runtimes generated for the asset.
string parameter_name - Name of the parameter to be checked.

Return value

true if the runtime file has the specified parameter; otherwise, false.

bool HasRuntimeParameter ( UGUID runtime_guid, string parameter_name ) #

Checks if the specified runtime file has the specified parameter.

Arguments

UGUID runtime_guid - GUID of the generated runtime file.
string parameter_name - Name of the parameter to be checked.

Return value

true if the runtime file has the specified parameter; otherwise, false.

bool HasRuntimeParameter ( string runtime_path, string parameter_name ) #

Checks if the specified runtime file has the specified parameter.

Arguments

string runtime_path - Path to the generated runtime file.
string parameter_name - Name of the parameter to be checked.

Return value

true if the runtime file has the specified parameter; otherwise, false.

bool RemoveRuntimeParameter ( UGUID asset_guid, int index, string parameter_name ) #

Removes the specified parameter of the runtime file of the asset with the specified GUID.

Arguments

UGUID asset_guid - GUID of the asset file for the runtime file of which the parameter is removed.
int index - Index of the generated runtime file in the range from 0 to the total number of runtimes generated for the asset.
string parameter_name - Name of the parameter to be removed.

Return value

true if the specified parameter of the runtime file is successfully deleted; false if such parameter does not exist.

bool RemoveRuntimeParameter ( string asset_path, int index, string parameter_name ) #

Removes the specified parameter of the runtime file of the asset with the specified path.

Arguments

string asset_path - Path to a non-native asset.
int index - Index of the generated runtime file in the range from 0 to the total number of runtimes generated for the asset.
string parameter_name - Name of the parameter to be removed.

Return value

true if the specified parameter of the runtime file is successfully deleted; false if such parameter does not exist.

bool RemoveRuntimeParameter ( UGUID runtime_guid, string parameter_name ) #

Removes the specified parameter of the runtime file with the specified GUID.

Arguments

UGUID runtime_guid - GUID of the generated runtime file.
string parameter_name - Name of the parameter to be removed.

Return value

true if the specified parameter of the runtime file is successfully deleted; false if such parameter does not exist.

bool RemoveRuntimeParameter ( string runtime_path, string parameter_name ) #

Removes the specified parameter of the runtime file with the specified path.

Arguments

string runtime_path - Path to the generated runtime file.
string parameter_name - Name of the parameter to be removed.

Return value

true if the specified parameter of the runtime file is successfully deleted; false if such parameter does not exist.

Last update: 2024-12-13

Help improve this article

Was this article helpful?

Report a problem related to this article

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

Unigine.FileSystemAssets Class

In This Article:

Methods:

FileSystemAssets Class

Members

bool IsAsset ( UGUID any_guid ) #

Arguments

Return value

bool IsAsset ( string path ) #

Arguments

Return value

UGUID GetAssetGUID ( string path ) #

Arguments

Return value

UGUID GetAssetGUID ( UGUID any_guid ) #

Arguments

Return value

int GetNumRuntimes ( string asset_path ) #

Arguments

Return value

int GetNumRuntimes ( UGUID asset_path ) #

Arguments

Return value

bool IsPrimary ( string path ) #

Arguments

Return value

bool IsPrimary ( UGUID any_guid ) #

Arguments

Return value

UGUID GetPrimaryGUID ( UGUID any_guid ) #

Arguments

Return value

UGUID GetPrimaryGUID ( string path ) #

Arguments

Return value

bool IsMeta ( UGUID any_guid ) #

Arguments

Return value

bool IsRuntime ( string path ) #

Arguments

Return value

bool IsRuntime ( UGUID any_guid ) #

Arguments

Return value

bool IsRuntimePath ( string path ) #

Arguments

Return value

string GetRuntimeAlias ( string runtime_path ) #

Arguments

Return value

string GetRuntimeAlias ( UGUID runtime_guid ) #

Arguments

Return value

string GetRuntimeAlias ( string asset_path, int index ) #

Arguments

Return value

string GetRuntimeAlias ( UGUID asset_guid, int index ) #

Arguments

Return value

bool SetRuntimeGUID ( string runtime_path, UGUID new_runtime_guid ) #

Arguments

Return value

bool SetRuntimeGUID ( UGUID runtime_guid, UGUID new_runtime_guid ) #

Arguments

Return value

bool SetRuntimeGUID ( string asset_path, int index, UGUID new_runtime_guid ) #

Arguments

Return value

bool SetRuntimeGUID ( UGUID asset_guid, int index, UGUID new_runtime_guid ) #

Arguments

Return value

UGUID GetRuntimeGUID ( string asset_path, int index ) #

Arguments

Return value

UGUID GetRuntimeGUID ( UGUID asset_guid, int index ) #

Arguments

Return value

UGUID AddRuntime ( string asset_path, string alias, int primary = 0 ) #

Arguments

Return value