Skip to main content

Editor.Assets.LocationAsset

Class

Asset representing a named location with an identifier and type.

Index

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

readonly cacheFile: Path

Path to the cached asset file.

Inherited from

Asset.cacheFile


displayName

displayName: string

Human-readable name for the location.


fileMeta

readonly fileMeta: AssetImportMetadata

Import metadata for the asset.

Inherited from

Asset.fileMeta


id

readonly id: Uuid

The unique id of the entity.

Inherited from

Asset.id


locationId

locationId: string

Unique identifier for the location.


locationType

locationType: LocationType

Type classification of the location.


meta

readonly meta: Meta

Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.

Inherited from

Asset.meta


name

readonly name: string

The name of the asset.

Inherited from

Asset.name


type

readonly type: string

The entity's type.

Inherited from

Asset.type

Methods

getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

A list of entities which this entity has a reference to.

Returns

Entity[]

Inherited from

Asset.getDirectlyReferencedEntities


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

Asset.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

A list of entities which has a reference to this entity.

Returns

Entity[]

Inherited from

Asset.getOwnedEntities


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

Asset.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

Asset.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

Asset.isOfType


isSame()

isSame(other): boolean

Returns true if this object refers to the same instance as the given object.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

Asset.isSame