Class ItemPalette

constructor

• new ItemPalette(): ItemPalette

  Returns ItemPalette

ReadonlycreativeGroups

Readonlytraits

Readonlytypes

createContentGroup

• createContentGroup(properties?: Partial<CreateContentGroup>): CreateContentGroup

  Create a new creative content group.

  Parameters

  • Optionalproperties: Partial<CreateContentGroup>

    The properties of the creative content group.

  Returns CreateContentGroup

  The creative content group.

getAllCustomTypes

• getAllCustomTypes(): CustomItemType[]

  Returns CustomItemType[]

getAllTraits

• getAllTraits(): typeof ItemTrait[]

  Gets all item traits from the palette.

  Returns typeof ItemTrait[]

getAllTypes

• getAllTypes(): ItemType[]

  Gets all item types from the palette.

  Returns ItemType[]

  All item types from the palette.

getCreativeContentByIndex

• getCreativeContentByIndex(index: number): null | CreativeItemDescriptor

  Get creative content by index.

  Parameters

  • index: number

    The index of the creative content.

  Returns null | CreativeItemDescriptor

  The creative content by index.

getCreativeGroup

• getCreativeGroup(value: string | number): null | CreateContentGroup

  Get a creative content group from the palette.

  Parameters

  • value: string | number

    The index or identifier of the creative content group.

  Returns null | CreateContentGroup

  The creative content group from the palette, or null if not found.

getTrait

• getTrait(identifier: string): null | typeof ItemTrait

  Gets an item trait from the palette.

  Parameters

  • identifier: string

    The identifier of the item trait.

  Returns null | typeof ItemTrait

  The item trait from the palette.

getType

• getType(identifier: ItemIdentifier): null | ItemType

  Gets an item type from the palette.

  Parameters

  • identifier: ItemIdentifier

    The item identifier to get.

  Returns null | ItemType

  The item type from the palette.

registerCreativeGroup

• registerCreativeGroup(group: CreateContentGroup): boolean

  Register a creative group to the palette.

  Parameters

  • group: CreateContentGroup

    The creative group to register.

  Returns boolean

  True if the creative group was registered, false otherwise.

registerItemForCreativeGroup

• registerItemForCreativeGroup(group: CreativeItemGroup, type: ItemType): void

  Register an item for a creative content group.

  Parameters

  • group: CreativeItemGroup

    The creative content group.
  • type: ItemType

    The item type to register.

  Returns void

  The creative content group.

registerTrait

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

  Register an item trait to the palette.

  Parameters

  • ...traits: typeof ItemTrait[]

  Returns this

  True if the item trait was registered, false otherwise.

registerType

• registerType(...types: ItemType[]): this

  Parameters

  • ...types: ItemType[]

  Returns this

resolveType

• resolveType(type: BlockType): null | ItemType

  Resolves an item type from the block type.

  Parameters

  • type: BlockType

    The block type to resolve.

  Returns null | ItemType

  The item type from the palette.

unregisterCreativeGroup

• unregisterCreativeGroup(value: string | number): void

  Unregister a creative group from the palette.

  Parameters

  • value: string | number

    The index or identifier of the creative group to unregister.

  Returns void

unregisterTrait

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

  Unregister an item trait from the palette.

  Parameters

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

    The item trait to unregister, or the identifier of the item trait.

  Returns this

  The item palette instance.