Editor.Assets.LocationAsset
ClassAsset representing a named location with an identifier and type.
Index
Properties
Methods
Example
const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
// Find LocationAsset assets and check their type
const locationAssets = model.project.assetManager.assets.filter(
a => a.isOfType('LocationAsset')
) as Editor.Assets.LocationAsset[];
for (const loc of locationAssets) {
if (Editor.isNull(loc)) continue;
console.log(`Location: ${loc.displayName}, id: ${loc.locationId}`);
// Check if this is a Snap-type location
if (loc.locationType === Editor.Assets.LocationType.Snap) {
console.log(' This is a Snap cloud location');
}
}
Extends
Properties
cacheFile
readonlycacheFile:Path
Path to the cached asset file.
Inherited from
displayName
displayName:
string
Human-readable name for the location.
fileMeta
readonlyfileMeta:AssetImportMetadata
Import metadata for the asset.
Inherited from
id
readonlyid:Uuid
The unique id of the entity.
Inherited from
locationId
locationId:
string
Unique identifier for the location.
locationType
locationType:
LocationType
Type classification of the location.
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
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