EffectBase (Pixelmon 1.16.5-9.1.7-pipe20926 API)

java.lang.Object
- com.pixelmonmod.pixelmon.battles.attacks.EffectBase

Direct Known Subclasses:

AttackModifierBase, ClearTerrain, IgnoreDefense, MultiTurnSpecialAttackBase, SpecialAttackBase, StatsEffect, StatsEffectPost, StatusBase, StrengthSap, ZCurse
```
public abstract class EffectBase
extends java.lang.Object
```
A move attribute that causes varying effects in battle.

Field Summary

Fields
Modifier and Type Field and Description

java.util.ArrayList<ModifierBase> modifiers
Chance modifiers for the effect.

Fields
Modifier and Type	Field and Description
`java.util.ArrayList<ModifierBase>`	`modifiers` Chance modifiers for the effect.

Constructor Summary

Constructors
Constructor and Description

EffectBase()
Initializes an effect.

EffectBase(boolean persists)
Initializes an effect.

Constructors
Constructor and Description
`EffectBase()` Initializes an effect.
`EffectBase(boolean persists)` Initializes an effect.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyEarlyEffect(PixelmonWrapper user)` Triggers before the move is used.
`abstract void`	`applyEffect(PixelmonWrapper user, PixelmonWrapper target)` Causes various effects during the move.
`void`	`applyEffectAfterAllTargets(PixelmonWrapper user)` Triggers after a Pokemon attacks all of its targets.
`void`	`applyEffectAfterStatus(PixelmonWrapper user)` Triggers at the end of every turn after residual status damage has been applied.
`void`	`applyEffectHitOrMiss(PixelmonWrapper user, PixelmonWrapper target)` Triggers after a Pokemon attacks, no matter if it hits or misses.
`AttackResult`	`applyEffectStart(PixelmonWrapper user, PixelmonWrapper target)` Causes effects before the move's power is calculated.
`void`	`applyMissEffect(PixelmonWrapper user, PixelmonWrapper target)` Triggers when the move misses.
`abstract boolean`	`cantMiss(PixelmonWrapper user)` Determines whether a move cannot miss.
`void`	`changeChance(float multiplier)` Modifies the chance of a modifier's secondary effect occurring.
`boolean`	`checkChance()` Randomly determines whether a secondary effect will occur based on the multiplier.
`void`	`dealtDamage(PixelmonWrapper attacker, PixelmonWrapper defender, Attack attack, DamageTypeEnum damageType)` Triggers when an attacker deals damage.
`boolean`	`doesPersist(PixelmonWrapper user)` Returns whether the move lasts multiple turns.
`float`	`getChance()` Gets the chance that the effect will occur.
`protected float`	`getWeightWithChance(float weight)` Chooses a weight for the effect based on the chance of it occurring.
`boolean`	`isChance()` Determines whether the move has a secondary effect.
`int`	`modifyDamage(int damage, PixelmonWrapper user, PixelmonWrapper target, Attack a)` Triggers when the Pokémon deals direct damage.
`int`	`modifyPriority(int priority, ImmutableAttack attack, PixelmonWrapper pw)` Modifies the priority of a move.
`double`	`modifyTypeEffectiveness(java.util.List<Element> effectiveTypes, Element moveType, double baseEffectiveness)` Modifies the type effectiveness of a move.
`double`	`modifyTypeEffectiveness(java.util.List<Element> effectiveTypes, Element moveType, double baseEffectiveness, BattleController bc)` Modifies the type effectiveness of a move.
`void`	`weightEffect(PixelmonWrapper pw, MoveChoice userChoice, java.util.List<MoveChoice> userChoices, java.util.List<MoveChoice> bestUserChoices, java.util.List<MoveChoice> opponentChoices, java.util.List<MoveChoice> bestOpponentChoices)` Determines a weight for the move that has this effect.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - modifiers
```
public java.util.ArrayList<ModifierBase> modifiers
```
    Chance modifiers for the effect.
- Constructor Detail
  - EffectBase
```
public EffectBase()
```
    Initializes an effect.
  - EffectBase
```
public EffectBase(boolean persists)
```
    Initializes an effect.
    
    Parameters:
    
    persists - Whether the effect is a multi-turn move.
- Method Detail
  - applyEffectStart
```
public AttackResult applyEffectStart(PixelmonWrapper user,
                                     PixelmonWrapper target)
```
    Causes effects before the move's power is calculated.
    
    Parameters:
    
    user - The move's user.
    
    target - The move's target.
    
    Returns:
    
    The result of the effect.
  - applyEffect
```
public abstract void applyEffect(PixelmonWrapper user,
                                 PixelmonWrapper target)
```
    Causes various effects during the move.
    
    Parameters:
    
    user - The move's user.
    
    target - The move's target.
  - checkChance
```
public boolean checkChance()
```
    Randomly determines whether a secondary effect will occur based on the multiplier.
    
    Returns:
    
    True if the secondary effect will occur.
  - isChance
```
public boolean isChance()
```
    Determines whether the move has a secondary effect.
    
    Returns:
    
    Whether the move has a secondary effect.
  - getChance
```
public float getChance()
```
    Gets the chance that the effect will occur.
    
    Returns:
    
    The chance that the effect will occur.
  - changeChance
```
public void changeChance(float multiplier)
```
    Modifies the chance of a modifier's secondary effect occurring.
    
    Parameters:
    
    multiplier - The multiplier to apply to the chance.
  - cantMiss
```
public abstract boolean cantMiss(PixelmonWrapper user)
```
    Determines whether a move cannot miss.
    
    Parameters:
    
    user - The move's user.
    
    Returns:
    
    Whether the move can't miss.
  - doesPersist
```
public boolean doesPersist(PixelmonWrapper user)
```
    Returns whether the move lasts multiple turns.
    
    Parameters:
    
    user - The move's user.
    
    Returns:
    
    Whether the move lasts multiple turns.
  - applyMissEffect
```
public void applyMissEffect(PixelmonWrapper user,
                            PixelmonWrapper target)
```
    Triggers when the move misses.
    
    Parameters:
    
    user - The move's user.
    
    target - The move's target.
  - applyEarlyEffect
```
public void applyEarlyEffect(PixelmonWrapper user)
```
    Triggers before the move is used.
    
    Parameters:
    
    user - The move's user.
  - applyEffectAfterAllTargets
```
public void applyEffectAfterAllTargets(PixelmonWrapper user)
```
    Triggers after a Pokemon attacks all of its targets.
    
    Parameters:
    
    user - The move's user.
  - applyEffectHitOrMiss
```
public void applyEffectHitOrMiss(PixelmonWrapper user,
                                 PixelmonWrapper target)
```
    Triggers after a Pokemon attacks, no matter if it hits or misses.
    
    Parameters:
    
    user - The move's user.
  - applyEffectAfterStatus
```
public void applyEffectAfterStatus(PixelmonWrapper user)
```
    Triggers at the end of every turn after residual status damage has been applied.
    
    Parameters:
    
    user - The Pokémon that attacked.
  - dealtDamage
```
public void dealtDamage(PixelmonWrapper attacker,
                        PixelmonWrapper defender,
                        Attack attack,
                        DamageTypeEnum damageType)
```
    Triggers when an attacker deals damage.
    
    Parameters:
    
    attacker - The source of the damage.
    
    defender - The target of the damage.
    
    attack - The attack used by the attacker.
    
    damageType - The type of damage that was dealt.
  - weightEffect
```
public void weightEffect(PixelmonWrapper pw,
                         MoveChoice userChoice,
                         java.util.List<MoveChoice> userChoices,
                         java.util.List<MoveChoice> bestUserChoices,
                         java.util.List<MoveChoice> opponentChoices,
                         java.util.List<MoveChoice> bestOpponentChoices)
```
    Determines a weight for the move that has this effect. Used for battle AI.
    
    Parameters:
    
    pw - The Pokémon using the move.
    
    userChoice - The move with this effect.
    
    userChoices - All choices the Pokémon has for the turn.
    
    bestUserChoices - The best offensive choices the Pokémon has for the turn.
    
    opponentChoices - All choices the opponent has for the turn.
    
    bestOpponentChoices - The best choices the opponent has for the turn.
  - getWeightWithChance
```
protected float getWeightWithChance(float weight)
```
    Chooses a weight for the effect based on the chance of it occurring. Used for battle AI.
    
    Parameters:
    
    weight - The weight to assign to the effect if it has more than a 50% chance of occurring.
    
    Returns:
    
    The weight to assign to the effect.
  - modifyTypeEffectiveness
```
public double modifyTypeEffectiveness(java.util.List<Element> effectiveTypes,
                                      Element moveType,
                                      double baseEffectiveness)
```
    Modifies the type effectiveness of a move.
    
    Parameters:
    
    effectiveTypes - The types of the Pokémon targeted by the move.
    
    moveType - The type of the move being used in the calculation.
    
    baseEffectiveness - The type effectiveness before modification.
    
    Returns:
    
    The new type effectiveness.
  - modifyTypeEffectiveness
```
public double modifyTypeEffectiveness(java.util.List<Element> effectiveTypes,
                                      Element moveType,
                                      double baseEffectiveness,
                                      BattleController bc)
```
    Modifies the type effectiveness of a move.
    
    Parameters:
    
    effectiveTypes - The types of the Pokémon targeted by the move.
    
    moveType - The type of the move being used in the calculation.
    
    baseEffectiveness - The type effectiveness before modification.
    
    bc - The active in use battle controller, this method calls the method without BC if unused specifically by the effect
    
    Returns:
    
    The new type effectiveness.
  - modifyPriority
```
public int modifyPriority(int priority,
                          ImmutableAttack attack,
                          PixelmonWrapper pw)
```
    Modifies the priority of a move.
    
    Parameters:
    
    priority - The current calculated priority.
    
    attack - The attack being used.
    
    pw - The Pokémon using the move.
    
    Returns:
    
    The new priority.
  - modifyDamage
```
public int modifyDamage(int damage,
                        PixelmonWrapper user,
                        PixelmonWrapper target,
                        Attack a)
```
    Triggers when the Pokémon deals direct damage.
    
    Parameters:
    
    damage - The amount of damage dealt.
    
    user - The attack's user.
    
    target - The attack's target.
    
    a - The attack.
    
    Returns:
    
    The modified damage.

Class EffectBase

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

modifiers

Constructor Detail

EffectBase

EffectBase

Method Detail

applyEffectStart

applyEffect

checkChance

isChance

getChance

changeChance

cantMiss

doesPersist

applyMissEffect

applyEarlyEffect

applyEffectAfterAllTargets

applyEffectHitOrMiss

applyEffectAfterStatus

dealtDamage

weightEffect

getWeightWithChance

modifyTypeEffectiveness

modifyTypeEffectiveness

modifyPriority

modifyDamage