Class EntityEffectsTrait

Hierarchy (View Summary)

EntityTrait
- EntityEffectsTrait

Index

Constructors

constructor

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

Properties

`Protected` `Readonly`entity

entity: Entity

The entity that this trait is attached to.

`Readonly`identifier

identifier: string = ...

The identifier of the trait.

`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: "effects"

The identifier of the trait.

`Static` `Readonly`type

type: EntityIdentifier[] = ...

`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:36

Methods

add

add(
    effectType: EffectType,
    duration: number,
    options?: EntityEffectOptions,
): void
Adds a new effect to the entity.
Parameters
- effectType: EffectType
  The type of the effect to add.
- duration: number
  The duration of the effect in ticks.
- Optionaloptions: EntityEffectOptions
Returns void
- Defined in packages/core/src/entity/traits/effects.ts:96

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:108

has

has(effectType: EffectType): boolean
Checks if the entity has an active effect of the specified type.
Parameters
- effectType: EffectType
  The type of the effect to check.
Returns boolean
true if the entity has an active effect of the specified type; otherwise, false.
- Defined in packages/core/src/entity/traits/effects.ts:84

`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:47

`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:88

`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:94

`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:68

onDespawn

onDespawn(): void
Called when the entity that this trait is attached to is despawned from a dimension.

Returns void
Overrides EntityTrait.onDespawn
- Defined in packages/core/src/entity/traits/effects.ts:180

`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:101

`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:81

`Optional`onRandomTick

onRandomTick(): void
Called when the trait is random ticked by the dimension.

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

`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:52

onSpawn

onSpawn(): void
Called then the entity that this trait is attached to is spawned into a dimension.

Returns void
Overrides EntityTrait.onSpawn
- Defined in packages/core/src/entity/traits/effects.ts:162

`Optional`onTeleport

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

onTick

onTick(): void
Called when the trait is ticked by the dimension.

Returns void
Overrides EntityTrait.onTick
- Defined in packages/core/src/entity/traits/effects.ts:29

remove

remove(effectType: EffectType): void
Parameters
- effectType: EffectType
Returns void
- Defined in packages/core/src/entity/traits/effects.ts:56

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
Inherited from EntityTrait.setRandomTickProbability
- Defined in packages/core/src/trait.ts:102

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.
Inherited from EntityTrait.shouldRandomTick
- Defined in packages/core/src/trait.ts:78

Class EntityEffectsTrait

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns EntityEffectsTrait

Properties

Protected Readonlyentity

Readonlyidentifier

Static Readonlycomponents

Static Readonlyidentifier

Static Readonlytype

Static Readonlytypes

Accessors

Protecteddimension

Returns Dimension

Methods

add

Parameters

Returns void

clone

Parameters

Returns this

has

Parameters

Returns boolean

OptionalonAdd

Returns void

OptionalonCommand

Parameters

Returns boolean | void

OptionalonContainerUpdate

Parameters

Returns void

OptionalonDeath

Parameters

Returns void

onDespawn

Returns void

OptionalonFallOnBlock

Parameters

Returns void

Note

OptionalonInteract

Parameters

Returns void

OptionalonRandomTick

Returns void

OptionalonRemove

Returns void

onSpawn

Returns void

OptionalonTeleport

Parameters

Returns void

onTick

Returns void

remove

Parameters

Returns void

setRandomTickProbability

Parameters

Returns void

shouldRandomTick

Parameters

Returns boolean

Settings

On This Page

`Protected` `Readonly`entity

`Readonly`identifier

`Static` `Readonly`components

`Static` `Readonly`identifier

`Static` `Readonly`type

`Static` `Readonly`types

`Protected`dimension

`Optional`onAdd

`Optional`onCommand

`Optional`onContainerUpdate

`Optional`onDeath

`Optional`onFallOnBlock

`Optional`onInteract

`Optional`onRandomTick

`Optional`onRemove

`Optional`onTeleport