Class EntityPalette

constructor

• new EntityPalette(): EntityPalette

  Creates a new entity palette.

  Returns EntityPalette

Readonlytraits

Readonlytypes

getAllCustomTypes

• getAllCustomTypes(): CustomEntityType[]

  Returns CustomEntityType[]

getAllTraits

• getAllTraits(): (typeof EntityTrait | typeof PlayerTrait)[]

  Get all traits from the palette.

  Returns (typeof EntityTrait | typeof PlayerTrait)[]

getAllTypes

• getAllTypes(): EntityType[]

  Gets all entity types from the palette.

  Returns EntityType[]

  All entity types from the palette.

getTrait

• getTrait(identifier: string): null | typeof EntityTrait | typeof PlayerTrait

  Get a trait from the palette.

  Parameters

  • identifier: string

    The identifier of the trait.

  Returns null | typeof EntityTrait | typeof PlayerTrait

  The trait from the palette.

getType

• getType(identifier: string): null | EntityType

  Gets an entity type from the palette.

  Parameters

  • identifier: string

    The entity identifier to get.

  Returns null | EntityType

  The entity type from the palette.

getTypeByUnique

• getTypeByUnique(unique: bigint): null | EntityType

  Gets an entity type from the palette by its unique identifier.

  Parameters

  • unique: bigint

    The unique identifier of the entity type.

  Returns null | EntityType

  The entity type from the palette.

registerTrait

• registerTrait(...traits: (typeof EntityTrait | typeof PlayerTrait)[]): this

  Register a trait to the palette.

  Parameters

  • ...traits: (typeof EntityTrait | typeof PlayerTrait)[]

  Returns this

  True if the trait was registered, false otherwise.

registerType

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

  Register an entity type to the palette.

  Parameters

  • ...types: EntityType[]

  Returns this

unregisterTrait

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

  Remove a entity trait from the palette.

  Parameters

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

  Returns this