Class DimensionFeature

Hierarchy (View Summary)

Feature
- DimensionFeature
  - PhysicsFeature
  - VoidCheck

Index

Constructors

Properties

dimension identifier identifier

Methods

onAdd? onRemove? onTick?

Constructors

constructor

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

Properties

`Protected` `Readonly`dimension

dimension: Dimension

The dimension that this feature is attached to.

`Readonly`identifier

identifier: string = ...

The unique identifier for this feature.

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