Class Entity

constructor

• new Entity(
      dimension: Dimension,
      type: EntityIdentifier | EntityType,
      properties?: Partial<EntityProperties>,
  ): Entity

  Creates a new entity within a dimension.

  Parameters

  • dimension: Dimension

    The dimension to create the entity in
  • type: EntityIdentifier | EntityType

    The type of the entity to create
  • Optionalproperties: Partial<EntityProperties>

    Additional properties to assign to the entity

  Returns Entity

Readonlyattributes

dimension

ReadonlydynamicProperties

Readonlyflags

Readonlyidentifier

ReadonlyinputInfo

isAlive

isFalling

isMoving

isTicking

Readonlymetadata

onGround

Readonlyposition

Readonlyrotation

ReadonlyruntimeId

scoreboardIdentity

ReadonlysharedProperties

Readonlytags

Readonlytraits

Readonlytype

ReadonlyuniqueId

Readonlyvelocity

StaticruntimeId

alwaysShowNameTag

• get alwaysShowNameTag(): boolean

  Whether the entity name tag is always visible.

  Returns boolean
• set alwaysShowNameTag(value: boolean): void

  Whether the entity name tag is always visible.

  Parameters

  • value: boolean

  Returns void

isSneaking

• get isSneaking(): boolean

  Whether the entity is sneaking or not.

  Returns boolean

isSprinting

• get isSprinting(): boolean

  Whether the entity is sprinting or not.

  Returns boolean

isSwimming

• get isSwimming(): boolean

  Whether the entity is swimming or not.

  Returns boolean

lastAttacker

• get lastAttacker(): null | Entity

  Returns null | Entity

nameTag

• get nameTag(): string

  The name tag of the entity.

  Returns string
• set nameTag(value: string): void

  The name tag of the entity

  Parameters

  • value: string

  Returns void

scale

• get scale(): number

  The scale of the entity.

  Returns number
• set scale(value: number): void

  The scale of the entity.

  Parameters

  • value: number

  Returns void

variant

• get variant(): number

  The variant index of the entity.

  Returns number
• set variant(value: number): void

  The variant index of the entity.

  Parameters

  • value: number

  Returns void

world

• get world(): World

  The current world the entity is in.

  Returns World

addDynamicProperty

• addDynamicProperty<T extends JSONLikeValue>(key: string, value: T): void

  Adds a component to the entity.

  Type Parameters

  • T extends JSONLikeValue

  Parameters

  • key: string

    The key of the component.
  • value: T

    The value of the component.

  Returns void

addEffect

• addEffect(
      effectType: EffectType,
      duration: number,
      options?: EntityEffectOptions,
  ): void

  Add's an effect to the entity.

  Parameters

  • effectType: EffectType

    The effect type that will be applied to the entity
  • duration: number

    The duration of the effect in seconds.
  • Optionaloptions: EntityEffectOptions

  Returns void

addMotion

• addMotion(vector: Vector3f): void

  Adds motion to the entity.

  Parameters

  • vector: Vector3f

    The motion to add.

  Returns void

addTag

• addTag(tag: string): boolean

  Adds a tag to the entity.

  Parameters

  • tag: string

    The tag to add.

  Returns boolean

  Whether or not the tag was added.

addTrait

• addTrait<T extends typeof EntityTrait>(
      trait: EntityTrait | T,
      options?: ConstructorParameters<T>[1],
  ): InstanceType<T>

  Adds a trait to the entity.

  Type Parameters

  • T extends typeof EntityTrait

  Parameters

  • trait: EntityTrait | T

    The trait to add to the entity.
  • Optionaloptions: ConstructorParameters<T>[1]

    The additional options to pass to the trait.

  Returns InstanceType<T>

  The trait instance that was added to the entity.

applyImpulse

• applyImpulse(vector: Vector3f): void

  Applies an impulse to the entity.

  Parameters

  • vector: Vector3f

    The impulse to apply.

  Returns void

changeDimension

• changeDimension(dimension: Dimension): void

  Changes the dimension of the entity.

  Parameters

  • dimension: Dimension

    The dimension to change to.

  Returns void

clearMotion

• clearMotion(): void

  Clears the motion of the entity.

  Returns void

despawn

• despawn(options?: Partial<EntityDespawnOptions>): this

  Despawns the entity from the dimension.

  Parameters

  • Optionaloptions: Partial<EntityDespawnOptions>

  Returns this

dropItem

• dropItem(slot: number, amount: number, container: Container): boolean

  Forces the entity to drop an item from its inventory.

  Parameters

  • slot: number

    The slot to drop the item from.
  • amount: number

    The amount of items to drop.
  • container: Container

    The container to drop the item from.

  Returns boolean

  Whether or not the item was dropped.

executeCommand

• executeCommand<T = unknown>(command: string): CommandResponse<T>

  Executes a command as the entity.

  Type Parameters

  • T = unknown

  Parameters

  • command: string

    The command to execute.

  Returns CommandResponse<T>

  The response of the command.

executeCommandAsync

• executeCommandAsync<T = unknown>(command: string): Promise<CommandResponse<T>>

  Executes a command in the dimension asynchronously.

  Type Parameters

  • T = unknown

  Parameters

  • command: string

    The command to execute.

  Returns Promise<CommandResponse<T>>

  The response of the command.

getCardinalDirection

• getCardinalDirection(): CardinalDirection

  Gets the cardinal direction of the entity.

  Returns CardinalDirection

  The cardinal direction of the entity.

getChunk

• getChunk(): Chunk

  Gets the chunk the entity is currently in.

  Returns Chunk

  The chunk the entity is in

getCollisionHeight

• getCollisionHeight(): number

  Get the collision height of the entity.

  Returns number

  The collision height of the entity.

  Note

  This method depends on the EntityCollisionTrait trait.

getCollisionWidth

• getCollisionWidth(): number

  Get the collision width of the entity.

  Returns number

  The collision width of the entity.

  Note

  This method depends on the EntityCollisionTrait trait.

getContainer

• getContainer(name: ContainerName, dynamicId?: number): null | Container

  Get a container from the entity.

  Parameters

  • name: ContainerName

    The name of the container.
  • OptionaldynamicId: number

  Returns null | Container

getDataEntry

• getDataEntry(): EntityEntry

  Gets the entity's data as a database entry.

  Returns EntityEntry

  The entity entry object.

getDynamicProperty

• getDynamicProperty<T extends JSONLikeValue>(key: string): null | T

  Gets the specified component from the entity.

  Type Parameters

  • T extends JSONLikeValue

  Parameters

  • key: string

    The key of the component.

  Returns null | T

  The component if it exists, otherwise null.

getGravityForce

• getGravityForce(): number

  Gets the gravity force of the entity.

  Returns number

  The gravity force of the entity.

  Note

  This method depends on the EntityGravityTrait trait.

getHeadLocation

• getHeadLocation(): Vector3f

  Computes the entity's head location

  Returns Vector3f

getHeldItem

• getHeldItem(): null | ItemStack

  Gets the item the entity is currently holding.

  Returns null | ItemStack

  The item the entity is holding

getSelectedSlot

• getSelectedSlot(): number

  Gets the selected inventory slot of the entity.

  Returns number

  The selected hotbar index of the entity.

getSharedProperty

• getSharedProperty<T extends string | number | boolean>(
      identifier: string,
  ): null | T

  Get the shared property of the entity that is shared with the client.

  Type Parameters

  • T extends string | number | boolean

  Parameters

  • identifier: string

    The identifier of the property.

  Returns null | T

  The value of the property.

getTags

• getTags(): string[]

  Gets the tags of the entity.

  Returns string[]

  The tags of the entity.

getTrait

• getTrait<T extends typeof EntityTrait>(trait: T): InstanceType<T>

  Gets the specified trait from the entity.

  Type Parameters

  • T extends typeof EntityTrait

  Parameters

  • trait: T

    The trait to get from the entity

  Returns InstanceType<T>

  The trait if it exists, otherwise null
• getTrait(trait: string): null | EntityTrait

  Gets the specified trait from the entity.

  Parameters

  • trait: string

    The trait to get from the entity

  Returns null | EntityTrait

  The trait if it exists, otherwise null

getViewDirection

• getViewDirection(): Vector3f

  Computes the view direction vector based on the current pitch and yaw rotations.

  Returns Vector3f

  A Vector3f representing the direction the view is pointing.

hasDynamicProperty

• hasDynamicProperty(key: string): boolean

  Whether the entity has the specified component.

  Parameters

  • key: string

    The key of the component.

  Returns boolean

  Whether the entity has the component or not.

hasEffect

• hasEffect(effectType: EffectType): boolean

  Checks whether the entity has the effect or not.

  Parameters

  • effectType: EffectType

    The effect type to check if the entity has.

  Returns boolean

  whether the entity has the effect or not.

hasGravity

• hasGravity(): boolean

  Checks if the entity has gravity.

  Returns boolean

  Whether or not the entity has gravity.

  Note

  This method depends on the EntityGravityTrait trait.

hasTag

• hasTag(tag: string): boolean

  Whether or not the entity has a tag.

  Parameters

  • tag: string

    The tag to check.

  Returns boolean

  Whether or not the entity has the tag.

hasTrait

• hasTrait(trait: string | typeof EntityTrait): boolean

  Whether the entity has the specified trait.

  Parameters

  • trait: string | typeof EntityTrait

    The trait to check for

  Returns boolean

  Whether the entity has the trait

interact

• interact(origin: Player, method: EntityInteractMethod): void

  Causes a player to interact with the entity.

  Parameters

  • origin: Player

    The player that is interacting with the entity.
  • method: EntityInteractMethod

    The method that the player used to interact with the entity.

  Returns void

isItem

• isItem(): boolean

  Checks if the entity is an item.

  Returns boolean

  Whether or not the entity is an item.

isPlayer

• isPlayer(): this is Player

  Checks if the entity is a player.

  Returns this is Player

  Whether or not the entity is a player.

kill

• kill(options?: Partial<EntityDeathOptions>): void

  Kills the entity.

  Parameters

  • Optionaloptions: Partial<EntityDeathOptions>

    The options for the entity death.

  Returns void

loadDataEntry

• loadDataEntry(world: World, entry: EntityEntry, overwrite?: boolean): void

  Loads the entity from the provided entity entry.

  Parameters

  • world: World

    The world to the entity data is coming from
  • entry: EntityEntry

    The entity entry to load
  • overwrite: boolean = true

    Whether to overwrite the current entity data; default is true

  Returns void

removeDynamicProperty

• removeDynamicProperty(key: string): void

  Removes the specified component from the entity.

  Parameters

  • key: string

    The key of the component.

  Returns void

removeEffect

• removeEffect(effectType: EffectType): void

  Removes an effect from the entity.

  Parameters

  • effectType: EffectType

    The effect type to remove from the entity

  Returns void

removeTag

• removeTag(tag: string): boolean

  Removes a tag from the entity.

  Parameters

  • tag: string

    The tag to remove.

  Returns boolean

  Whether or not the tag was removed.

removeTrait

• removeTrait(trait: string | typeof EntityTrait): void

  Removes the specified trait from the entity.

  Parameters

  • trait: string | typeof EntityTrait

    The trait to remove

  Returns void

setCollisionHeight

• setCollisionHeight(height: number): void

  Set the collision height of the entity.

  Parameters

  • height: number

    The collision height to set.

  Returns void

  Note

  This method depends on the EntityCollisionTrait trait.

setCollisionWidth

• setCollisionWidth(width: number): void

  Set the collision width of the entity.

  Parameters

  • width: number

    The collision width to set.

  Returns void

  Note

  This method depends on the EntityCollisionTrait trait.

setDynamicProperty

• setDynamicProperty<T extends JSONLikeValue>(key: string, value: T): void

  Sets the component of the entity.

  Type Parameters

  • T extends JSONLikeValue

  Parameters

  • key: string

    The key of the component.
  • value: T

    The value of the component.

  Returns void

setGravityForce

• setGravityForce(force: number): void

  Sets the gravity force of the entity.

  Parameters

  • force: number

    The gravity force to set.

  Returns void

  Note

  This method depends on the EntityGravityTrait trait.

setMotion

• setMotion(vector?: Vector3f): void

  Sets the position of the entity.

  Parameters

  • Optionalvector: Vector3f

    The position to set.

  Returns void

setRotation

• setRotation(rotation: Rotation): void

  Sets and sends the entity head rotation

  Parameters

  • rotation: Rotation

    The new entity's head rotation

  Returns void

setSharedProperty

• setSharedProperty<T extends string | number | boolean>(
      identifier: string,
      value: T,
  ): void

  Sets the shared property of the entity that is shared with the client.

  Type Parameters

  • T extends string | number | boolean

  Parameters

  • identifier: string

    The identifier of the property.
  • value: T

    The value of the property.

  Returns void

spawn

• spawn(options?: Partial<EntitySpawnOptions>): this

  Spawns the entity into the dimension.

  Parameters

  • Optionaloptions: Partial<EntitySpawnOptions>

  Returns this

teleport

• teleport(position: Vector3f, dimension?: Dimension): void

  Teleport the entity to a new position.

  Parameters

  • position: Vector3f

    The position to teleport the entity to.
  • Optionaldimension: Dimension

    The dimension to teleport the entity to; optional.

  Returns void

StaticcreateUniqueId

• createUniqueId(network: number, runtimeId: bigint): bigint

  Creates a new unique id for the entity.

  Parameters

  • network: number

    The network id of the entity type
  • runtimeId: bigint

    The current runtime id of the entity

  Returns bigint

  A generated unique id for the entity