net.darkhax.gamestages.capabilities

Interface PlayerDataHandler.IStageData

All Known Implementing Classes:

PlayerDataHandler.DefaultStageData

Enclosing class:

PlayerDataHandler

public static interface PlayerDataHandler.IStageData

This is the backing interface for the custom player data. You don't need to do anything with this class, although it does define which methods you can use when working with stage data.

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all stages for the player.
net.minecraft.entity.player.EntityPlayer	getPlayer() Gets the player for the stage data.
java.util.Collection<java.lang.String>	getUnlockedStages() Gets the name of all unlocked stages.
boolean	hasUnlockedAll(java.util.Collection<java.lang.String> stages) Checks if a player has all of the passed stages.
boolean	hasUnlockedAnyOf(java.util.Collection<java.lang.String> stages) Checks if a player has any of the passed stages.
boolean	hasUnlockedStage(java.lang.String stage) Checks if a player has a stage unlocked.
void	lockStage(java.lang.String stage) Locks a stage again, for the player.
void	setPlayer(net.minecraft.entity.player.EntityPlayer player) Sets the player for the stage data.
void	unlockStage(java.lang.String stage) Unlocks a stage for the player.

Method Detail

getUnlockedStages

java.util.Collection<java.lang.String> getUnlockedStages()

Gets the name of all unlocked stages.

hasUnlockedStage

boolean hasUnlockedStage(@Nonnull
                         java.lang.String stage)

Checks if a player has a stage unlocked.

Parameters:

stage - The name of the stage to look for.

Returns:

Whether or not the player has the stage unlocked.

hasUnlockedAnyOf

boolean hasUnlockedAnyOf(java.util.Collection<java.lang.String> stages)

Checks if a player has any of the passed stages. The player only needs one to be true.

Parameters:

stages - The stages to check for, the player only needs one of them.

Returns:

Whether or not the player has any of the passed stages.

hasUnlockedAll

boolean hasUnlockedAll(java.util.Collection<java.lang.String> stages)

Checks if a player has all of the passed stages.

Parameters:

stages - The stages to check for, the player must have all of them.

Returns:

Whether or not the player has all of the passed stages.

unlockStage

void unlockStage(@Nonnull
                 java.lang.String stage)

Unlocks a stage for the player.

Parameters:

stage - The stage to unlock.

lockStage

void lockStage(@Nonnull
               java.lang.String stage)

Locks a stage again, for the player.

Parameters:

stage - The stage to lock.

setPlayer

void setPlayer(@Nonnull
               net.minecraft.entity.player.EntityPlayer player)

Sets the player for the stage data. This is for internal use.

Parameters:

player - The player to set.

clear

void clear()

Removes all stages for the player.

getPlayer

@Nullable
net.minecraft.entity.player.EntityPlayer getPlayer()

Gets the player for the stage data. Provided in this way for convenience.

Returns:

The player for the stage data.