Class FileEntry

A library entry representing a file (package or individual resource).

Hierarchy (view full)

Constructors

constructor

Accessors

children identifierPath isAvailable isLibraryPathAvailable isVisible libraryPath name operationTag packageCategory packagePath packageUUID parent resources type

Constructors

Protectedconstructor

Accessors

children

identifierPath

  • get identifierPath(): LibraryIdentifierPath

  • The identifier path of the entry.

    Returns LibraryIdentifierPath

    Note

    The identifier path is a combination of the absolute path to the entry, with an optional path after the RSX package extension to the virtual file system. Packages and other logical resources like the root will thus not have a virtual file system component. Use isLibraryPathAvailable to determine if the entry is part of the virtual file system.

isAvailable

  • get isAvailable(): boolean

  • Whether or not the current entry is available to be used.

    Returns boolean

isLibraryPathAvailable

  • get isLibraryPathAvailable(): boolean

  • Determines if the entry has a library path.

    Returns boolean

    Note

    A LibraryEntry may point to a logical rpak or the root of the project library, which do not have a virtual library path representation as they're logical objects in the current project file system.

isVisible

  • get isVisible(): boolean

  • Returns boolean

libraryPath

name

  • get name(): string

  • Name of the entry.

    Returns string

  • set name(value): void

  • Parameters

    • value: string

    Returns void

operationTag

  • get operationTag(): string

  • Gets the Library Operation Tag of the current operation being performed. Empty if no operation is available and no operation is running for this Entry.

    Returns string

packageCategory

  • get packageCategory(): string

  • Category of the package at this path.

    Returns string

packagePath

  • get packagePath(): FilePath

  • Parses the identifier path to construct the package path.

    Returns FilePath

packageUUID

  • get packageUUID(): UUID

  • Unique identifier of the package at this path.

    Returns UUID

parent

  • get parent(): GroupEntry

  • Gets the folder this entry is located in.

    Returns GroupEntry

resources

type

Settings

Member Visibility

On This Page

Constructors
Accessors