Class ProbabilityBlockPaletteItem

Hierarchy (View Summary)

IBlockPaletteItem
- ProbabilityBlockPaletteItem

Index

Constructors

Methods

addBlock getBlock getBlocks getDisplayName getType removeBlockAt setBlock

Constructors

constructor

new ProbabilityBlockPaletteItem(
displayName?: string,
): ProbabilityBlockPaletteItem
Parameters
- OptionaldisplayName: string
Returns ProbabilityBlockPaletteItem
Overrides IBlockPaletteItem.constructor

Methods

addBlock

addBlock(block: string | BlockPermutation | BlockType, weight: number): void
Parameters
- block: string | BlockPermutation | BlockType
- weight: number
  Bounds: [1, 100]
Returns void
Remarks
This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

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

getBlock

getBlock(): BlockType
Returns BlockType
Inherited from IBlockPaletteItem.getBlock

getBlocks

getBlocks(): WeightedBlock[]
Returns WeightedBlock[]

getDisplayName

getDisplayName(): string
Returns string
Inherited from IBlockPaletteItem.getDisplayName

getType

getType(): BlockPaletteItemType
Returns BlockPaletteItemType
Inherited from IBlockPaletteItem.getType

removeBlockAt

removeBlockAt(index: number): void
Parameters
- index: number
Returns void
Remarks
This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

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

setBlock

setBlock(block: string | BlockPermutation | BlockType): void
Parameters
- block: string | BlockPermutation | BlockType
Returns void
Remarks
This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

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

Inherited from IBlockPaletteItem.setBlock