Class Trait

Hierarchy (View Summary)

Trait

Index

Constructors

Properties

identifier identifier types

Methods

clone onAdd? onRemove? onTick?

Constructors

constructor

new Trait(_options?: JSONLikeObject): Trait
Creates a new instance of the trait.
Parameters
- Optional_options: JSONLikeObject
Returns Trait
- Defined in packages/core/src/trait.ts:35

Properties

`Readonly`identifier

identifier: string = ...

The identifier of the trait.

`Static` `Readonly`identifier

identifier: string

The identifier of the trait.

`Static` `Readonly`types

types: string[]

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

Methods

clone

clone(..._arguments: unknown[]): Trait
Clones the trait with the specified arguments.
Parameters
- ..._arguments: unknown[]
Returns Trait
- Defined in packages/core/src/trait.ts:59

`Optional`onAdd

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

Returns void
- Defined in packages/core/src/trait.ts:42

`Optional`onRemove

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

Returns void
- Defined in packages/core/src/trait.ts:47

`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
- Defined in packages/core/src/trait.ts:53