Skip to main content

Class: Effect

Represents an effect - like poison - that has been added to an Entity.

Constructors​

new Effect()​

private new Effect(): Effect

Returns​

Effect

Properties​

amplifier​

readonly amplifier: number

Remarks​

Gets an amplifier that may have been applied to this effect. Sample values range typically from 0 to 4. Example: The effect 'Jump Boost II' will have an amplifier value of 1.

Throws​

This property can throw when used.

displayName​

readonly displayName: string

Remarks​

Gets the player-friendly name of this effect.

Throws​

This property can throw when used.

duration​

readonly duration: number

Remarks​

Gets the entire specified duration, in ticks, of this effect. There are 20 ticks per second. Use TicksPerSecond constant to convert between ticks and seconds.

Throws​

This property can throw when used.

typeId​

readonly typeId: string

Remarks​

Gets the type id of this effect.

Throws​

This property can throw when used.

Methods​

isValid()​

isValid(): boolean

Returns​

boolean

Remarks​

Returns whether an effect instance is available for use in this context.