Class EntityUpgradeAfterEvent`Beta`

Contains information related to firing of a data driven entity version upgrade.

Source

export class EntityUpgradeAfterEvent {
    private constructor();
    readonly entity: Entity;
    readonly upgradeId: string;
    getModifiers(): DefinitionModifier[];
}

Index

Constructors

`Private`constructor

new EntityUpgradeAfterEvent(): EntityUpgradeAfterEvent
Returns EntityUpgradeAfterEvent

Properties

`Readonly`entity

entity: Entity

Remarks

Entity that the upgrade triggered on.

World Ready

This property can't be read in early-execution mode.

`Readonly`upgradeId

upgradeId: string

Remarks

Name of the data driven upgrade being triggered.

World Ready

This property can't be read in early-execution mode.

Methods

getModifiers

getModifiers(): DefinitionModifier[]
Returns DefinitionModifier[]
Remarks
An updateable list of modifications to component state that are the effect of this triggered upgrade.

World Ready
This function can't be called in early-execution mode.

Class EntityUpgradeAfterEvent`Beta`

Source

Index

Constructors

Properties

Methods

Constructors

`Private`constructor

Returns EntityUpgradeAfterEvent

Properties

`Readonly`entity

Remarks

World Ready

`Readonly`upgradeId

Remarks

World Ready

Methods

getModifiers

Returns DefinitionModifier[]

Remarks

World Ready

Settings

On This Page

Class EntityUpgradeAfterEventBeta

Source

Index

Constructors

Properties

Methods

Constructors

Privateconstructor

Returns EntityUpgradeAfterEvent

Properties

Readonlyentity

Remarks

World Ready

ReadonlyupgradeId

Remarks

World Ready

Methods

getModifiers

Returns DefinitionModifier[]

Remarks

World Ready

Settings

On This Page

Class EntityUpgradeAfterEvent`Beta`

`Private`constructor

`Readonly`entity

`Readonly`upgradeId