Class IPackageRegistry

Interface for package discovery and registration.

Hierarchy (View Summary)

IPluginComponent
- IPackageRegistry

Index

Constructors

Properties

Methods

canPullUpdate canPushUpdate canRegisterToLibrary getLibraryPaths getTypeById getTypeByName getTypeByVersion getTypeName isInLibrary isInProject isOfType isSame packageMetadata pullUpdate pushUpdate registerToLibrary selectVersionFromAssetLibrary

Constructors

`Protected`constructor

new IPackageRegistry(): IPackageRegistry
Snap Hidden
Returns IPackageRegistry
Overrides IPluginComponent.constructor

Properties

`Static`interfaceId

interfaceId: InterfaceId

Methods

canPullUpdate

canPullUpdate(asset: Editor.Assets.Asset): boolean
Parameters
- asset: Editor.Assets.Asset
Returns boolean

canPushUpdate

canPushUpdate(asset: Editor.Assets.Asset): boolean
Parameters
- asset: Editor.Assets.Asset
Returns boolean

canRegisterToLibrary

canRegisterToLibrary(asset: Editor.Assets.Asset): boolean
Parameters
- asset: Editor.Assets.Asset
Returns boolean

getLibraryPaths

getLibraryPaths(): Path[]
Returns Path[]

getTypeById

getTypeById(uid: Uuid, entityBaseType: EntityBaseType): string
Parameters
- uid: Uuid
- entityBaseType: EntityBaseType
Returns string

getTypeByName

getTypeByName(name: string, entityBaseType: EntityBaseType): string
Parameters
- name: string
- entityBaseType: EntityBaseType
Returns string

getTypeByVersion

getTypeByVersion(
    uid: Uuid,
    version: Editor.Assets.Version,
    entityBaseType: EntityBaseType,
): string
Parameters
- uid: Uuid
- version: Editor.Assets.Version
- entityBaseType: EntityBaseType
Returns string

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from IPluginComponent.getTypeName

isInLibrary

isInLibrary(componentId: Uuid): boolean
Parameters
- componentId: Uuid
Returns boolean

isInProject

isInProject(componentId: Uuid): boolean
Parameters
- componentId: Uuid
Returns boolean

isOfType

isOfType(type: string): boolean
Returns true if the object is of the specified type.
Parameters
- type: string
Returns boolean
Inherited from IPluginComponent.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object refers to the same instance as the given object.
Parameters
- other: ScriptObject
Returns boolean
Inherited from IPluginComponent.isSame

packageMetadata

packageMetadata(sourcePath: Path): PackageMetadata
Parameters
- sourcePath: Path
Returns PackageMetadata

pullUpdate

pullUpdate(asset: Editor.Assets.Asset): void
Parameters
- asset: Editor.Assets.Asset
Returns void

pushUpdate

pushUpdate(asset: Editor.Assets.Asset, locked: boolean): void
Parameters
- asset: Editor.Assets.Asset
- locked: boolean
Returns void

registerToLibrary

registerToLibrary(asset: Editor.Assets.Asset): void
Parameters
- asset: Editor.Assets.Asset
Returns void

selectVersionFromAssetLibrary

selectVersionFromAssetLibrary(
    descriptor: NativePackageDescriptor,
    asset: Asset,
    resource: Resource,
): void
NEW
Parameters
- descriptor: NativePackageDescriptor
- asset: Asset
- resource: Resource
Returns void