Script API - v1.21.120
    Preparing search index...

    Class Effect

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

    Index

    Constructors

    constructor

    Properties

    amplifier displayName duration isValid typeId

    Constructors

    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.

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

    displayName: string

    Gets the player-friendly name of this effect.

    This property can throw when used.

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

    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.

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

    isValid: boolean

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

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

    typeId: string

    Gets the type id of this effect.

    This property can throw when used.

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties