Class BlockPalette

constructor

• new BlockPalette(): BlockPalette

  Returns BlockPalette

Readonlypermutations

Readonlytraits

Readonlytypes

getAllCustomTypes

• getAllCustomTypes(): CustomBlockType[]

  Gets all custom block types from the palette.

  Returns CustomBlockType[]

  All custom block types from the palette.

getAllPermutations

• getAllPermutations(): BlockPermutation<keyof BlockState>[]

  Gets all block permutations from the palette.

  Returns BlockPermutation<keyof BlockState>[]

  All block permutations from the palette.

getAllTraits

• getAllTraits(): typeof BlockTrait[]

  Get all the traits from the palette.

  Returns typeof BlockTrait[]

  All the traits from the palette.

getAllTypes

• getAllTypes(): BlockType<keyof BlockState>[]

  Gets all block types from the palette.

  Returns BlockType<keyof BlockState>[]

  All block types from the palette.

getTrait

• getTrait(identifier: string, state?: null | string): null | typeof BlockTrait

  Get a trait from the palette.

  Parameters

  • identifier: string

    The identifier of the trait.
  • Optionalstate: null | string

    The state of the trait.

  Returns null | typeof BlockTrait

  The trait from the palette.

registerPermutation

• registerPermutation(permutation: BlockPermutation): boolean

  Register a block permutation to the palette.

  Parameters

  • permutation: BlockPermutation

    The block permutation to register.

  Returns boolean

  Whether the block permutation was registered.

registerTrait

• registerTrait(...traits: typeof BlockTrait[]): this

  Register a trait to the palette.

  Parameters

  • ...traits: typeof BlockTrait[]

  Returns this

  True if the trait was registered, false otherwise.

registerType

• registerType(...types: BlockType<keyof BlockState>[]): this

  Register a block type to the palette.

  Parameters

  • ...types: BlockType<keyof BlockState>[]

  Returns this

  Whether the block type was registered.

resolvePermutation

• resolvePermutation<T extends keyof BlockState>(
      identifier: T,
      state?: BlockState[T],
  ): BlockPermutation<T>

  Resolves a block permutation from the block identifier and state.

  Type Parameters

  • T extends keyof BlockState

  Parameters

  • identifier: T

    The block identifier to resolve.
  • Optionalstate: BlockState[T]

    The block state to resolve.

  Returns BlockPermutation<T>

  The block permutation from the palette.

resolveType

• resolveType(identifier: BlockIdentifier): BlockType

  Gets a block type from the palette.

  Parameters

  • identifier: BlockIdentifier

    The block identifier to get.

  Returns BlockType

  The block type from the palette.

unregisterTrait

• unregisterTrait(...types: (string | typeof BlockTrait)[]): this

  Removes a block trait from the palette.

  Parameters

  • ...types: (string | typeof BlockTrait)[]

  Returns this