Class PlayerCursorTrait

Readonlyidentifier

Readonlyplayer

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

OptionalonAttackEntity

• onAttackEntity(target: Entity): void

  Called when the player attacks an entity.

  Parameters

  • target: Entity

  Returns void

OptionalonChat

• onChat(message: string): boolean | void

  Called when the player sends a chat message.

  Parameters

  • message: string

    The message that the player sent.

  Returns boolean | void

  Whether the chat message was successful; default is true

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.

OptionalonGamemodeChange

• onGamemodeChange(previous: Gamemode): void

  Called when a players gamemode is changed.

  Parameters

  • previous: Gamemode

    The previous gamemode of the player.

  Returns void

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

OptionalonJump

• onJump(): void

  Called when the player jumps.

  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

OptionalonStartSneaking

• onStartSneaking(): void

  Called when the player starts sneaking.

  Returns void

OptionalonStartSprinting

• onStartSprinting(): void

  Called when the player starts sprinting.

  Returns void

OptionalonStopSneaking

• onStopSneaking(): void

  Called when the player stops sneaking.

  Returns void

OptionalonStopSprinting

• onStopSprinting(): void

  Called when the player stops sprinting.

  Returns void

OptionalonTick

• onTick(details: TraitOnTickDetails): void

  Called when the trait is ticked by the dimension.

  Parameters

  • details: TraitOnTickDetails

    The details about the tick event.

  Returns void