接口 IRootPropertyPane`实验性`

A root pane that can store property items.

interface IRootPropertyPane {
    collapsed: boolean;
    id: string;
    onPropertyPaneVisibilityUpdated: EventSink<PropertyPaneVisibilityUpdate>;
    visible: boolean;
    addBlockList(options?: IPropertyItemOptionsBlockList): IBlockListPropertyItem<{
        EMPTY: undefined;
    }, "EMPTY">;
    addBool(value: IObservableProp<boolean>, options?: IBoolPropertyItemOptions): IBoolPropertyItem;
    addBool_deprecated<T, Prop>(obj: T, property: Prop, options?: IPropertyItemOptionsBool): IPropertyItem<T, Prop>;
    addButton(action: RegisteredAction<NoArgsAction> | (() => void), options?: IButtonPropertyItemOptions): IButtonPropertyItem;
    addColorPicker(value: IObservableProp<RGBA>, options?: IColorPickerPropertyItemOptions): IColorPickerPropertyItem;
    addColorPicker_deprecated<T, Prop>(obj: T, property: Prop, options?: IPropertyItemOptionsColorPicker_deprecated): IPropertyItem<T, Prop>;
    addComboBox(value: IObservableProp<string>, options?: IComboBoxPropertyItemOptions): IComboBoxPropertyItem;
    addDivider(): IPropertyItemBase;
    addDropdown(value: IObservableProp<number>, options?: IDropdownPropertyItemOptions): IDropdownPropertyItem;
    addDropdown_deprecated<T, Prop>(obj: T, property: Prop, options?: IPropertyItemOptionsDropdown): IDropdownPropertyItem_deprecated<T, Prop>;
    addImage(value: IObservableProp<string | ImageResourceData>, options?: IImagePropertyItemOptions): IImagePropertyItem;
    addNumber(value: IObservableProp<number>, options?: INumberPropertyItemOptions): INumberPropertyItem;
    addNumber_deprecated<T, Prop>(obj: T, property: Prop, options?: IPropertyItemOptionsNumber): IPropertyItem<T, Prop>;
    addString(value: IObservableProp<string>, options?: IStringPropertyItemOptions): IStringPropertyItem;
    addString_deprecated<T, Prop>(obj: T, property: Prop, options?: IPropertyItemOptions): IPropertyItem<T, Prop>;
    addTable(options?: IPropertyItemOptionsTable): ITablePropertyItem<{
        EMPTY: undefined;
    }, "EMPTY">;
    addText(value: IObservableProp<LocalizedString>, options?: ITextPropertyItemOptions): ITextPropertyItem;
    addToggleGroup(value: IObservableProp<number>, options?: IToggleGroupPropertyItemOptions): IToggleGroupPropertyItem;
    addVector3(value: IObservableProp<Vector3>, options?: IVector3PropertyItemOptions): IVector3PropertyItem;
    addVector3_deprecated<T, Prop>(obj: T, property: Prop, options?: IPropertyItemOptionsVector3): IVector3PropertyItem_deprecated<T, Prop>;
    collapse(): void;
    createSubPane(options: ISubPanePropertyItemOptions): ISubPanePropertyItem;
    expand(): void;
    getTitle(): LocalizedString;
    hide(): void;
    isHeaderActionVisible(): boolean;
    removeSubPane(paneToRemove: IPropertyPane): boolean;
    setHeaderActionVisibility(visible: boolean): void;
    setTitle(newTitle: LocalizedString): void;
    show(): void;
}

层级 (查看完整内容)

IPropertyPane
- IRootPropertyPane

属性

`实验性`collapsed

collapsed: boolean

备注

Pane state for being expanded or collapsed.

`只读` `实验性`id

id: string

备注

Unique ID for the property pane.

`实验性`onPropertyPaneVisibilityUpdated

onPropertyPaneVisibilityUpdated: EventSink<PropertyPaneVisibilityUpdate>

备注

Provides visibility change events

`实验性`visible

visible: boolean

备注

Check visibility of the pane

方法

addBlockList

addBlockList(options?): IBlockListPropertyItem<{
EMPTY: undefined;
}, "EMPTY">
实验性
参数
- 可选options: IPropertyItemOptionsBlockList
返回 IBlockListPropertyItem<{
EMPTY: undefined;
}, "EMPTY">
备注
Adds a block list to the pane.
继承自 IPropertyPane.addBlockList
- 定义于 @minecraft/server-editor.d.ts:5583

addBool

addBool(value, options?): IBoolPropertyItem
实验性
参数
- value: IObservableProp<boolean>
- 可选options: IBoolPropertyItemOptions
返回 IBoolPropertyItem
备注
继承自 IPropertyPane.addBool
- 定义于 @minecraft/server-editor.d.ts:5592

addBool_deprecated

addBool_deprecated<T, Prop>(obj, property, options?): IPropertyItem<T, Prop>
实验性
类型参数
- T extends PropertyBag
- Prop extends string
参数
- obj: T
- property: Prop
- 可选options: IPropertyItemOptionsBool
返回 IPropertyItem<T, Prop>
备注
Adds a boolean item to the pane.
继承自 IPropertyPane.addBool_deprecated
- 定义于 @minecraft/server-editor.d.ts:5598

addButton

addButton(action, options?): IButtonPropertyItem
实验性
参数
- action: RegisteredAction<NoArgsAction> | (() => void)
- 可选options: IButtonPropertyItemOptions
返回 IButtonPropertyItem
备注
Adds a button to the pane and binds the specified action to the button activate.
继承自 IPropertyPane.addButton
- 定义于 @minecraft/server-editor.d.ts:5609

addColorPicker

addColorPicker(value, options?): IColorPickerPropertyItem
实验性
参数
- value: IObservableProp<RGBA>
- 可选options: IColorPickerPropertyItemOptions
返回 IColorPickerPropertyItem
备注
Adds a color picker item to the pane.
继承自 IPropertyPane.addColorPicker
- 定义于 @minecraft/server-editor.d.ts:5618

addColorPicker_deprecated

addColorPicker_deprecated<T, Prop>(obj, property, options?): IPropertyItem<T, Prop>
实验性
类型参数
- T extends PropertyBag
- Prop extends string
参数
- obj: T
- property: Prop
- 可选options: IPropertyItemOptionsColorPicker_deprecated
返回 IPropertyItem<T, Prop>
备注
Adds a color picker item to the pane.
继承自 IPropertyPane.addColorPicker_deprecated
- 定义于 @minecraft/server-editor.d.ts:5627

addComboBox

addComboBox(value, options?): IComboBoxPropertyItem
实验性
参数
- value: IObservableProp<string>
- 可选options: IComboBoxPropertyItemOptions
返回 IComboBoxPropertyItem
备注
Adds a combo box item to the pane.
继承自 IPropertyPane.addComboBox
- 定义于 @minecraft/server-editor.d.ts:5637

addDivider

addDivider(): IPropertyItemBase
实验性
返回 IPropertyItemBase
备注
Adds an divider item to the pane.
继承自 IPropertyPane.addDivider
- 定义于 @minecraft/server-editor.d.ts:5643

addDropdown

addDropdown(value, options?): IDropdownPropertyItem
实验性
参数
- value: IObservableProp<number>
- 可选options: IDropdownPropertyItemOptions
返回 IDropdownPropertyItem
备注
Adds an Dropdown item to the pane.
继承自 IPropertyPane.addDropdown
- 定义于 @minecraft/server-editor.d.ts:5649

addDropdown_deprecated

addDropdown_deprecated<T, Prop>(obj, property, options?): IDropdownPropertyItem_deprecated<T, Prop>
实验性
类型参数
- T extends Omit<PropertyBag, Prop> & {
  [key in string]: number
  }
- Prop extends string
参数
- obj: T
- property: Prop
- 可选options: IPropertyItemOptionsDropdown
返回 IDropdownPropertyItem_deprecated<T, Prop>
备注
Adds an DropDown item to the pane.
继承自 IPropertyPane.addDropdown_deprecated
- 定义于 @minecraft/server-editor.d.ts:5655

