Class PlayerTrait

Hierarchy (View Summary)

EntityTrait
- PlayerTrait

Index

Constructors

constructor

new PlayerTrait(entity: Entity, _options?: unknown): PlayerTrait
Creates a new instance of the entity trait.
Parameters
- entity: Entity
  The entity that this trait will be attached to.
- Optional_options: unknown
Returns PlayerTrait
Inherited from EntityTrait.constructor
- Defined in packages/core/src/entity/traits/trait.ts:44

Properties

`Protected` `Readonly`entity

entity: Entity

The entity that this trait is attached to.

`Readonly`identifier

identifier: string = ...

The identifier of the trait.

`Readonly`player

player: Player = ...

The player that this trait is attached to.

`Static` `Readonly`components

components: string[] = []

The entity component identifiers that this trait is compatible with by default. If empty, the trait will not be initialized by any component.

`Static` `Readonly`identifier

identifier: string

The identifier of the trait.

`Static` `Readonly`types

types: EntityIdentifier[] = []

The entity type identifiers that this trait is compatible with by default.

Accessors

`Protected`dimension

get dimension(): Dimension
The dimension that the entity is in.

Returns Dimension
Inherited from EntityTrait.dimension
- Defined in packages/core/src/entity/traits/trait.ts:35

Methods

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.
Inherited from EntityTrait.clone
- Defined in packages/core/src/entity/traits/trait.ts:101

`Optional`onAdd

onAdd(): void
Called when the trait is added to an object.

Returns void
Inherited from EntityTrait.onAdd
- Defined in packages/core/src/trait.ts:42

`Optional`onAttackEntity

onAttackEntity(target: Entity): void
Called when the player attacks an entity.
Parameters
- target: Entity
Returns void
- Defined in packages/core/src/entity/traits/player/trait.ts:55

`Optional`onChat

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
- Defined in packages/core/src/entity/traits/player/trait.ts:18

`Optional`onCommand

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.
Inherited from EntityTrait.onCommand
- Defined in packages/core/src/entity/traits/trait.ts:81

`Optional`onContainerUpdate

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
Inherited from EntityTrait.onContainerUpdate
- Defined in packages/core/src/entity/traits/trait.ts:87

`Optional`onDeath

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
Inherited from EntityTrait.onDeath
- Defined in packages/core/src/entity/traits/trait.ts:67

`Optional`onDespawn

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
Inherited from EntityTrait.onDespawn
- Defined in packages/core/src/entity/traits/trait.ts:61

`Optional`onFallOnBlock

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.
Inherited from EntityTrait.onFallOnBlock
- Defined in packages/core/src/entity/traits/trait.ts:94

`Optional`onGamemodeChange

onGamemodeChange(previous: Gamemode): void
Called when a players gamemode is changed.
Parameters
- previous: Gamemode
  The previous gamemode of the player.
Returns void
- Defined in packages/core/src/entity/traits/player/trait.ts:24

`Optional`onInteract

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
Inherited from EntityTrait.onInteract
- Defined in packages/core/src/entity/traits/trait.ts:74

`Optional`onJump

onJump(): void
Called when the player jumps.

Returns void
- Defined in packages/core/src/entity/traits/player/trait.ts:29

`Optional`onRemove

onRemove(): void
Called when the trait is removed from an object.

Returns void
Inherited from EntityTrait.onRemove
- Defined in packages/core/src/trait.ts:47

`Optional`onSpawn

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
Inherited from EntityTrait.onSpawn
- Defined in packages/core/src/entity/traits/trait.ts:55

`Optional`onStartSneaking

onStartSneaking(): void
Called when the player starts sneaking.

Returns void
- Defined in packages/core/src/entity/traits/player/trait.ts:34

`Optional`onStartSprinting

onStartSprinting(): void
Called when the player starts sprinting.

Returns void
- Defined in packages/core/src/entity/traits/player/trait.ts:44

`Optional`onStopSneaking

onStopSneaking(): void
Called when the player stops sneaking.

Returns void
- Defined in packages/core/src/entity/traits/player/trait.ts:39

`Optional`onStopSprinting

onStopSprinting(): void
Called when the player stops sprinting.

Returns void
- Defined in packages/core/src/entity/traits/player/trait.ts:49

`Optional`onTick

onTick(details: TraitOnTickDetails): void
Called when the trait is ticked by the dimension.
Parameters
- details: TraitOnTickDetails
  The details about the tick event.
Returns void
Inherited from EntityTrait.onTick
- Defined in packages/core/src/trait.ts:53

Class PlayerTrait

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PlayerTrait

Properties

Protected Readonlyentity

Readonlyidentifier

Readonlyplayer

Static Readonlycomponents

Static Readonlyidentifier

Static Readonlytypes

Accessors

Protecteddimension

Returns Dimension

Methods

clone

Parameters

Returns this

OptionalonAdd

Returns void

OptionalonAttackEntity

Parameters

Returns void

OptionalonChat

Parameters

Returns boolean | void

OptionalonCommand

Parameters

Returns boolean | void

OptionalonContainerUpdate

Parameters

Returns void

OptionalonDeath

Parameters

Returns void

OptionalonDespawn

Parameters

Returns void

OptionalonFallOnBlock

Parameters

Returns void

Note

OptionalonGamemodeChange

Parameters

Returns void

OptionalonInteract

Parameters

Returns void

OptionalonJump

Returns void

OptionalonRemove

Returns void

OptionalonSpawn

Parameters

Returns void

OptionalonStartSneaking

Returns void

OptionalonStartSprinting

Returns void

OptionalonStopSneaking

Returns void

OptionalonStopSprinting

Returns void

OptionalonTick

Parameters

Returns void

Settings

On This Page

`Protected` `Readonly`entity

`Readonly`identifier

`Readonly`player

`Static` `Readonly`components

`Static` `Readonly`identifier

`Static` `Readonly`types

`Protected`dimension

`Optional`onAdd

`Optional`onAttackEntity

`Optional`onChat

`Optional`onCommand

`Optional`onContainerUpdate

`Optional`onDeath

`Optional`onDespawn

`Optional`onFallOnBlock

`Optional`onGamemodeChange

`Optional`onInteract

`Optional`onJump

`Optional`onRemove

`Optional`onSpawn

`Optional`onStartSneaking

`Optional`onStartSprinting

`Optional`onStopSneaking

`Optional`onStopSprinting

`Optional`onTick