@minecraft/server-editor
    Preparing search index...

    Interface ICollectionTreeFolderBeta

    Container for collection items

    interface ICollectionTreeFolder {
        entryCount: number;
        expanded: boolean;
        folderCount: number;
        id: string;
        parent: undefined | ICollectionTreeFolder;
        selected: boolean;
        title: LocalizedString;
        userData: unknown;
        addEntry(options: ICollectionTreeEntryOptions): ICollectionTreeEntry;
        addFolder(options: ICollectionTreeFolderOptions): ICollectionTreeFolder;
        forEachEntry(
            callback: (entry: ICollectionTreeEntry, index: number) => boolean,
        ): void;
        forEachFolder(callback: (folder: ICollectionTreeFolder) => boolean): void;
        forEachFolder(callback: (folder: ICollectionTreeFolder) => boolean): void;
        getEntryById(id: string): undefined | ICollectionTreeEntry;
        getEntryByIndex(index: number): undefined | ICollectionTreeEntry;
        getFolder(id: string): undefined | ICollectionTreeFolder;
        removeEntryById(id: string): boolean;
        removeEntryByIndex(index: number): boolean;
        setColor(color: undefined | RGBA): void;
        setExpanded(expanded: boolean): void;
        setHeaderAction(
            actionParams: undefined | ICollectionTreeFolderHeaderActionParams,
        ): void;
        setSelected(selected: boolean): void;
        setTitle(title: LocalizedString): void;
    }
    Index

    Properties

    entryCount expanded folderCount id parent selected title userData

    Methods

    addEntry addFolder forEachEntry forEachFolder getEntryById getEntryByIndex getFolder removeEntryById removeEntryByIndex setColor setExpanded setHeaderAction setSelected setTitle

    Properties

    entryCount: number

    Count of the entries

    expanded: boolean

    Expanded state of the folder

    folderCount: number

    Count of the child folders

    id: string

    Unique identifier of the folder

    parent: undefined | ICollectionTreeFolder

    Parent folder

    selected: boolean

    Selected state of the folder

    title: LocalizedString

    Title of the folder

    userData: unknown

    User data associated with the folder

    Methods

    • Beta

      Parameters

      • callback: (entry: ICollectionTreeEntry, index: number) => boolean

        Returning false will stop the iteration

      Returns void

      Iterates over entries within the folder

    • Beta

      Parameters

      Returns void

      Iterates over the first layer of folders

    • Beta

      Parameters

      Returns void

      Iterates over the first layer of folders

    • Beta

      Parameters

      • id: string

        Identifier of the folder

      Returns undefined | ICollectionTreeEntry

      Gets the entry by its unique identifier

    • Beta

      Parameters

      • index: number

        Index of the entry

      Returns undefined | ICollectionTreeEntry

      Gets the entry at the index

    • Beta

      Parameters

      • id: string

        Identifier of the folder

      Returns undefined | ICollectionTreeFolder

      Find the folder with the id if it exists

    • Beta

      Parameters

      • id: string

        Identifier of the folder

      Returns boolean

      Removes the entry by its unique identifier if it exists

    • Beta

      Parameters

      • index: number

        Index of the entry

      Returns boolean

      Removes the entry at the index if it exists

    • Beta

      Parameters

      • color: undefined | RGBA

        New color state

      Returns void

      Set color of the entry.

    • Beta

      Parameters

      • expanded: boolean

        New expanded state

      Returns void

      Set expanded state of the entry.

    • Beta

      Parameters

      • selected: boolean

        New selected state

      Returns void

      Set selected state of the entry.

    • Beta

      Parameters

      Returns void

      Set title of the entry.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods