Class EntityLookAtPlayerTrait

Readonlyidentifier

Static Readonlycomponents

clone

• clone(entity: Entity): this

  Clones the entity trait.

  Parameters

  • entity: Entity

    The entity to clone the trait to.

  Returns this

  A new entity trait.

OptionalonAdd

• onAdd(): void

  Called when the trait is added to an object.

  Returns void

OptionalonCommand

• onCommand(state: CommandExecutionState): boolean | void

  Called when the entity that this trait is attached executes a command.

  Parameters

  • state: CommandExecutionState

    The command execution state.

  Returns boolean | void

  Whether the command was successful; default is true.

OptionalonContainerUpdate

• onContainerUpdate(container: Container): void

  Called when a container that is attached to the entity is updated.

  Parameters

  • container: Container

    The container that was updated.

  Returns void

OptionalonDeath

• onDeath(details: EntityDeathOptions): void

  Called when the entity that this trait is attached to is killed.

  Parameters

  • details: EntityDeathOptions

    The details of the entity death.

  Returns void

OptionalonDespawn

• onDespawn(details: EntityDespawnOptions): void

  Called when the entity that this trait is attached to is despawned from a dimension.

  Parameters

  • details: EntityDespawnOptions

    The details of the entity despawn.

  Returns void

OptionalonFallOnBlock

• onFallOnBlock(event: EntityFallOnBlockTraitEvent): void

  Called when the entity that this trait is attached to falls on a block.

  Parameters

  • event: EntityFallOnBlockTraitEvent

    The event properties of the entity falling on a block.

  Returns void

  Note

  This event requires the entity to have EntityGravityTrait attached.

OptionalonInteract

• onInteract(player: Player, method: EntityInteractMethod): void

  Called when the entity that this trait is attached to is interacted with by a player.

  Parameters

  • player: Player

    The player that interacted with the entity.
  • method: EntityInteractMethod

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

  Returns void

OptionalonRandomTick

• onRandomTick(): void

  Called when the trait is random ticked by the dimension.

  Returns void

OptionalonRemove

• onRemove(): void

  Called when the trait is removed from an object.

  Returns void

OptionalonSpawn

• onSpawn(details: EntitySpawnOptions): void

  Called then the entity that this trait is attached to is spawned into a dimension.

  Parameters

  • details: EntitySpawnOptions

    The details of the entity spawn.

  Returns void

OptionalonTeleport

• onTeleport(details: EntityTeleportOptions): void

  Called when the entity that this trait is attached to is teleported.

  Parameters

  • details: EntityTeleportOptions

    The details of the entity teleport.

  Returns void

setRandomTickProbability

• setRandomTickProbability(numerator: number, denominator: number): void

  Sets the probability of this trait being randomly ticked each tick.

  Parameters

  • numerator: number

    The numerator of the probability fraction.
  • denominator: number

    The denominator of the probability fraction.

  Returns void

shouldRandomTick

• shouldRandomTick(factor?: number): boolean

  Wether this trait should be randomly ticked this tick.

  Parameters

  • factor: number = 1

    A factor to multiply the chance by. Default is 1.

  Returns boolean

  True if the trait should be randomly ticked, false otherwise.