Class Trait

constructor

• new Trait(_options?: JSONLikeObject): Trait

  Creates a new instance of the trait.

  Parameters

  • Optional_options: JSONLikeObject

  Returns Trait

Readonlyidentifier

Static Readonlyidentifier

Static Readonlytypes

clone

• clone(..._arguments: unknown[]): Trait

  Clones the trait with the specified arguments.

  Parameters

  • ..._arguments: unknown[]

  Returns Trait

OptionalonAdd

• onAdd(): void

  Called when the trait is added to an object.

  Returns void

OptionalonRandomTick

• onRandomTick(): void

  Called when the trait is random ticked by the dimension.

  Returns void

OptionalonRemove

• onRemove(): void

  Called when the trait is removed from an object.

  Returns void

OptionalonTick

• onTick(details: TraitOnTickDetails): void

  Called when the trait is ticked by the dimension.

  Parameters

  • details: TraitOnTickDetails

    The details about the tick event.

  Returns void

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

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.