MoveChoice (Pixelmon 1.16.5-9.1.7-pipe20926 API)

java.lang.Object
- com.pixelmonmod.pixelmon.battles.controller.ai.MoveChoice

All Implemented Interfaces:

java.lang.Comparable<MoveChoice>
```
public class MoveChoice
extends java.lang.Object
implements java.lang.Comparable<MoveChoice>
```
Represents the AI's move choice for the turn.

Field Summary

Fields
Modifier and Type	Field and Description
`Attack`	`attack` The attack to use.
`MoveResults`	`result` The result of the simulated attack.
`java.util.UUID`	`switchPokemon` The UUID of the Pokémon to switch to.
`java.util.List<PixelmonWrapper>`	`targets` The targets of the attack to use.
`int`	`tier` The tier of usefulness of the move.
`static int`	`TIER_KO` The move KOes an opponent or has a similar high-priority effect.
`static int`	`TIER_MINIMAL` The Pokémon will not be able to make use of the move before fainting if the opponent acts optimally.
`static int`	`TIER_NORMAL` The move has an effect in battle.
`static int`	`TIER_USELESS` The move has no beneficial effects.
`PixelmonWrapper`	`user` The Pokémon using the move.
`float`	`weight` The usefulness of the move within the tier.

Constructor Summary

Constructors
Constructor and Description
`MoveChoice(PixelmonWrapper user, Attack attack, java.util.List<PixelmonWrapper> targets)` Makes a choice to attack.
`MoveChoice(PixelmonWrapper user, java.util.UUID switchPokemon)` Makes a choice to switch.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`canBreakProtect(java.util.List<PixelmonWrapper> opponents, java.util.List<MoveChoice> choices)` Checks if the opponent can break through a Protect status.
`static boolean`	`canKOFromFull(java.util.List<MoveChoice> opponentChoices, PixelmonWrapper pw, int numTurns)` Checks if the opponent can KO the Pokémon at full heatlh within a certain number of turns.
`static boolean`	`canOHKO(java.util.List<MoveChoice> opponentChoices, PixelmonWrapper pw)` Checks if a list of choices contains a Pokémon that can OHKO the specified Pokémon.
`static boolean`	`canOutspeed(java.util.List<MoveChoice> opponentChoices, PixelmonWrapper pw, java.util.List<MoveChoice> userChoices)` Checks if an opponent can outspeed a Pokémon.
`static boolean`	`canOutspeedAnd2HKO(java.util.List<MoveChoice> opponentChoices, PixelmonWrapper pw)` Checks if a list of choices contains a Pokémon that can outspeed and at most 2HKO the specified Pokémon.
`static boolean`	`canOutspeedAnd2HKO(java.util.List<MoveChoice> opponentChoices, PixelmonWrapper pw, java.util.List<MoveChoice> userChoices)` Checks if a list of choices contains a Pokémon that can outspeed and at most 2HKO the specified Pokémon.
`static boolean`	`canOutspeedAndKO(int numTurns, java.util.List<MoveChoice> opponentChoices, PixelmonWrapper pw, java.util.List<MoveChoice> userChoices)`
`static boolean`	`canOutspeedAndOHKO(java.util.List<MoveChoice> opponentChoices, PixelmonWrapper pw, java.util.List<MoveChoice> userChoices)` Checks if a list of choices contains a Pokémon that can outspeed and OHKO the specified Pokémon.
`static void`	`checkBestChoice(MoveChoice choice, java.util.List<MoveChoice> bestChoices)` Checks whether a move choice is best and modifies the best choices if it is.
`static void`	`checkBestChoice(MoveChoice choice, java.util.List<MoveChoice> bestChoices, boolean excludeStatus)` Checks whether a move choice is best and modifies the best choices if it is.
`int`	`compareTo(MoveChoice otherChoice)`
`static java.util.List<MoveChoice>`	`createChoicesFromChoices(PixelmonWrapper pw, java.util.List<MoveChoice> choices, boolean includeAllies)` Creates a list of choices consisting of another list of choices's attacks.
`java.util.List<MoveChoice>`	`createList()` Makes a list containing the choice.
`static java.util.List<MoveChoice>`	`createMoveChoicesFromList(java.util.List<Attack> possibleAttacks, PixelmonWrapper pw)` Adds choices to a list based on a provided list of attacks.
`static java.util.List<MoveChoice>`	`getAffectedChoices(MoveChoice choice, java.util.List<MoveChoice> opponentChoices)` Filters a list of opponent choices to include only opponents that are affected by a move.
`static float`	`getMaxDamagePercent(PixelmonWrapper pw, java.util.List<MoveChoice> opponentChoices)` Gets the maximum percent damage a list of choices can do to a Pokémon.
`static float`	`getMaxPriority(java.util.List<MoveChoice> choices)` Gets the highest priority in a list of choices.
`static java.util.List<MoveChoice>`	`getTargetedChoices(PixelmonWrapper pw, java.util.List<MoveChoice> opponentChoices)`
`static boolean`	`hasAttackCategory(java.util.List<MoveChoice> choices, AttackCategory category)` Checks if a list of choices has a move that is in a certain attack category.
`static boolean`	`hasMove(java.util.List<MoveChoice> choices, java.util.Optional<ImmutableAttack>... moveNames)` Checks if a list of move choices has a move.
`static boolean`	`hasOffensiveAttackType(java.util.List<MoveChoice> choices, Element type)` Checks if a list of choices has an offensive move of a certain type.
`static boolean`	`hasPriority(java.util.List<MoveChoice>... choices)` Checks whether any choices in the given lists have priority.
`static boolean`	`hasSpreadMove(java.util.List<MoveChoice> choices)` Checks if a list of choices has a spread move.
`static boolean`	`hasSuccessfulAttackChoice(java.util.List<MoveChoice> choices, java.util.Optional<ImmutableAttack>... attackNames)` Checks if a list of choices has certain attacks that can be used successfully.
`boolean`	`hitsAlly()` Checks if the move choice hits an ally.
`boolean`	`isAttack()` Checks if the choice is an attack.
`boolean`	`isMiddleTier()` Checks if the choice's tier is one of the middle tiers.
`boolean`	`isOffensiveMove()` Checks if the choice is an offensive move.
`boolean`	`isSameType(MoveChoice other)` Checks if this choice is the same type (attack/switch) as another type.
`boolean`	`isSimilarWeight(MoveChoice other)` Checks if this choice has a similar weight as another choice.
`boolean`	`isStatusMove()` Checks if the choice is a status move.
`void`	`lowerTier(int newTier)` Lowers the tier of the choice.
`static java.util.List<MoveChoice>`	`mergeChoices(java.util.List<java.util.List<MoveChoice>> choices)` Merges a separated list of choices into one list.
`void`	`raiseTier(int newTier)` Raises the tier of the choice.
`void`	`raiseWeight(float newWeight)` Raises the weight of the choice.
`void`	`raiseWeightLimited(float newWeight)` Raises the weight of the choice, but not above 100.
`void`	`resetWeight()` Sets the choice's tier and weight to 0.
`void`	`setWeight(float newWeight)` Sets the weight of the choice.
`static java.util.List<java.util.List<MoveChoice>>`	`splitChoices(java.util.List<PixelmonWrapper> pokemonList, java.util.List<MoveChoice> choices)` Splits a list of choices into separate lists for each Pokémon's choice.
`static float`	`sumWeights(java.util.List<MoveChoice> choices)` Gets the sum of the weights of a list of choices.
`java.lang.String`	`toString()`

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

- Field Detail
  - user
```
public PixelmonWrapper user
```
    The Pokémon using the move.
  - attack
```
public Attack attack
```
    The attack to use.
  - targets
```
public java.util.List<PixelmonWrapper> targets
```
    The targets of the attack to use.
  - result
```
public MoveResults result
```
    The result of the simulated attack.
  - switchPokemon
```
public java.util.UUID switchPokemon
```
    The UUID of the Pokémon to switch to.
  - tier
```
public int tier
```
    The tier of usefulness of the move.
  - weight
```
public float weight
```
    The usefulness of the move within the tier.
  - TIER_USELESS
```
public static final int TIER_USELESS
```
    The move has no beneficial effects.
    
    See Also:
    
    Constant Field Values
  - TIER_MINIMAL
```
public static final int TIER_MINIMAL
```
    The Pokémon will not be able to make use of the move before fainting if the opponent acts optimally.
    
    See Also:
    
    Constant Field Values
  - TIER_NORMAL
```
public static final int TIER_NORMAL
```
    The move has an effect in battle.
    
    See Also:
    
    Constant Field Values
  - TIER_KO
```
public static final int TIER_KO
```
    The move KOes an opponent or has a similar high-priority effect.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MoveChoice
```
public MoveChoice(PixelmonWrapper user,
                  Attack attack,
                  java.util.List<PixelmonWrapper> targets)
```
    Makes a choice to attack.
    
    Parameters:
    
    attack - The attack to use.
    
    targets - the targets of the attack to use.
  - MoveChoice
```
public MoveChoice(PixelmonWrapper user,
                  java.util.UUID switchPokemon)
```
    Makes a choice to switch.
    
    Parameters:
    
    switchPokemon - The UUID of the Pokémon to switch to.
- Method Detail
  - isAttack
```
public boolean isAttack()
```
    Checks if the choice is an attack.
    
    Returns:
    
    Whether the choice is an attack.
  - isStatusMove
```
public boolean isStatusMove()
```
    Checks if the choice is a status move.
    
    Returns:
    
    Whether the choice is a status move.
  - isOffensiveMove
```
public boolean isOffensiveMove()
```
    Checks if the choice is an offensive move.
    
    Returns:
    
    Whether the choice is an offensive move.
  - isSameType
```
public boolean isSameType(MoveChoice other)
```
    Checks if this choice is the same type (attack/switch) as another type.
    
    Parameters:
    
    other - The choice to compare with.
    
    Returns:
    
    Whether this choice is the same type as the other type.
  - isSimilarWeight
```
public boolean isSimilarWeight(MoveChoice other)
```
    Checks if this choice has a similar weight as another choice.
    
    Parameters:
    
    other - The choice to compare with.
    
    Returns:
    
    Whether this choice has a similar weight as the other choice.
  - raiseWeight
```
public void raiseWeight(float newWeight)
```
    Raises the weight of the choice. Raises the tier to normal if it is currently useless and the weight is positive.
    
    Parameters:
    
    newWeight - The amount of weight to add to the current weight.
  - raiseWeightLimited
```
public void raiseWeightLimited(float newWeight)
```
    Raises the weight of the choice, but not above 100.
    
    Parameters:
    
    newWeight - The amount of weight to add to the current weight.
  - setWeight
```
public void setWeight(float newWeight)
```
    Sets the weight of the choice. Raises the tier to normal if it is currently useless and the weight is positive.
    
    Parameters:
    
    newWeight - The weight to set the choice to.
  - raiseTier
```
public void raiseTier(int newTier)
```
    Raises the tier of the choice. If the tier is already higher than the new tier, do nothing.
    
    Parameters:
    
    newTier - The new tier to set the choice to.
  - lowerTier
```
public void lowerTier(int newTier)
```
    Lowers the tier of the choice. If the tier is already lower than the new tier, do nothing.
    
    Parameters:
    
    newTier -
  - isMiddleTier
```
public boolean isMiddleTier()
```
    Checks if the choice's tier is one of the middle tiers.
    
    Returns:
    
    Whether the choice's tier is one of the middle tiers.
  - resetWeight
```
public void resetWeight()
```
    Sets the choice's tier and weight to 0.
  - hitsAlly
```
public boolean hitsAlly()
```
    Checks if the move choice hits an ally.
    
    Returns:
    
    Whether the move hits an ally.
  - createList
```
public java.util.List<MoveChoice> createList()
```
    Makes a list containing the choice.
    
    Returns:
    
    A list containing the choice.
  - compareTo
```
public int compareTo(MoveChoice otherChoice)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<MoveChoice>
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - checkBestChoice
```
public static void checkBestChoice(MoveChoice choice,
                                   java.util.List<MoveChoice> bestChoices)
```
    Checks whether a move choice is best and modifies the best choices if it is.
    
    Parameters:
    
    choice - The move choice to check.
    
    bestChoices - The current list of best choices.
  - checkBestChoice
```
public static void checkBestChoice(MoveChoice choice,
                                   java.util.List<MoveChoice> bestChoices,
                                   boolean excludeStatus)
```
    Checks whether a move choice is best and modifies the best choices if it is.
    
    Parameters:
    
    choice - The move choice to check.
    
    bestChoices - The current list of best choices.
    
    excludeStatus - Whether to exclude status moves from the choices.
  - getMaxPriority
```
public static float getMaxPriority(java.util.List<MoveChoice> choices)
```
    Gets the highest priority in a list of choices.
    
    Parameters:
    
    choices - The choices to find the highest priority for.
    
    Returns:
    
    The priority of the highest-priority choice in the list.
  - canOutspeed
```
public static boolean canOutspeed(java.util.List<MoveChoice> opponentChoices,
                                  PixelmonWrapper pw,
                                  java.util.List<MoveChoice> userChoices)
```
    Checks if an opponent can outspeed a Pokémon.
    
    Parameters:
    
    opponentChoices - The choices to check for outspeeding.
    
    pw - The Pokémon to check for being outsped.
    
    userChoices - The Pokémon's choice to search for priority moves.
    
    Returns:
    
    Whether an opponent choice can outspeed the Pokémon.
  - canOHKO
```
public static boolean canOHKO(java.util.List<MoveChoice> opponentChoices,
                              PixelmonWrapper pw)
```
    Checks if a list of choices contains a Pokémon that can OHKO the specified Pokémon.
    
    Parameters:
    
    opponentChoices - The choices to check for OHKOing the Pokémon.
    
    pw - The Pokémon to check for being OHKOed.
    
    Returns:
    
    Whether a choice can OHKO the Pokémon.
  - canOutspeedAndOHKO
```
public static boolean canOutspeedAndOHKO(java.util.List<MoveChoice> opponentChoices,
                                         PixelmonWrapper pw,
                                         java.util.List<MoveChoice> userChoices)
```
    Checks if a list of choices contains a Pokémon that can outspeed and OHKO the specified Pokémon.
    
    Parameters:
    
    opponentChoices - The choices to check for outspeeding and OHKOing the Pokémon.
    
    pw - The Pokémon to check for being outsped and OHKOed.
    
    Returns:
    
    Whether a choice can outspeed and OHKO the Pokémon.
  - canOutspeedAnd2HKO
```
public static boolean canOutspeedAnd2HKO(java.util.List<MoveChoice> opponentChoices,
                                         PixelmonWrapper pw)
```
    Checks if a list of choices contains a Pokémon that can outspeed and at most 2HKO the specified Pokémon.
    
    Parameters:
    
    opponentChoices - The choices to check for outspeeding and 2HKOing the Pokémon.
    
    pw - The Pokémon to check for being outsped and 2HKOed.
    
    Returns:
    
    Whether a choice can outspeed and 2HKO the Pokémon.
  - canOutspeedAnd2HKO
```
public static boolean canOutspeedAnd2HKO(java.util.List<MoveChoice> opponentChoices,
                                         PixelmonWrapper pw,
                                         java.util.List<MoveChoice> userChoices)
```
    Checks if a list of choices contains a Pokémon that can outspeed and at most 2HKO the specified Pokémon.
    
    Parameters:
    
    pw - The Pokémon to check for being outsped and 2HKOed.
    
    userChoices - The specified Pokémon choices to be checked for priority moves.
    
    opponentChoices - The choices to check for outspeeding and 2HKOing the Pokémon.
    
    Returns:
    
    Whether a choice can outspeed and 2HKO the Pokémon.
  - canOutspeedAndKO
```
public static boolean canOutspeedAndKO(int numTurns,
                                       java.util.List<MoveChoice> opponentChoices,
                                       PixelmonWrapper pw,
                                       java.util.List<MoveChoice> userChoices)
```
  - canKOFromFull
```
public static boolean canKOFromFull(java.util.List<MoveChoice> opponentChoices,
                                    PixelmonWrapper pw,
                                    int numTurns)
```
    Checks if the opponent can KO the Pokémon at full heatlh within a certain number of turns.
    
    Parameters:
    
    opponentChoices - The opponent choices for the turn.
    
    pw - The Pokémon to check for being KOed.
    
    numTurns - The maximum number of turns the opponent can take to KO the Pokémon.
    
    Returns:
    
    Whether the opponent can KO the Pokémon within the specified number of turns.
  - hasSuccessfulAttackChoice
```
@SafeVarargs
public static boolean hasSuccessfulAttackChoice(java.util.List<MoveChoice> choices,
                                                             java.util.Optional<ImmutableAttack>... attackNames)
```
    Checks if a list of choices has certain attacks that can be used successfully.
    
    Parameters:
    
    choices - The list of choices to search through.
    
    attackNames - The names of attacks to look for.
    
    Returns:
    
    Whether a list of choices has certain attacks that can be used successfully.
  - getAffectedChoices
```
public static java.util.List<MoveChoice> getAffectedChoices(MoveChoice choice,
                                                            java.util.List<MoveChoice> opponentChoices)
```
    Filters a list of opponent choices to include only opponents that are affected by a move.
    
    Parameters:
    
    choice - The move choice to be used.
    
    opponentChoices - A list of all opponent choices.
    
    Returns:
    
    A filtered list of opponent choices including only opponents that are affected by the specified move.
  - getTargetedChoices
```
public static java.util.List<MoveChoice> getTargetedChoices(PixelmonWrapper pw,
                                                            java.util.List<MoveChoice> opponentChoices)
```
  - hasPriority
```
@SafeVarargs
public static boolean hasPriority(java.util.List<MoveChoice>... choices)
```
    Checks whether any choices in the given lists have priority.
    
    Parameters:
    
    choices - The choices to check.
    
    Returns:
    
    Whether any choices in the given lists have priority.
  - splitChoices
```
public static java.util.List<java.util.List<MoveChoice>> splitChoices(java.util.List<PixelmonWrapper> pokemonList,
                                                                      java.util.List<MoveChoice> choices)
```
    Splits a list of choices into separate lists for each Pokémon's choice.
    
    Parameters:
    
    pokemonList - The different Pokémon that are using the choices.
    
    choices - The choices to split.
    
    Returns:
    
    Separated lists of choices for each Pokémon using them.
  - mergeChoices
```
public static java.util.List<MoveChoice> mergeChoices(java.util.List<java.util.List<MoveChoice>> choices)
```
    Merges a separated list of choices into one list.
    
    Parameters:
    
    choices - The separated list of choices to merge.
    
    Returns:
    
    A merged list of choices from the separated list.
  - createChoicesFromChoices
```
public static java.util.List<MoveChoice> createChoicesFromChoices(PixelmonWrapper pw,
                                                                  java.util.List<MoveChoice> choices,
                                                                  boolean includeAllies)
```
    Creates a list of choices consisting of another list of choices's attacks.
    
    Parameters:
    
    pw - The Pokémon using the choices.
    
    choices - The choices to create a new list of choices from.
    
    includeAllies - Whether to include moves that only target allies.
    
    Returns:
    
    A list of choices consisting of another list of choices's attacks.
  - getMaxDamagePercent
```
public static float getMaxDamagePercent(PixelmonWrapper pw,
                                        java.util.List<MoveChoice> opponentChoices)
