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

Class PixelmonPlayerResearch

java.lang.Object

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

All Implemented Interfaces:

PlayerResearch, ServerPlayerResearch

public class PixelmonPlayerResearch
extends Object
implements ServerPlayerResearch

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPLETE_TAG
static final String	CURRENT_STAGE_TAG
static final String	RESEARCH_TAG
static final String	STAGE_TAG
static final String	UUID_TAG

Constructor Summary

Constructors

Constructor	Description
PixelmonPlayerResearch(UUID player)
PixelmonPlayerResearch(net.minecraft.world.entity.player.Player player, Research research)

Method Summary

Modifier and Type	Method	Description
boolean	abandon()	Abandons the research, if able to.
void	complete()	Completes the research.
void	completeStage()	Completes the current PlayerResearchStage and progresses to the next stage.
PlayerResearchStage	currentStage()
void	deserialize(net.minecraft.nbt.CompoundTag tag)	Deserializes the player research from a CompoundTag.
boolean	handleInteractionEvent(InteractionEvent event, InteractionContext context)	Handles an InteractionEvent that the player has triggered.
boolean	isComplete()
boolean	isFavorite()
@Nullable ResearchStage	nextStage()
net.minecraft.server.level.ServerPlayer	owner()	Gets the player which this research is for.
net.minecraft.nbt.CompoundTag	serialize()	Serializes the player research to a CompoundTag.
ResearchStorage	storage()	Gets the storage which this research is for.
void	toggleFavorite()	Toggles the favorite state of this research.
Research	type()
UUID	uuid()	Gets the UUID of this research instance.

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.PlayerResearch

isAssignment, isCollection, update, update, write

Field Details

UUID_TAG

public static final String UUID_TAG

See Also:

• Constant Field Values

RESEARCH_TAG

public static final String RESEARCH_TAG

See Also:

• Constant Field Values

CURRENT_STAGE_TAG

public static final String CURRENT_STAGE_TAG

See Also:

• Constant Field Values

STAGE_TAG

public static final String STAGE_TAG

See Also:

• Constant Field Values

COMPLETE_TAG

public static final String COMPLETE_TAG

See Also:

• Constant Field Values

Constructor Details

PixelmonPlayerResearch

public PixelmonPlayerResearch(net.minecraft.world.entity.player.Player player,
 Research research)

PixelmonPlayerResearch

public PixelmonPlayerResearch(UUID player)

Method Details

uuid

public UUID uuid()

Description copied from interface: PlayerResearch

Gets the UUID of this research instance.

Specified by:

uuid in interface PlayerResearch

Returns:

The UUID of this.

type

public Research type()

Specified by:

type in interface PlayerResearch

Returns:

The Research that this player research is for.

owner

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

Description copied from interface: PlayerResearch

Gets the player which this research is for.

Specified by:

owner in interface PlayerResearch

Specified by:

owner in interface ServerPlayerResearch

Returns:

The player which this is for.

storage

public ResearchStorage storage()

Description copied from interface: PlayerResearch

Gets the storage which this research is for.

Specified by:

storage in interface PlayerResearch

Returns:

The storage which this is for.

currentStage

public PlayerResearchStage currentStage()

Specified by:

currentStage in interface PlayerResearch

Returns:

The current PlayerResearchStage that the player is on.

nextStage

@Nullable
public @Nullable ResearchStage nextStage()

Specified by:

nextStage in interface PlayerResearch

Returns:

The next ResearchStage that the player will progress to.

isFavorite

public boolean isFavorite()

Specified by:

isFavorite in interface PlayerResearch

Returns:

Whether this research is marked as a favorite.

toggleFavorite

public void toggleFavorite()

Description copied from interface: PlayerResearch

Toggles the favorite state of this research.

Specified by:

toggleFavorite in interface PlayerResearch

isComplete

public boolean isComplete()

Specified by:

isComplete in interface PlayerResearch

Returns:

Whether the player has completed the research.

handleInteractionEvent

public boolean handleInteractionEvent(InteractionEvent event,
 InteractionContext context)

Description copied from interface: PlayerResearch

Handles an InteractionEvent that the player has triggered.

Specified by:

handleInteractionEvent in interface PlayerResearch

Parameters:

event - The event that the player has triggered.

context - The context of the interaction.

Returns:

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

complete

public void complete()

Description copied from interface: PlayerResearch

Completes the research.

Specified by:

complete in interface PlayerResearch

completeStage

public void completeStage()

Description copied from interface: PlayerResearch

Completes the current PlayerResearchStage and progresses to the next stage.
This will also call PlayerResearch.complete() if the player has completed the research.

Specified by:

completeStage in interface PlayerResearch

abandon

public boolean abandon()

Description copied from interface: PlayerResearch

Abandons the research, if able to.

Specified by:

abandon in interface PlayerResearch

Returns:

Whether this research was abandoned or not.

serialize

public net.minecraft.nbt.CompoundTag serialize()

Description copied from interface: PlayerResearch

Serializes the player research to a CompoundTag.

Specified by:

serialize in interface PlayerResearch

Returns:

The serialized player research.

deserialize

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

Description copied from interface: PlayerResearch

Deserializes the player research from a CompoundTag.

Specified by:

deserialize in interface PlayerResearch

Parameters:

tag - The tag to deserialize from.