com.pixelmonmod.pixelmon.api.events.battles

Class ForceEndBattleEvent

java.lang.Object

net.minecraftforge.fml.common.eventhandler.Event

com.pixelmonmod.pixelmon.api.events.battles.ForceEndBattleEvent

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

Fired whenever a battle is about to be forcefully ended. Can be via /endbattle, or via a Fluffy Tail. Cancel to prevent the battle from ending. Cannot cancel ENDBATTLE_FORCEFUL. Created by Waterdude

Since:

March 28, 2021

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
BattleControllerBase	bc The BattleControllerBase of the battle.
EnumBattleForceEndCause	cause The cause of the battle forcefully ending, as per EnumBattleForceEndCause.

Constructor Summary

Constructors

Constructor and Description
ForceEndBattleEvent(BattleControllerBase bc, EnumBattleForceEndCause cause)

Method Summary

Modifier and Type	Method and Description
java.util.ArrayList<net.minecraft.entity.player.EntityPlayerMP>	getPlayers() Gets a potentially empty list of players that were in the battle.
boolean	isCancelable()

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

getListenerList, getPhase, getResult, hasResult, 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

bc

public final BattleControllerBase bc

The BattleControllerBase of the battle.

cause

public final EnumBattleForceEndCause cause

The cause of the battle forcefully ending, as per EnumBattleForceEndCause.

Constructor Detail

ForceEndBattleEvent

public ForceEndBattleEvent(BattleControllerBase bc,
                           EnumBattleForceEndCause cause)

Method Detail

getPlayers

public java.util.ArrayList<net.minecraft.entity.player.EntityPlayerMP> getPlayers()

Gets a potentially empty list of players that were in the battle.

isCancelable

public boolean isCancelable()

Overrides:

isCancelable in class net.minecraftforge.fml.common.eventhandler.Event