Package com.pixelmonmod.pixelmon.api.research.event

Class ProgressResearchObjectiveEvent

java.lang.Object

net.neoforged.bus.api.Event

com.pixelmonmod.pixelmon.api.research.event.ProgressResearchObjectiveEvent

Direct Known Subclasses:

ProgressResearchObjectiveEvent.Post, ProgressResearchObjectiveEvent.Pre

public abstract class ProgressResearchObjectiveEvent
extends net.neoforged.bus.api.Event

An event that is fired when a player progresses an objective in a PlayerResearchStage.
This event is fired on the Pixelmon.EVENT_BUS.
This event does not relate to when the player gets the rewards for completing the objective as they have to manually claim the rewards through the user interface.
For events relating to the rewards, see ClaimResearchObjectiveEvent and ClaimResearchStageEvent.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProgressResearchObjectiveEvent.Post	This event is fired after the objective is progressed.
static class	ProgressResearchObjectiveEvent.Pre	This event is fired before the objective is progressed.

Field Summary

Fields

Modifier and Type	Field	Description
protected final StoredContext	context
protected final net.minecraft.core.Holder<InteractionEvent>	event
protected final PlayerResearchObjective	objective
protected final net.minecraft.server.level.ServerPlayer	player
protected final PlayerResearch	research
protected final PlayerResearchStage	stage

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ProgressResearchObjectiveEvent(net.minecraft.server.level.ServerPlayer player, PlayerResearch research, PlayerResearchStage stage, PlayerResearchObjective objective, net.minecraft.core.Holder<InteractionEvent> event, StoredContext context)

Method Summary

Modifier and Type	Method	Description
StoredContext	getContext()
net.minecraft.core.Holder<InteractionEvent>	getEvent()
PlayerResearchObjective	getObjective()
net.minecraft.server.level.ServerPlayer	getPlayer()
PlayerResearch	getResearch()
PlayerResearchStage	getStage()
boolean	willComplete()	This method is used to determine if the objective will be completed after the event is fired.

Methods inherited from class java.lang.Object

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

Field Details

player

protected final net.minecraft.server.level.ServerPlayer player

research

protected final PlayerResearch research

stage

protected final PlayerResearchStage stage

objective

protected final PlayerResearchObjective objective

event

protected final net.minecraft.core.Holder<InteractionEvent> event

context

protected final StoredContext context

Constructor Details

ProgressResearchObjectiveEvent

protected ProgressResearchObjectiveEvent(net.minecraft.server.level.ServerPlayer player,
 PlayerResearch research,
 PlayerResearchStage stage,
 PlayerResearchObjective objective,
 net.minecraft.core.Holder<InteractionEvent> event,
 StoredContext context)

Method Details

getPlayer

public net.minecraft.server.level.ServerPlayer getPlayer()

getResearch

public PlayerResearch getResearch()

getStage

public PlayerResearchStage getStage()

getObjective

public PlayerResearchObjective getObjective()

getEvent

public net.minecraft.core.Holder<InteractionEvent> getEvent()

getContext

public StoredContext getContext()

willComplete

public boolean willComplete()

This method is used to determine if the objective will be completed after the event is fired.
This is useful for determining if the player will be able to claim the rewards for the objective.
Note this may not give accurate results if called from the ProgressResearchObjectiveEvent.Post event.

Returns:

true if the objective will be completed after the event is fired, false otherwise