Package com.pixelmonmod.pixelmon.api.storage.research.impl

Class PixelmonPlayerResearchStage

java.lang.Object

com.pixelmonmod.pixelmon.api.storage.research.impl.PixelmonPlayerResearchStage

All Implemented Interfaces:

PlayerResearchStage

public class PixelmonPlayerResearchStage
extends Object
implements PlayerResearchStage

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLAIMED_REWARD_TAG
static final String	COMPLETE_TAG
static final String	OBJECTIVES_TAG

Constructor Summary

Constructors

Constructor	Description
PixelmonPlayerResearchStage(UUID player, ServerPlayerResearch parent, ResearchStage stage)

Method Summary

Modifier and Type	Method	Description
void	claimReward()	Claims the reward for this stage of research.
void	complete()	Completes this stage of research.
List<PlayerResearchObjective>	currentObjectives()	The objectives that the player has to complete in this stage of research.
void	deserialize(net.minecraft.nbt.CompoundTag tag)	Deserializes this stage of research from a CompoundTag.
boolean	handleInteractionEvent(InteractionEvent event, InteractionContext context)	Handles an interaction event that the player has with the research.
boolean	hasClaimedReward()	Whether the player has claimed the reward for this stage of research.
boolean	isComplete()	Whether the player has completed this stage of research.
net.minecraft.nbt.CompoundTag	serialize()	Serializes this stage of research to a CompoundTag.
ResearchStage	stage()	The research stage that this player is currently on.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.pixelmonmod.pixelmon.api.storage.research.PlayerResearchStage

canClaimReward, write

Field Details

COMPLETE_TAG

public static final String COMPLETE_TAG

See Also:

• Constant Field Values

CLAIMED_REWARD_TAG

public static final String CLAIMED_REWARD_TAG

See Also:

• Constant Field Values

OBJECTIVES_TAG

public static final String OBJECTIVES_TAG

See Also:

• Constant Field Values

Constructor Details

PixelmonPlayerResearchStage

public PixelmonPlayerResearchStage(UUID player,
 ServerPlayerResearch parent,
 ResearchStage stage)

Method Details

stage

public ResearchStage stage()

Description copied from interface: PlayerResearchStage

The research stage that this player is currently on.

Specified by:

stage in interface PlayerResearchStage

Returns:

The research stage that this player is currently on.

isComplete

public boolean isComplete()

Description copied from interface: PlayerResearchStage

Whether the player has completed this stage of research.

Specified by:

isComplete in interface PlayerResearchStage

Returns:

Whether the player has completed this stage of research.

hasClaimedReward

public boolean hasClaimedReward()

Description copied from interface: PlayerResearchStage

Whether the player has claimed the reward for this stage of research.

Specified by:

hasClaimedReward in interface PlayerResearchStage

Returns:

Whether the player has claimed the reward for this stage of research.

currentObjectives

public List<PlayerResearchObjective> currentObjectives()

Description copied from interface: PlayerResearchStage

The objectives that the player has to complete in this stage of research.

Specified by:

currentObjectives in interface PlayerResearchStage

Returns:

The objectives that the player has to complete in this stage of research.

handleInteractionEvent

public boolean handleInteractionEvent(InteractionEvent event,
 InteractionContext context)

Description copied from interface: PlayerResearchStage

Handles an interaction event that the player has with the research.

Specified by:

handleInteractionEvent in interface PlayerResearchStage

Parameters:

event - The event that the player interacted with.

context - The context of the interaction.

Returns:

If the event caused the research to progress (not complete)

claimReward

public void claimReward()

Description copied from interface: PlayerResearchStage

Claims the reward for this stage of research.

Specified by:

claimReward in interface PlayerResearchStage

complete

public void complete()

Description copied from interface: PlayerResearchStage

Completes this stage of research.

Specified by:

complete in interface PlayerResearchStage

serialize

public net.minecraft.nbt.CompoundTag serialize()

Description copied from interface: PlayerResearchStage

Serializes this stage of research to a CompoundTag.

Specified by:

serialize in interface PlayerResearchStage

Returns:

The serialized stage of research.

deserialize

public void deserialize(net.minecraft.nbt.CompoundTag tag)

Description copied from interface: PlayerResearchStage

Deserializes this stage of research from a CompoundTag.

Specified by:

deserialize in interface PlayerResearchStage

Parameters:

tag - The serialized stage of research.