Editor Scripting API
    Preparing search index...

    Class IPackageRegistry

    Interface for package discovery and registration.

        // Resolve IPackageRegistry to discover registered package library paths.
        const registry = this.pluginSystem.findInterface(
          Editor.IPackageRegistry.interfaceId
        ) as Editor.IPackageRegistry;
        if (Editor.isNull(registry)) {
          console.log('IPackageRegistry not available');
          return;
        }

        const libraryPaths = registry.getLibraryPaths();
        console.log('Library paths count:', libraryPaths.length);
        for (const p of libraryPaths) {
          console.log('  Library path:', p.toString());
        }

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    interfaceId

    Methods

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

    Constructors

    Properties

    interfaceId: InterfaceId

    Static interface ID for resolving the package registry component via the plugin system.

    Methods

    • Return whether a newer version of the asset can be pulled from the library.

      Parameters

      Returns boolean

    • Return whether the asset has local changes that can be pushed back to the library.

      Parameters

      Returns boolean

    • Return whether the asset is eligible to be registered into the user's local library.

      Parameters

      Returns boolean

    • Return the filesystem paths of all local library paths.

      Returns Path[]

    • Return the registered type name for an entity given its UUID and base type.

      Parameters

      Returns string

    • Return the registered type name matching the given name and entity base type.

      Parameters

      Returns string

    • Return whether the component with the given UUID is registered in the user's locally installed library.

      Parameters

      Returns boolean

    • Return whether the component with the given UUID is present in the current project.

      Parameters

      Returns boolean

    • Returns true if the object is of the specified type.

      Parameters

      • type: string

      Returns boolean

    • Push local changes of the asset back to the library, optionally locking the package.

      Parameters

      Returns void

    • Register the asset into the user's local library so it can be reused across projects.

      Parameters

      Returns void

    • Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods