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

Properties

amplifier: number

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.

This property can throw when used.

displayName: string

Gets the player-friendly name of this effect.

This property can throw when used.

duration: number

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.

This property can throw when used.

typeId: string

Gets the type id of this effect.

This property can throw when used.

Methods

  • Returns boolean

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