AssetBase
Public Attributes
bool
Whether the asset is automatically unloaded when an asset is released and has no other acquisitions or not.
string
An arbitrary category that can be used to categorized assets.
string
The simple description of the asset contents.
bool
Whether the asset is used internally only or not.
string
The name of the asset. The is not a unique identification like an asset Id.
bool
Whether the asset is private or not.
Public Functions
void
addAssetDependencyField(string pFieldName, string pAssetId)
Adds an asset dependency field to the asset definition.
void
clearAssetDependencyFields(string pFieldName)
Clears any asset dependency fields matching the name provided.
int
getAssetDependencyFieldCount(string pFieldName)
Gets the number of asset dependencies of a given field name.
String
Gets the assets' Asset Id. This is only available if the asset was acquired from the asset manager.
void
Refresh the asset.
bool
Saves the asset definition.
Detailed Description
UNDOCUMENTED!
Public Attributes
bool AssetAutoUnload
Whether the asset is automatically unloaded when an asset is released and has no other acquisitions or not.
string AssetCategory
An arbitrary category that can be used to categorized assets.
string AssetDescription
The simple description of the asset contents.
bool AssetInternal
Whether the asset is used internally only or not.
string AssetName
The name of the asset. The is not a unique identification like an asset Id.
bool AssetPrivate
Whether the asset is private or not.
Public Functions
addAssetDependencyField(string pFieldName, string pAssetId)
Adds an asset dependency field to the asset definition.
Parameters:
| fieldName | The name of the field. Will automatically increment the tailing number if the field is used multiple times |
| assetId | The assetId to be marked as a dependency |
clearAssetDependencyFields(string pFieldName)
Clears any asset dependency fields matching the name provided.
Parameters:
| fieldName | The name of the fields to be cleared |
getAssetDependencyFieldCount(string pFieldName)
Gets the number of asset dependencies of a given field name.
eg. Would return '2' if you searched for 'myDependencyField' and the asset had myDependencyField0 and myDependencyField1 Parameters:
| fieldName | The name of the field to get a count of |
The number of dependency fields matching the search name.
getAssetId()
Gets the assets' Asset Id. This is only available if the asset was acquired from the asset manager.
The assets' Asset Id.
refreshAsset()
Refresh the asset.
No return value.
saveAsset()
Saves the asset definition.
Whether the save was successful.