Editor Scripting API
    Preparing search index...

    Class SourcePath

    Represents a file path within a Lens Studio project, combining a root-relative path with a source root directory.

    Index

    Constructors

    constructor

    Properties

    extension fileName fileNameBase isEmpty parent relativeToProject relativeToRoot rootDirectory

    Methods

    hasExtension replaceFileNameBase toString

    Constructors

    Properties

    extension: string

    File extension of the path, including the leading dot.

    fileName: Path

    File name portion of the path as an Editor.Path.

    fileNameBase: string

    File name without extension.

    isEmpty: boolean

    True if the path is empty or unset.

    parent: SourcePath

    Parent directory of the path as a SourcePath.

    relativeToProject: Path

    Path relative to the project root.

    relativeToRoot: Path

    Path relative to the source root directory.

    rootDirectory: Path

    Source root directory this path is anchored to.

    Methods

    • Returns true if the path's file extension matches the given extension string.

      Parameters

      • extension: string

      Returns boolean

    • Returns a new SourcePath with the file name base replaced by the given string.

      Parameters

      • newBaseName: string

      Returns SourcePath

    • Returns the full path as a string.

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods