Editor Scripting API
    Preparing search index...

    Class Path

    A path in the filesystem, or Asset Manager. Useful for things like importing files into Lens Studio through the Editor.Model.AssetManager.

    // Get access to the project's assetManager
    const model = this.pluginSystem.findInterface(Editor.Model.IModel);
    const assetManager = model.project.assetManager;

    // Locate the shader pass we want to import
    const resourceLoc = import.meta.resolve('Resources/myMesh.ss_graph');
    const absGraphPath = new Editor.Path(resourceLoc);

    // Import the shader pass
    const pathInAssetManager = new Editor.Path('');
    const meta = await assetManager.importExternalFileAsync(absolutePath, pathInAssetManager, Editor.Model.ResultType.Packed);
    Index

    Constructors

    constructor

    Properties

    extension fileName fileNameBase isEmpty parent

    Methods

    appended equals hasExtension isInside relative replaceExtension replaceFileNameBase toString

    Constructors

    • Construct a new path object.

      Parameters

      • str: string

      Returns Path

    Properties

    extension: string

    The extension of the file of the current path object (without dot).

    fileName: Path

    The name of the file, including its extension, in the current path object.

    fileNameBase: string

    The name of the file, without its extension, in the current path object.

    isEmpty: boolean

    Whether the path string is empty.

    parent: Path

    A path to the parent folder of the current path object.

    Methods

    • Returns a new path object relative to the rootPath.

      Parameters

      Returns Path

    • Returns true if this path is equal to the given path.

      Parameters

      Returns boolean

    • Whether the path object has a file extension in the end.

      Parameters

      • extension: string

      Returns boolean

    • Whether the current path is inside directory.

      Parameters

      Returns boolean

    • Returns a new path object relative to the rootPath.

      Parameters

      Returns Path

    • Rename the extension of the file.

      Parameters

      • newExtension: string

      Returns Path

    • Returns a new path with the file name base replaced by the given string, preserving extension and directory.

      Parameters

      • name: string

      Returns Path

    • Returns the current path as a string.

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods