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

    Interface IToggleGroupPropertyItemBeta

    A property item which supports toggle button properties

    interface IToggleGroupPropertyItem {
        enable: boolean;
        id: string;
        paneId: string;
        typeName: PropertyItemType;
        value: number;
        visible: boolean;
        getEntryByIndex(index: number): undefined | IToggleGroupPropertyItemEntry;
        getEntryByValue(value: number): undefined | IToggleGroupPropertyItemEntry;
        setTitle(title: undefined | LocalizedString): void;
        setTooltip(tooltip: undefined | LocalizedString): void;
        updateEntries(
            entries: IToggleGroupPropertyItemEntry[],
            newValue?: number,
        ): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    enable id paneId typeName value visible

    Methods

    getEntryByIndex getEntryByValue setTitle setTooltip updateEntries

    Properties

    enable: boolean

    If the item is enabled in the UI.

    id: string

    Unique ID for the property item.

    paneId: string

    The parent pane id.

    typeName: PropertyItemType

    The type name of the target property.

    value: number

    Current selected entry value.

    visible: boolean

    If the item should be visible in the UI.

    Methods

    • Beta

      Parameters

      • value: number

        Value of the toggle entry in the group.

      Returns undefined | IToggleGroupPropertyItemEntry

      Find a toggle entry with a specific value associated with property item.

    • Beta

      Parameters

      Returns void

      Updates title of the property item.

    • Beta

      Parameters

      Returns void

      Updates tooltip of the property item.

    • Beta

      Parameters

      • entries: IToggleGroupPropertyItemEntry[]

        New list of updated entries.

      • OptionalnewValue: number

        New value value to use for the selected toggle button.

      Returns void

      Update list of toggle group entries.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods