Class EffectBeta

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

Properties

amplifier displayName duration typeId

Methods

isValid

Properties

Readonly Betaamplifier

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.

Readonly BetadisplayName

displayName: string

Remarks

Gets the player-friendly name of this effect.

Throws

This property can throw when used.

Readonly Betaduration

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.

Readonly BetatypeId

typeId: string

Remarks

Gets the type id of this effect.

Throws

This property can throw when used.

Methods

isValid

  • isValid(): boolean
  • Beta

    Returns boolean

    Remarks

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

Settings

Member Visibility

On This Page

Properties
Methods