com.pixelmonmod.pixelmon.api.events.battles

Class UseBattleItemEvent

java.lang.Object

net.minecraftforge.fml.common.eventhandler.Event

com.pixelmonmod.pixelmon.api.events.battles.UseBattleItemEvent

public class UseBattleItemEvent
extends net.minecraftforge.fml.common.eventhandler.Event

Event fired when an item is about to be used in battle. This is during the execution of battle turns, not in the moment that the participant decided to use an item.

The target, used ItemStack, and the additionalInfo (in the case of self-targeting item usage) are all mutable but if you decide to use these then first understand how they work for the item you're working with. For items being used on the user, the value of target and user will be the same. For items being used on a target, additionalInfo will be equal to -1.

Cancelling this event will prevent the item from being consumed and from any messages being sent about the item. Note: this will mean the user of the item will do nothing during their turn.

Created by Hiroku

Since:

March 11, 2019 (Pixelmon 7.0.4)

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraftforge.fml.common.eventhandler.Event

net.minecraftforge.fml.common.eventhandler.Event.HasResult, net.minecraftforge.fml.common.eventhandler.Event.Result

Field Summary

Fields

Modifier and Type	Field and Description
int	additionalInfo Additional information in integer form that the specific item might need to function.
BattleControllerBase	bcb The BattleControllerBase representing the battle this is occurring in.
BattleParticipant	participant The BattleParticipant who chose to use this item.
net.minecraft.item.ItemStack	stack The ItemStack being used on the Pokémon.
PixelmonWrapper	target The PixelmonWrapper being targeted with this item.
PixelmonWrapper	user The PixelmonWrapper whose turn is being consumed to use this item.

Constructor Summary

Constructors

Constructor and Description
UseBattleItemEvent(PixelmonWrapper user, PixelmonWrapper target, net.minecraft.item.ItemStack stack, int additionalInfo)

Method Summary

Methods inherited from class net.minecraftforge.fml.common.eventhandler.Event

getListenerList, getPhase, getResult, hasResult, isCancelable, isCanceled, setCanceled, setPhase, setResult, setup

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

bcb

public final BattleControllerBase bcb

The BattleControllerBase representing the battle this is occurring in.

participant

public final BattleParticipant participant

The BattleParticipant who chose to use this item.

user

public final PixelmonWrapper user

The PixelmonWrapper whose turn is being consumed to use this item.

target

public PixelmonWrapper target

The PixelmonWrapper being targeted with this item. In self-targeting cases, this is user

stack

public net.minecraft.item.ItemStack stack

The ItemStack being used on the Pokémon. This is the exact ItemStack from the inventory that will be consumed. You are free to modify this value so long as it is never null and is never wrapping an item that doesn't extend PixelmonItem.

additionalInfo

public int additionalInfo

Additional information in integer form that the specific item might need to function. At time of writing, this is -1 for when the item is self-targeting, and in the specific case of Ether usage it is the move index. In all other cases this is zero. As a consequence, this value only needs changing if you are changing the target move of an Ether usage or are changing the used item to an Ether. Highly unlikely, but here you go.

Constructor Detail

UseBattleItemEvent

public UseBattleItemEvent(PixelmonWrapper user,
                          PixelmonWrapper target,
                          net.minecraft.item.ItemStack stack,
                          int additionalInfo)