Package com.pixelmonmod.pixelmon.api.events.battles

Class BattleEndEvent

java.lang.Object

net.minecraftforge.eventbus.api.Event

com.pixelmonmod.pixelmon.api.events.battles.BattleEvent

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

public class BattleEndEvent
extends BattleEvent

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.

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraftforge.eventbus.api.Event

net.minecraftforge.eventbus.api.Event.HasResult, net.minecraftforge.eventbus.api.Event.Result

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	abnormal
protected final BattleEndCause	cause
protected final Map<BattleParticipant,BattleResults>	results

Fields inherited from class com.pixelmonmod.pixelmon.api.events.battles.BattleEvent

battleController

Constructor Summary

Constructors

Constructor	Description
BattleEndEvent(BattleController bc, BattleEndCause cause, boolean abnormal, Map<BattleParticipant,BattleResults> results)

Method Summary

Modifier and Type	Method	Description
BattleEndCause	getCause()	Gets the cause of the battle end
List<net.minecraft.server.level.ServerPlayer>	getPlayers()	Gets a list of players that were involved in the battle
Optional<BattleResults>	getResult(net.minecraft.world.entity.Entity entity)	Gets the battle result for the entity given Will return an empty optional of cannot find that entity/player
Map<BattleParticipant,BattleResults>	getResults()	Gets the battle results per participant
boolean	isAbnormal()	Checks if the battle end was "abnormal"

Methods inherited from class com.pixelmonmod.pixelmon.api.events.battles.BattleEvent

getBattleController

Methods inherited from class net.minecraftforge.eventbus.api.Event

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

Methods inherited from class java.lang.Object

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

Field Details

cause

protected final BattleEndCause cause

abnormal

protected final boolean abnormal

results

protected final Map<BattleParticipant,BattleResults> results

Constructor Details

BattleEndEvent

public BattleEndEvent(BattleController bc,
 BattleEndCause cause,
 boolean abnormal,
 Map<BattleParticipant,BattleResults> results)

Method Details

getCause

public BattleEndCause getCause()

Gets the cause of the battle end

Returns:

The battle end cause

isAbnormal

public boolean isAbnormal()

Checks if the battle end was "abnormal"

Returns:

True if abnormal

getResults

public Map<BattleParticipant,BattleResults> getResults()

Gets the battle results per participant

Returns:

The participant

getResult

public Optional<BattleResults> getResult(net.minecraft.world.entity.Entity entity)

Gets the battle result for the entity given Will return an empty optional of cannot find that entity/player

Parameters:

entity - The entity to search for

Returns:

The result

getPlayers

public List<net.minecraft.server.level.ServerPlayer> getPlayers()

Gets a list of players that were involved in the battle

Returns:

A list of players