接口 IToggleGroupPropertyItem`实验性`

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): IToggleGroupPropertyItemEntry;
    getEntryByValue(value: number): IToggleGroupPropertyItemEntry;
    setTitle(title: LocalizedString): void;
    setTooltip(tooltip: LocalizedString): void;
    updateEntries(
        entries: IToggleGroupPropertyItemEntry[],
        newValue?: number,
    ): void;
}

层级 (查看层级一览)

IPropertyItemBase
- IToggleGroupPropertyItem

索引

属性

enable id paneId typeName value visible

方法

getEntryByIndex getEntryByValue setTitle setTooltip updateEntries

属性

`实验性`enable

enable: boolean

备注

If the item is enabled in the UI.

`只读` `实验性`id

id: string

备注

Unique ID for the property item.

`只读` `实验性`paneId

paneId: string

备注

The parent pane id.

`只读` `实验性`typeName

typeName: PropertyItemType

备注

The type name of the target property.

`只读` `实验性`value

value: number

备注

Current selected entry value.

`实验性`visible

visible: boolean

备注

If the item should be visible in the UI.

方法

getEntryByIndex

getEntryByIndex(index: number): IToggleGroupPropertyItemEntry
实验性
参数
- index: number
  Index of the toggle entry in the list.
返回 IToggleGroupPropertyItemEntry
备注
Find a toggle entry at an index in the group.
- 定义于 @minecraft/server-editor.d.ts:6953

getEntryByValue

getEntryByValue(value: number): IToggleGroupPropertyItemEntry
实验性
参数
- value: number
  Value of the toggle entry in the group.
返回 IToggleGroupPropertyItemEntry
备注
Find a toggle entry with a specific value associated with property item.
- 定义于 @minecraft/server-editor.d.ts:6962

setTitle

setTitle(title: LocalizedString): void
实验性
参数
- title: LocalizedString
  New title.
返回 void
备注
Updates title of the property item.
- 定义于 @minecraft/server-editor.d.ts:6970

setTooltip

setTooltip(tooltip: LocalizedString): void
实验性
参数
- tooltip: LocalizedString
  New tooltip.
返回 void
备注
Updates tooltip of the property item.
- 定义于 @minecraft/server-editor.d.ts:6978

updateEntries

updateEntries(entries: IToggleGroupPropertyItemEntry[], newValue?: number): void
实验性
参数
- entries: IToggleGroupPropertyItemEntry[]
  New list of updated entries.
- 可选newValue: number
  New value value to use for the selected toggle button.
返回 void
备注
Update list of toggle group entries.
- 定义于 @minecraft/server-editor.d.ts:6988