Class CustomEntityType

Readonlycomponents

Readonlyidentifier

Readonlynetwork

Readonlytraits

Staticnetwork

Static Readonlytypes

createBooleanProperty

• createBooleanProperty(
      identifier: string,
      defaultValue?: boolean,
  ): EntityBooleanProperty

  Create a new boolean property for the entity type.

  Parameters

  • identifier: string

    The identifier of the property.
  • OptionaldefaultValue: boolean

    The default value of the property, if not specified, false will be used.

  Returns EntityBooleanProperty

  The created boolean property.

createEnumProperty

• createEnumProperty(
      identifier: string,
      values: string[],
      defaultValue?: string,
  ): EntityEnumProperty

  Create a new enum property for the entity type.

  Parameters

  • identifier: string

    The identifier of the property.
  • values: string[]

    The possible values of the property.
  • OptionaldefaultValue: string

    The default value of the property, if not specified, the first value will be used.

  Returns EntityEnumProperty

  The created enum property.

createFloatProperty

• createFloatProperty(
      identifier: string,
      range: [number, number],
      defaultValue?: number,
  ): EntityFloatProperty

  Create a new float property for the entity type.

  Parameters

  • identifier: string

    The identifier of the property.
  • range: [number, number]

    The value range of the property. (min to max)
  • OptionaldefaultValue: number

    The default value of the property, if not specified, minimum value will be used.

  Returns EntityFloatProperty

  The created float property.

createIntProperty

• createIntProperty(
      identifier: string,
      range: [number, number],
      defaultValue?: number,
  ): EntityIntProperty

  Create a new integer property for the entity type.

  Parameters

  • identifier: string

    The identifier of the property.
  • range: [number, number]

    The value range of the property. (min to max)
  • OptionaldefaultValue: number

    The default value of the property, if not specified, minimum value will be used.

  Returns EntityIntProperty

  The created integer property.

getAllProperties

• getAllProperties(): [string, EntityProperty][]

  Get all properties of the entity type.

  Returns [string, EntityProperty][]

  An array of all properties of the entity type.

getProperty

• getProperty<T extends EntityProperty = EntityProperty>(
      identifier: string,
  ): null | T

  Get a property of the entity type by its identifier.

  Type Parameters

  • T extends EntityProperty = EntityProperty

  Parameters

  • identifier: string

    The identifier of the property.

  Returns null | T

  The property if found, null otherwise.

hasProperty

• hasProperty(identifier: string): boolean

  Check if the entity type has a property with the given identifier.

  Parameters

  • identifier: string

    The identifier of the property.

  Returns boolean

  True if the property exists, false otherwise.

registerTrait

• registerTrait(trait: typeof EntityTrait): this

  Register a trait to the entity type.

  Parameters

  • trait: typeof EntityTrait

    The trait to register.

  Returns this

  The entity type instance.

unregisterTrait

• unregisterTrait(trait: string | typeof EntityTrait): this

  Unregister a trait from the entity type.

  Parameters

  • trait: string | typeof EntityTrait

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

  Returns this

  The entity type instance.

Staticget

• get(identifier: EntityIdentifier): null | EntityType

  Get the entity type from the registry.

  Parameters

  • identifier: EntityIdentifier

    The identifier of the entity type.

  Returns null | EntityType

  The entity type, if found; otherwise, null.

StaticgetAll

• getAll(): EntityType[]

  Get all entity types from the registry.

  Returns EntityType[]

  An array of all entity types.

StatictoNbt

• toNbt(type: EntityType): CompoundTag

  Parameters

  • type: EntityType

  Returns CompoundTag

StatictoPropertiesNbt

• toPropertiesNbt(type: EntityType): CompoundTag

  Parameters

  • type: EntityType

  Returns CompoundTag