Class WorldFeature

Hierarchy (View Summary)

Feature
- WorldFeature

Index

Constructors

Properties

identifier world identifier

Methods

onAdd? onPlayerJoin? onPlayerLeave? onRemove? onTick?

Constructors

constructor

new WorldFeature(world: World): WorldFeature
Creates a new world feature.
Parameters
- world: World
  The world that this feature is attached to.
Returns WorldFeature
Overrides Feature.constructor
- Defined in packages/core/src/world/features/world/world.ts:15

Properties

`Readonly`identifier

identifier: string = ...

The unique identifier for this feature.

`Protected` `Readonly`world

world: World

The world that this feature is attached to.

`Static` `Readonly`identifier

identifier: string

The unique identifier for this feature.

Methods

`Optional`onAdd

onAdd(): void
Called when the feature is added to a world or dimension.

Returns void
Inherited from Feature.onAdd
- Defined in packages/core/src/world/features/feature.ts:33

`Optional`onPlayerJoin

onPlayerJoin(player: Player): void
Parameters
- player: Player
Returns void
- Defined in packages/core/src/world/features/world/world.ts:20

`Optional`onPlayerLeave

onPlayerLeave(player: Player): void
Parameters
- player: Player
Returns void
- Defined in packages/core/src/world/features/world/world.ts:22

`Optional`onRemove

onRemove(): void
Called when the feature is removed from a world or dimension.

Returns void
Inherited from Feature.onRemove
- Defined in packages/core/src/world/features/feature.ts:38

`Optional`onTick

onTick(details: FeatureOnTickDetails): void
Called every tick while the feature is active.
Parameters
- details: FeatureOnTickDetails
  The details of the tick.
Returns void
Inherited from Feature.onTick
- Defined in packages/core/src/world/features/feature.ts:28