Class EntityAttributeTrait

Hierarchy (View Summary)

EntityTrait
- EntityAttributeTrait

Index

Constructors

constructor

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

Properties

attribute

attribute: AttributeName

The attribute name associated with the trait

`Protected` `Readonly`entity

entity: Entity

The entity that this trait is attached to.

`Readonly`identifier

identifier: string = ...

The identifier of the trait.

sync

sync: boolean = true

Whether the trait will be synchronized with the client

`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

currentValue

get currentValue(): number
The current value of the attribute

Returns number
- Defined in packages/core/src/entity/traits/attribute/attribute.ts:101
set currentValue(value: number): void
The current value of the attribute
Parameters
- value: number
Returns void
- Defined in packages/core/src/entity/traits/attribute/attribute.ts:112

defaultValue

get defaultValue(): number
The default value of the attribute

Returns number
- Defined in packages/core/src/entity/traits/attribute/attribute.ts:76
set defaultValue(value: number): void
The default value of the attribute
Parameters
- value: number
Returns void
- Defined in packages/core/src/entity/traits/attribute/attribute.ts:87

`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

maximumValue

get maximumValue(): number
The maximum value of the attribute

Returns number
- Defined in packages/core/src/entity/traits/attribute/attribute.ts:51
set maximumValue(value: number): void
The maximum value of the attribute
Parameters
- value: number
Returns void
- Defined in packages/core/src/entity/traits/attribute/attribute.ts:62

minimumValue

get minimumValue(): number
The minimum value of the attribute

Returns number
- Defined in packages/core/src/entity/traits/attribute/attribute.ts:26
set minimumValue(value: number): void
The minimum value of the attribute
Parameters
- value: number
Returns void
- Defined in packages/core/src/entity/traits/attribute/attribute.ts:37

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

getAttribute

getAttribute(): Attribute
Gets the saturation attribute of the entity

Returns Attribute
The saturation attribute of the entity
- Defined in packages/core/src/entity/traits/attribute/attribute.ts:127

onAdd

onAdd(properties?: AttributeProperties): void
Called when the trait is added to an object.
Parameters
- Optionalproperties: AttributeProperties
Returns void
Overrides EntityTrait.onAdd
- Defined in packages/core/src/entity/traits/attribute/attribute.ts:139

`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

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

`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

onRemove

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

Returns void
Overrides EntityTrait.onRemove
- Defined in packages/core/src/entity/traits/attribute/attribute.ts:159

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

`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

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

reset

reset(): void
Resets the current value of the attribute to the default value

Returns void
- Defined in packages/core/src/entity/traits/attribute/attribute.ts:134

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 EntityAttributeTrait

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns EntityAttributeTrait

Properties

attribute

Protected Readonlyentity

Readonlyidentifier

sync

Static Readonlycomponents

Static Readonlyidentifier

Static Readonlytypes

Accessors

currentValue

Returns number

Parameters

Returns void

defaultValue

Returns number

Parameters

Returns void

Protecteddimension

Returns Dimension

maximumValue

Returns number

Parameters

Returns void

minimumValue

Returns number

Parameters

Returns void

Methods

clone

Parameters

Returns this

getAttribute

Returns Attribute

onAdd

Parameters

Returns void

OptionalonCommand

Parameters

Returns boolean | void

OptionalonContainerUpdate

Parameters

Returns void

OptionalonDeath

Parameters

Returns void

OptionalonDespawn

Parameters

Returns void

OptionalonFallOnBlock

Parameters

Returns void

Note

OptionalonInteract

Parameters

Returns void

OptionalonRandomTick

Returns void

onRemove

Returns void

OptionalonSpawn

Parameters

Returns void

OptionalonTeleport

Parameters

Returns void

OptionalonTick

Parameters

Returns void

reset

`Protected` `Readonly`entity

`Readonly`identifier

`Static` `Readonly`components

`Static` `Readonly`identifier

`Static` `Readonly`types

`Protected`dimension

`Optional`onCommand

`Optional`onContainerUpdate

`Optional`onDeath

`Optional`onDespawn

`Optional`onFallOnBlock

`Optional`onInteract

`Optional`onRandomTick

`Optional`onSpawn

`Optional`onTeleport

`Optional`onTick