Package com.pixelmonmod.pixelmon.api.pokemon.ribbon.event

Class RibbonEvent.ReceiveRibbon

java.lang.Object

net.neoforged.bus.api.Event

com.pixelmonmod.pixelmon.api.pokemon.ribbon.event.RibbonEvent

com.pixelmonmod.pixelmon.api.pokemon.ribbon.event.RibbonEvent.ReceiveRibbon

Direct Known Subclasses:

RibbonEvent.ReceiveRibbon.Post, RibbonEvent.ReceiveRibbon.Pre

Enclosing class:

RibbonEvent

public static class RibbonEvent.ReceiveRibbon
extends RibbonEvent

The event relating to when a Pokemon is given a ribbon

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RibbonEvent.ReceiveRibbon.Post	Fired after the ribbon is given to the Pokemon
static class	RibbonEvent.ReceiveRibbon.Pre	Fired just before the ribbon is given Here you can modify the ribbon given, or if it will be set as the display ribbon Cancelling this will prevent the ribbon being given or displayed

Nested classes/interfaces inherited from class com.pixelmonmod.pixelmon.api.pokemon.ribbon.event.RibbonEvent

RibbonEvent.ReceiveRibbon, RibbonEvent.RemoveRibbon, RibbonEvent.SetDisplayedRibbon

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	shouldDisplay

Fields inherited from class com.pixelmonmod.pixelmon.api.pokemon.ribbon.event.RibbonEvent

pokemon, ribbon

Constructor Summary

Constructors

Constructor	Description
ReceiveRibbon(Pokemon pokemon, Ribbon ribbon, boolean shouldDisplay)

Method Summary

Modifier and Type	Method	Description
boolean	isShouldDisplay()	Will tell you if the ribbon given will be forced as the display ribbon

Methods inherited from class com.pixelmonmod.pixelmon.api.pokemon.ribbon.event.RibbonEvent

getPokemon, getRibbon

Methods inherited from class java.lang.Object

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

Field Details

shouldDisplay

protected boolean shouldDisplay

Constructor Details

ReceiveRibbon

public ReceiveRibbon(Pokemon pokemon,
 Ribbon ribbon,
 boolean shouldDisplay)

Method Details

isShouldDisplay

public boolean isShouldDisplay()

Will tell you if the ribbon given will be forced as the display ribbon

Returns:

True if it will be the new display ribbon