PokéRogue
    Preparing search index...

    Interface ConditionalUserFieldProtectStatAbAttrParams

    Base set of parameters passed to every ability attribute's apply method.

    Extended by sub-classes to contain additional parameters pertaining to the ability type(s) being triggered.

    interface ConditionalUserFieldProtectStatAbAttrParams {
        cancelledStats: Set<ATK | DEF | SPATK | SPDEF | SPD | ACC | EVA>;
        changes: readonly StatChange[];
        passive?: boolean;
        pokemon: Pokemon;
        simulated?: boolean;
        target?: Pokemon;
    }

    Hierarchy (View Summary)

    Index

    Properties

    cancelledStats: Set<ATK | DEF | SPATK | SPDEF | SPD | ACC | EVA>

    All cancelled stat changes; a subset of stats. Any stat change which the ability cancels should be added to this set

    changes: readonly StatChange[]

    The stats being affected by the stat stage change

    passive?: boolean

    (For callers of applyAbAttrs): If provided, only apply ability attributes of the passive (true) or active (false).

    This should almost always be left undefined, as otherwise it will only apply attributes of either the pokemon's passive (true) or non-passive (false) ability. In almost all cases, you want to apply attributes that are from either.

    (For implementations of AbAttr): This will never be undefined, and will be true if the ability being applied is the pokemon's passive, and false otherwise.

    pokemon: Pokemon

    The pokemon that has the ability being applied

    simulated?: boolean

    Whether the ability's effects are being simulated (for instance, during AI damage calculations).

    Used to prevent message flyouts and other effects from being triggered.

    false

    target?: Pokemon

    The target of the stat stage change