Class BlockPaletteManager

Index

Constructors

Methods

addOrReplacePalette getPalette getPaletteIdList getPaletteItem getPrimaryPalette getSelectedBlockType getSelectedItem removePalette setPaletteItem setPrimaryPalette setSelectedItem

Constructors

`Private`constructor

new BlockPaletteManager(): BlockPaletteManager
Returns BlockPaletteManager

Methods

addOrReplacePalette

addOrReplacePalette(paletteId: string, palette: BlockPalette): void
Parameters
- paletteId: string
- palette: BlockPalette
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

World Ready
This function can't be called in early-execution mode.

getPalette

getPalette(paletteId: string): BlockPalette
Parameters
- paletteId: string
Returns BlockPalette

getPaletteIdList

getPaletteIdList(): string[]
Returns string[]

getPaletteItem

getPaletteItem(paletteId: string, index: number): IBlockPaletteItem
Parameters
- paletteId: string
- index: number
Returns IBlockPaletteItem
Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

getPrimaryPalette

getPrimaryPalette(): BlockPalette
Returns BlockPalette

getSelectedBlockType

getSelectedBlockType(): BlockType
Returns BlockType
Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

getSelectedItem

getSelectedItem(): IBlockPaletteItem
Returns IBlockPaletteItem

removePalette

removePalette(paletteId: string): void
Parameters
- paletteId: string
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

setPaletteItem

setPaletteItem(paletteId: string, index: number, item: IBlockPaletteItem): void
Parameters
- paletteId: string
- index: number
- item: IBlockPaletteItem
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

setPrimaryPalette

setPrimaryPalette(paletteId: string): void
Parameters
- paletteId: string
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

setSelectedItem

setSelectedItem(item: IBlockPaletteItem): void
Parameters
- item: IBlockPaletteItem
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.