Package com.pixelmonmod.pixelmon.api.pokemon.item.pokeball.logic

Interface BallLogic

All Known Implementing Classes:

BeastBall, ChristmasBallLogic, DiveBall, DreamBall, DuskBall, FastBall, FriendBall, HealBall, HeavyBall, HisuiBall, 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.

Field Summary

Fields

Modifier and Type	Field	Description
static final double	ULTRA_BEAST_RATE

Method Summary

Modifier and Type	Method	Description
default void	doAfterEffect(PokeBall type, PokeBallEntity entity, Pokemon pokemon)	Action to be performed after a Pokemon is successfully caught in a PokeBall with this logic.
default void	doAfterEffect(PokeBall type, PokeBallEntity entity, PixelmonEntity pixelmon)	Deprecated, for removal: This API element is subject to removal in a future version. by doAfterEffect(PokeBall, PokeBallEntity, Pokemon)
default void	doFailEffect(PokeBall type, PokeBallEntity entity, Pokemon pokemon)	Action to be performed after a Pokemon is unsuccessfully caught in a PokeBall with this logic.
default void	doFailEffect(PokeBall type, PokeBallEntity entity, PixelmonEntity pixelmon)	Deprecated, for removal: This API element is subject to removal in a future version. by doFailEffect(PokeBall, PokeBallEntity, Pokemon)
default double	getCatchBonus(PokeBall type, PokeBallEntity entity, net.minecraft.world.entity.player.Player 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.

Field Details

ULTRA_BEAST_RATE

static final double ULTRA_BEAST_RATE

See Also:

• Constant Field Values

Method Details

getCatchBonus

default double getCatchBonus(PokeBall type,
 @Nullable
 PokeBallEntity entity,
 net.minecraft.world.entity.player.Player 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

@Deprecated(since="9.3.15",
            forRemoval=true)
default void doAfterEffect(PokeBall type,
 @Nullable
 PokeBallEntity entity,
 PixelmonEntity pixelmon)

Deprecated, for removal: This API element is subject to removal in a future version.

by doAfterEffect(PokeBall, PokeBallEntity, Pokemon)

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.

doAfterEffect

default void doAfterEffect(PokeBall type,
 @Nullable
 PokeBallEntity entity,
 Pokemon pokemon)

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.

pokemon - The Pokemon 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

@Deprecated(since="9.3.15",
            forRemoval=true)
default void doFailEffect(PokeBall type,
 @Nullable
 PokeBallEntity entity,
 PixelmonEntity pixelmon)

Deprecated, for removal: This API element is subject to removal in a future version.

by doFailEffect(PokeBall, PokeBallEntity, Pokemon)

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.

doFailEffect

default void doFailEffect(PokeBall type,
 @Nullable
 PokeBallEntity entity,
 Pokemon pokemon)

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.

pokemon - The Pokemon that failed to be caught.