com.pixelmonmod.pixelmon.api.events.battles

Class BattleEndEvent

java.lang.Object

net.minecraftforge.fml.common.eventhandler.Event

com.pixelmonmod.pixelmon.api.events.battles.BattleEndEvent

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

Common battle ending event which fires exactly once, and for all battle ending, including abnormal endings.

This is the recommended event for all end-of-battle listening due to its comprehensive information and its guaranteed execution regardless of what means the battle ends by.

Created by Hiroku

Since:

December 3, 2017

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
boolean	abnormal Whether or not the battle ended in an abnormal (as in crash/error/forced) manner.
BattleControllerBase	bc The BattleControllerBase of the battle.
EnumBattleEndCause	cause The cause of the battle ending, as per EnumBattleEndCause.
com.google.common.collect.ImmutableMap<BattleParticipant,BattleResults>	results The battle results for each participant.

Constructor Summary

Constructors

Constructor and Description
BattleEndEvent(BattleControllerBase bc, EnumBattleEndCause cause, boolean abnormal, java.util.HashMap<BattleParticipant,BattleResults> results)

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.

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

bc

public final BattleControllerBase bc

The BattleControllerBase of the battle.

cause

public final EnumBattleEndCause cause

The cause of the battle ending, as per EnumBattleEndCause.

abnormal

public final boolean abnormal

Whether or not the battle ended in an abnormal (as in crash/error/forced) manner.

results

public final com.google.common.collect.ImmutableMap<BattleParticipant,BattleResults> results

The battle results for each participant. Not every participant is guaranteed to exist in this map.

Constructor Detail

BattleEndEvent

public BattleEndEvent(BattleControllerBase bc,
                      EnumBattleEndCause cause,
                      boolean abnormal,
                      java.util.HashMap<BattleParticipant,BattleResults> results)

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.