addImage

addImage(value, options?): IImagePropertyItem
实验性
参数
- value: IObservableProp<string | ImageResourceData>
- 可选options: IImagePropertyItemOptions
返回 IImagePropertyItem
备注
Adds an image item to the pane.
继承自 IPropertyPane.addImage
- 定义于 @minecraft/server-editor.d.ts:5670

addNumber

addNumber(value, options?): INumberPropertyItem
实验性
参数
- value: IObservableProp<number>
- 可选options: INumberPropertyItemOptions
返回 INumberPropertyItem
备注
Adds a number item to the pane.
继承自 IPropertyPane.addNumber
- 定义于 @minecraft/server-editor.d.ts:5679

addNumber_deprecated

addNumber_deprecated<T, Prop>(obj, property, options?): IPropertyItem<T, Prop>
实验性
类型参数
- T extends PropertyBag
- Prop extends string
参数
- obj: T
- property: Prop
- 可选options: IPropertyItemOptionsNumber
返回 IPropertyItem<T, Prop>
备注
Adds a number item to the pane.
继承自 IPropertyPane.addNumber_deprecated
- 定义于 @minecraft/server-editor.d.ts:5685

addString

addString(value, options?): IStringPropertyItem
实验性
参数
- value: IObservableProp<string>
- 可选options: IStringPropertyItemOptions
返回 IStringPropertyItem
备注
继承自 IPropertyPane.addString
- 定义于 @minecraft/server-editor.d.ts:5693

addString_deprecated

addString_deprecated<T, Prop>(obj, property, options?): IPropertyItem<T, Prop>
实验性
类型参数
- T extends PropertyBag
- Prop extends string
参数
- obj: T
- property: Prop
- 可选options: IPropertyItemOptions
返回 IPropertyItem<T, Prop>
备注
Adds a string item to the pane
继承自 IPropertyPane.addString_deprecated
- 定义于 @minecraft/server-editor.d.ts:5699

addTable

addTable(options?): ITablePropertyItem<{
EMPTY: undefined;
}, "EMPTY">
实验性
参数
- 可选options: IPropertyItemOptionsTable
返回 ITablePropertyItem<{
EMPTY: undefined;
}, "EMPTY">
备注
Adds a table to the pane.
继承自 IPropertyPane.addTable
- 定义于 @minecraft/server-editor.d.ts:5709

addText

addText(value, options?): ITextPropertyItem
实验性
参数
- value: IObservableProp<LocalizedString>
- 可选options: ITextPropertyItemOptions
返回 ITextPropertyItem
备注
Adds a multiline Text item to the pane.
继承自 IPropertyPane.addText
- 定义于 @minecraft/server-editor.d.ts:5720

addToggleGroup

addToggleGroup(value, options?): IToggleGroupPropertyItem
实验性
参数
- value: IObservableProp<number>
- 可选options: IToggleGroupPropertyItemOptions
返回 IToggleGroupPropertyItem
备注
Adds a toggle button group to the pane.
继承自 IPropertyPane.addToggleGroup
- 定义于 @minecraft/server-editor.d.ts:5726

addVector3

addVector3(value, options?): IVector3PropertyItem
实验性
参数
- value: IObservableProp<Vector3>
- 可选options: IVector3PropertyItemOptions
返回 IVector3PropertyItem
备注
Adds a Vec3 item to the pane.
继承自 IPropertyPane.addVector3
- 定义于 @minecraft/server-editor.d.ts:5732

addVector3_deprecated

addVector3_deprecated<T, Prop>(obj, property, options?): IVector3PropertyItem_deprecated<T, Prop>
实验性
类型参数
- T extends PropertyBag
- Prop extends string
参数
- obj: T
- property: Prop
- 可选options: IPropertyItemOptionsVector3
返回 IVector3PropertyItem_deprecated<T, Prop>
备注
Adds a Vec3 item to the pane.
继承自 IPropertyPane.addVector3_deprecated
- 定义于 @minecraft/server-editor.d.ts:5741

collapse

collapse(): void
实验性
返回 void
备注
Collapse the pane.
继承自 IPropertyPane.collapse
- 定义于 @minecraft/server-editor.d.ts:5751

createSubPane

createSubPane(options): ISubPanePropertyItem
实验性
参数
- options: ISubPanePropertyItemOptions
返回 ISubPanePropertyItem
备注
Creates an sub pane that can store property items.
继承自 IPropertyPane.createSubPane
- 定义于 @minecraft/server-editor.d.ts:5757

expand

expand(): void
实验性
返回 void
备注
Expand the pane.
继承自 IPropertyPane.expand
- 定义于 @minecraft/server-editor.d.ts:5763

getTitle

getTitle(): LocalizedString
实验性
返回 LocalizedString
备注
Returns property pane title.
继承自 IPropertyPane.getTitle
- 定义于 @minecraft/server-editor.d.ts:5769

hide

hide(): void
实验性
返回 void
备注
Hide the pane.
继承自 IPropertyPane.hide
- 定义于 @minecraft/server-editor.d.ts:5775

isHeaderActionVisible

isHeaderActionVisible(): boolean
实验性
返回 boolean
Current visibility state of header action

备注
- 定义于 @minecraft/server-editor.d.ts:5855

removeSubPane

removeSubPane(paneToRemove): boolean
实验性
参数
- paneToRemove: IPropertyPane
返回 boolean
备注
Removes an existing sub pane.
继承自 IPropertyPane.removeSubPane
- 定义于 @minecraft/server-editor.d.ts:5781

setHeaderActionVisibility

setHeaderActionVisibility(visible): void
实验性
参数
- visible: boolean
  New visibility state of the action button.
返回 void
备注
If a header action exists, updates visibility of the button.
- 定义于 @minecraft/server-editor.d.ts:5863

setTitle

setTitle(newTitle): void
实验性
参数
- newTitle: LocalizedString
  New title
返回 void
备注
Updates title of property pane.
继承自 IPropertyPane.setTitle
- 定义于 @minecraft/server-editor.d.ts:5789

show

show(): void
实验性
返回 void
备注
Show the pane and all of its property items.
继承自 IPropertyPane.show
- 定义于 @minecraft/server-editor.d.ts:5795

接口 IRootPropertyPane实验性

层级 (查看完整内容)

索引

属性

方法

属性

实验性collapsed

备注

只读 实验性id

备注

实验性onPropertyPaneVisibilityUpdated

备注

实验性visible

备注

方法

addBlockList

参数

返回 IBlockListPropertyItem<{ EMPTY: undefined; }, "EMPTY">

备注

addBool

参数

返回 IBoolPropertyItem

备注

addBool_deprecated

类型参数

参数

返回 IPropertyItem<T, Prop>

备注

addButton

参数

返回 IButtonPropertyItem

备注

addColorPicker

参数

返回 IColorPickerPropertyItem

备注

addColorPicker_deprecated

类型参数

参数

返回 IPropertyItem<T, Prop>

备注

addComboBox

参数

返回 IComboBoxPropertyItem

备注

addDivider

返回 IPropertyItemBase

备注

addDropdown

参数

返回 IDropdownPropertyItem

备注

addDropdown_deprecated

类型参数

参数

返回 IDropdownPropertyItem_deprecated<T, Prop>

备注

addImage

参数

返回 IImagePropertyItem

备注

addNumber

参数

返回 INumberPropertyItem

备注

addNumber_deprecated

类型参数

参数

返回 IPropertyItem<T, Prop>

备注

addString

参数

返回 IStringPropertyItem

备注

addString_deprecated

类型参数

参数

返回 IPropertyItem<T, Prop>

备注

addTable

接口 IRootPropertyPane`实验性`

`实验性`collapsed

`只读` `实验性`id

`实验性`onPropertyPaneVisibilityUpdated

`实验性`visible

返回 IBlockListPropertyItem<{
EMPTY: undefined;
}, "EMPTY">

返回 ITablePropertyItem<{
EMPTY: undefined;
}, "EMPTY">