Editor.Assets.CustomAsset
ClassAn instance of a custom asset type defined by an @asset script.
An instance of a custom asset type defined by an @asset script. Create as many instances of a type as needed; they hold pure data that can be shared across script components. The script's inputs are exposed as properties of the instance and can be set independently of the script's defaults.
Index
Properties
Methods
Example
// Create an instance of a custom asset type defined by an `@asset` script.
// The instance gets the script's inputs as properties, starting from the script's default values.
export function createCustomAssetInstance(
assetManager: Editor.Model.AssetManager,
script: Editor.Assets.ScriptAsset,
name: string,
): Editor.Assets.CustomAsset {
if (script.scriptType !== Editor.Assets.ScriptType.Asset) {
throw new Error(`${script.name} is not an @asset script`);
}
const destination = new Editor.Model.SourcePath(new Editor.Path(''), Editor.Model.SourceRootDirectory.Assets);
const instance = assetManager.createNativeAsset('CustomAsset', name, destination) as Editor.Assets.CustomAsset;
instance.scriptAsset = script;
console.log(`Created ${instance.name} from ${script.name}`);
return instance;
}
Extends
Properties
cacheFile
readonlycacheFile:Path
Path to the cached asset file.
Inherited from
fileMeta
readonlyfileMeta:AssetImportMetadata
Import metadata for the asset.
Inherited from
id
readonlyid:Uuid
The unique id of the entity.
Inherited from
meta
readonlymeta:Meta
Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.
Inherited from
name
readonlyname:string
The name of the asset.
Inherited from
scriptAsset
scriptAsset:
ScriptAsset
The @asset script that defines this custom asset's type and inputs. Assigning a Component or Module script logs an error and clears the reference.
type
readonlytype:string
The entity's type.
Inherited from
Methods
getDirectlyReferencedEntities()
getDirectlyReferencedEntities():
Entity[]
A list of entities which this entity has a reference to.
Returns
Entity[]
Inherited from
Asset.getDirectlyReferencedEntities
getMeta()
staticgetMeta():Meta
Returns metadata about this type.
Returns
Overrides
getOwnedEntities()
getOwnedEntities():
Entity[]
A list of entities which has a reference to this entity.
Returns
Entity[]
Inherited from
getTypeName()
staticgetTypeName():string
Returns the type name of this class.
Returns
string
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object is of the specified type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object refers to the same instance as the given object.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean