BallLogic (Pixelmon 1.16.5-9.1.7-pipe20926 API)

All Known Implementing Classes:

BeastBall, ChristmasBallLogic, DiveBall, DreamBall, DuskBall, FastBall, FriendBall, HealBall, HeavyBall, LevelBall, LoveBall, LureBall, LuxuryBall, MoonBall, NestBall, NetBall, QuickBall, RepeatBall, SafariBall, SportBall, TimerBall
```
public interface BallLogic
```
Interface representing the logic used by a PokeBall for capture purposes. The methods here are generally called by CaptureMethod in order to facilitate the capture calculation. You can determine if the capture attempt is in a battle by checking the PokeBallMode, or checking if a PixelmonWrapper is present in the Pokemon parameter. Instances of this are not registered - PokeBall creates new instances of this class from a provided classpath.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default void`	`doAfterEffect(PokeBall type, PokeBallEntity entity, PixelmonEntity pixelmon)` Action to be performed after a `Pokemon` is successfully caught in a `PokeBall` with this logic.
`default void`	`doFailEffect(PokeBall type, PokeBallEntity entity, PixelmonEntity pixelmon)` Action to be performed after a `Pokemon` is unsuccessfully caught in a `PokeBall` with this logic.
`default double`	`getCatchBonus(PokeBall type, PokeBallEntity entity, net.minecraft.entity.player.PlayerEntity thrower, Pokemon pokemon, PokeBallMode mode)` Get the ball bonus of this ball logic.
`default int`	`modifyCaptureRate(PokeBall type, PokeBallEntity entity, Pokemon pokemon, int catchRate)` Get the modified catch rate of the `Pokemon` being caught in a `PokeBall` with this logic.

- Method Detail
  - getCatchBonus
```
default double getCatchBonus(PokeBall type,
                             @Nullable
                             PokeBallEntity entity,
                             net.minecraft.entity.player.PlayerEntity thrower,
                             Pokemon pokemon,
                             PokeBallMode mode)
```
    Get the ball bonus of this ball logic. This may be different depending on whether the capture attempt is in a battle or not.
    
    Parameters:
    
    type - The PokeBall being used.
    
    entity - The PokeBallEntity being thrown, if one is present.
    
    thrower - The player throwing the ball.
    
    pokemon - The Pokemon being caught.
    
    mode - The mode this capture attempt is in.
    
    Returns:
    
    The ball bonus of the Poké Ball given the provided parameters.
  - doAfterEffect
```
default void doAfterEffect(PokeBall type,
                           @Nullable
                           PokeBallEntity entity,
                           PixelmonEntity pixelmon)
```
    Action to be performed after a Pokemon is successfully caught in a PokeBall with this logic.
    
    Parameters:
    
    type - The PokeBall being used.
    
    entity - The PokeBallEntity being thrown, if one is present.
    
    pixelmon - The PixelmonEntity caught.
  - modifyCaptureRate
```
default int modifyCaptureRate(PokeBall type,
                              @Nullable
                              PokeBallEntity entity,
                              Pokemon pokemon,
                              int catchRate)
```
    Get the modified catch rate of the Pokemon being caught in a PokeBall with this logic.
    
    Parameters:
    
    type - The PokeBall being used.
    
    entity - The PokeBallEntity being thrown, if one is present.
    
    pokemon - The Pokemon being caught.
    
    catchRate - The base catch rate of the Pokemon being caught.
    
    Returns:
    
    The modified catch rate of the Pokemon being caught.
  - doFailEffect
```
default void doFailEffect(PokeBall type,
                          @Nullable
                          PokeBallEntity entity,
                          PixelmonEntity pixelmon)
```
    Action to be performed after a Pokemon is unsuccessfully caught in a PokeBall with this logic.
    
    Parameters:
    
    type - The PokeBall being used.
    
    entity - The PokeBallEntity being thrown, if one is present.
    
    pixelmon - The PixelmonEntity that failed to be caught.

Interface BallLogic

Method Summary

Method Detail

getCatchBonus

doAfterEffect

modifyCaptureRate

doFailEffect