Weather (Pixelmon 1.16.5-9.1.7-pipe20926 API)

java.lang.Object
- com.pixelmonmod.pixelmon.battles.attacks.EffectBase
- - com.pixelmonmod.pixelmon.battles.status.StatusBase
  - - com.pixelmonmod.pixelmon.battles.status.GlobalStatusBase
    - - com.pixelmonmod.pixelmon.battles.status.Weather

Direct Known Subclasses:

Hail, MysteriousAirCurrent, Rainy, Sandstorm, Sunny
```
public abstract class Weather
extends GlobalStatusBase
```
A type of weather condition in battle.

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`extreme`
`protected java.lang.String`	`langContinue` The lang string to display each turn the weather is in effect.
`protected java.lang.String`	`langEnd` The lang string to display when the weather ends.
`protected java.lang.String`	`langStart` The lang string to display when the weather starts.
`protected int`	`turnsToGo` The amount of turns of the weather remaining.
`protected EnumHeldItems`	`weatherRock` The held item that increases the duration of the weather.

Fields inherited from class com.pixelmonmod.pixelmon.battles.status.StatusBase
type

Fields inherited from class com.pixelmonmod.pixelmon.battles.attacks.EffectBase
modifiers

Constructor Summary

Constructors
Constructor and Description
`Weather(StatusType type, int turnsToGo, EnumHeldItems weatherRock, java.lang.String langStart, java.lang.String langContinue, java.lang.String langEnd, boolean extreme)` Initializes a weather condition.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyEffect(PixelmonWrapper user, PixelmonWrapper target)` Causes various effects during the move.
`protected void`	`applyRepeatedEffect(BattleController bc)` Triggers at the end of every turn.
`void`	`applyRepeatedEffect(GlobalStatusController global)` Triggers at the end of every turn.
`protected abstract int`	`countBenefits(PixelmonWrapper user, PixelmonWrapper target)` Counts the number of ways that the target Pokémon benefits from the weather.
`protected abstract Weather`	`getNewInstance(int turns)` Gets a new instance of the subclass.
`int`	`getRemainingTurns()`
`void`	`setStartTurns(PixelmonWrapper user)` Sets the number of turns that the weather will last for according to the user.
`java.lang.String`	`toString()`
`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 com.pixelmonmod.pixelmon.battles.status.GlobalStatusBase
ignoreWeather, isTerrain, isWeather

Methods inherited from class com.pixelmonmod.pixelmon.battles.attacks.EffectBase
applyEarlyEffect, applyEffectAfterAllTargets, applyEffectAfterStatus, applyEffectHitOrMiss, applyEffectStart, applyMissEffect, changeChance, checkChance, dealtDamage, doesPersist, getChance, getWeightWithChance, isChance, modifyDamage, modifyPriority, modifyTypeEffectiveness, modifyTypeEffectiveness

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

- Field Detail
  - turnsToGo
```
protected transient int turnsToGo
```
    The amount of turns of the weather remaining.
  - weatherRock
```
protected EnumHeldItems weatherRock
```
    The held item that increases the duration of the weather.
  - langStart
```
protected transient java.lang.String langStart
```
    The lang string to display when the weather starts.
  - langContinue
```
protected transient java.lang.String langContinue
```
    The lang string to display each turn the weather is in effect.
  - langEnd
```
protected transient java.lang.String langEnd
```
    The lang string to display when the weather ends.
  - extreme
```
public transient boolean extreme
```
- Constructor Detail
  - Weather
```
public Weather(StatusType type,
               int turnsToGo,
               EnumHeldItems weatherRock,
               java.lang.String langStart,
               java.lang.String langContinue,
               java.lang.String langEnd,
               boolean extreme)
```
    Initializes a weather condition.
    
    Parameters:
    
    type - The weather's type.
    
    weatherRock - The held item that increases the duration of the weather.
    
    langStart - The lang string to display when the weather starts.
    
    langContinue - The lang string to display each turn the weather is in effect.
    
    langEnd - The lang string to display when the weather ends.
- Method Detail
  - applyEffect
```
public void applyEffect(PixelmonWrapper user,
                        PixelmonWrapper target)
```
    Description copied from class: EffectBase
    
    Causes various effects during the move.
    
    Overrides:
    
    applyEffect in class StatusBase
    
    Parameters:
    
    user - The move's user.
    
    target - The move's target.
  - setStartTurns
```
public void setStartTurns(PixelmonWrapper user)
```
    Sets the number of turns that the weather will last for according to the user.
    
    Parameters:
    
    user - The Pokémon initiating the weather.
  - getRemainingTurns
```
public int getRemainingTurns()
```
    Returns:
    
    The number of turns remaining for this status.
  - getNewInstance
```
protected abstract Weather getNewInstance(int turns)
```
    Gets a new instance of the subclass.
    
    Parameters:
    
    turns - The number of turns that the weather will last for.
    
    Returns:
    
    A new instance of the subclass.
  - applyRepeatedEffect
```
public void applyRepeatedEffect(GlobalStatusController global)
```
    Description copied from class: GlobalStatusBase
    
    Triggers at the end of every turn.
    
    Overrides:
    
    applyRepeatedEffect in class GlobalStatusBase
    
    Parameters:
    
    global - The battle's global status controller.
  - applyRepeatedEffect
```
protected void applyRepeatedEffect(BattleController bc)
```
    Triggers at the end of every turn.
    
    Parameters:
    
    bc - The battle that the weather is in.
  - 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)
```
    Description copied from class: EffectBase
    
    Determines a weight for the move that has this effect. Used for battle AI.
    
    Overrides:
    
    weightEffect in class EffectBase
    
    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.
  - countBenefits
```
protected abstract int countBenefits(PixelmonWrapper user,
                                     PixelmonWrapper target)
```
    Counts the number of ways that the target Pokémon benefits from the weather.
    
    Parameters:
    
    user - The Pokémon using the weather move.
    
    target - The Pokémon to count benefits for.
    
    Returns:
    
    The number of ways that the target Pokémon benefits from the weather.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Weather

Field Summary

Fields inherited from class com.pixelmonmod.pixelmon.battles.status.StatusBase

Fields inherited from class com.pixelmonmod.pixelmon.battles.attacks.EffectBase

Constructor Summary

Method Summary

Methods inherited from class com.pixelmonmod.pixelmon.battles.status.GlobalStatusBase

Methods inherited from class com.pixelmonmod.pixelmon.battles.status.StatusBase

Methods inherited from class com.pixelmonmod.pixelmon.battles.attacks.EffectBase

Methods inherited from class java.lang.Object

Field Detail

turnsToGo

weatherRock

langStart

langContinue

langEnd

extreme

Constructor Detail

Weather

Method Detail

applyEffect

setStartTurns

getRemainingTurns

getNewInstance

applyRepeatedEffect

applyRepeatedEffect

weightEffect

countBenefits

toString