RSX Code Reference
    Preparing search index...

    Class GroupEntry

    A library entry that can have child entries.

    Hierarchy (View Summary)

    Index
    constructor
    children identifierPath isAvailable isLibraryPathAvailable isVisible libraryPath name operationTag packagePath parent type
    • get identifierPath(): LibraryIdentifierPath

      The identifier path of the entry.

      Returns LibraryIdentifierPath

      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.

    • get isAvailable(): boolean

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

      Returns boolean

    • get isLibraryPathAvailable(): boolean

      Determines if the entry has a library path.

      Returns boolean

      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.

    • get isVisible(): boolean

      Returns boolean

    • get libraryPath(): LibraryPath

      Parses the identifier path to construct the path within the library.

      Returns LibraryPath

    • get name(): string

      Name of the entry.

      Returns string

    • set name(value: string): void

      Parameters

      • value: string

      Returns void

    • 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

    • get packagePath(): FilePath

      Parses the identifier path to construct the package path.

      Returns FilePath

    • get parent(): GroupEntry

      Gets the folder this entry is located in.

      Returns GroupEntry

    Settings
    Member Visibility

    On This Page
    Constructors
    Accessors