```
    Gets the maximum percent damage a list of choices can do to a Pokémon.
    
    Parameters:
    
    pw - The Pokémon to get the maximum damage for.
    
    opponentChoices - The choices doing damage to the Pokémon.
    
    Returns:
    
    The maximum percent damage the list of choices can do to a Pokémon.
  - createMoveChoicesFromList
```
public static java.util.List<MoveChoice> createMoveChoicesFromList(java.util.List<Attack> possibleAttacks,
                                                                   PixelmonWrapper pw)
```
    Adds choices to a list based on a provided list of attacks.
    
    Parameters:
    
    possibleAttacks - The list of attacks to make choices for.
    
    pw - The Pokémon deciding on a move.
  - hasAttackCategory
```
public static boolean hasAttackCategory(java.util.List<MoveChoice> choices,
                                        AttackCategory category)
```
    Checks if a list of choices has a move that is in a certain attack category.
    
    Parameters:
    
    choices - The list of choices to search.
    
    category - The attack category to search for.
    
    Returns:
    
    Whether the list of choices has a move that is in the specified attack category.
  - hasOffensiveAttackType
```
public static boolean hasOffensiveAttackType(java.util.List<MoveChoice> choices,
                                             Element type)
```
    Checks if a list of choices has an offensive move of a certain type.
    
    Parameters:
    
    choices - The list of choices to search.
    
    type - The type to search for.
    
    Returns:
    
    Whether the list of choices has a move that is of the specified type.
  - hasSpreadMove
```
public static boolean hasSpreadMove(java.util.List<MoveChoice> choices)
```
    Checks if a list of choices has a spread move.
    
    Parameters:
    
    choices - The list of choices to search.
    
    Returns:
    
    Whether the list of choices has a spread move.
  - sumWeights
```
public static float sumWeights(java.util.List<MoveChoice> choices)
```
    Gets the sum of the weights of a list of choices.
    
    Parameters:
    
    choices - The list of choices to get a weight sum from.
    
    Returns:
    
    The sum of the weights of the list of choices.
  - canBreakProtect
```
public static boolean canBreakProtect(java.util.List<PixelmonWrapper> opponents,
                                      java.util.List<MoveChoice> choices)
```
    Checks if the opponent can break through a Protect status.
    
    Parameters:
    
    opponents - The opponents of the Protect user.
    
    choices - The move choices of the opponent on the next turn.
    
    Returns:
    
    Whether the opponent can break through a Protect status.
  - hasMove
```
@SafeVarargs
public static boolean hasMove(java.util.List<MoveChoice> choices,
                                           java.util.Optional<ImmutableAttack>... moveNames)
```
    Checks if a list of move choices has a move.
    
    Parameters:
    
    choices - The move choices to search in.
    
    moveNames - The moves to look for.
    
    Returns:
    
    Whether the list of move choices has a certain move.

Class MoveChoice

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

user

attack

targets

result

switchPokemon

tier

weight

TIER_USELESS

TIER_MINIMAL

TIER_NORMAL

TIER_KO

Constructor Detail

MoveChoice

MoveChoice

Method Detail

isAttack

isStatusMove

isOffensiveMove

isSameType

isSimilarWeight

raiseWeight

raiseWeightLimited

setWeight

raiseTier

lowerTier

isMiddleTier

resetWeight

hitsAlly

createList

compareTo

toString

checkBestChoice

checkBestChoice

getMaxPriority

canOutspeed

canOHKO

canOutspeedAndOHKO

canOutspeedAnd2HKO

canOutspeedAnd2HKO

canOutspeedAndKO

canKOFromFull

hasSuccessfulAttackChoice

getAffectedChoices

getTargetedChoices

hasPriority

splitChoices

mergeChoices

createChoicesFromChoices

getMaxDamagePercent

createMoveChoicesFromList

hasAttackCategory

hasOffensiveAttackType

hasSpreadMove

sumWeights

canBreakProtect

hasMove