net.darkhax.gamestages

Class GameStageHelper

java.lang.Object

net.darkhax.gamestages.GameStageHelper

public class GameStageHelper
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
GameStageHelper()

Method Summary

Modifier and Type	Method and Description
static void	addStage(net.minecraft.entity.player.ServerPlayerEntity player, java.lang.String stage) Adds a stage to a player.
static int	clearStages(net.minecraft.entity.player.ServerPlayerEntity player) Removes all stages that a player has unlocked.
static java.util.Set<java.lang.String>	getKnownStages() Gets all the stages that are known to GameStages.
static IStageData	getPlayerData(net.minecraft.entity.player.PlayerEntity player) Gets the stage data for the player.
static IStageData	getPlayerData(net.minecraft.entity.player.ServerPlayerEntity player) Gets the stage data for the player.
static boolean	hasAllOf(net.minecraft.entity.player.ServerPlayerEntity player, java.util.Collection<java.lang.String> stages) Checks if a player has all of the passed stages.
static boolean	hasAllOf(net.minecraft.entity.player.ServerPlayerEntity player, IStageData playerData, java.util.Collection<java.lang.String> stages) Checks if a player data has all of the passed stages.
static boolean	hasAllOf(net.minecraft.entity.player.ServerPlayerEntity player, IStageData playerData, java.lang.String... stages) Checks if a player data has all of the passed stages.
static boolean	hasAllOf(net.minecraft.entity.player.ServerPlayerEntity player, java.lang.String... stages) Checks if a player has all of the passed stages.
static boolean	hasAnyOf(net.minecraft.entity.player.ServerPlayerEntity player, java.util.Collection<java.lang.String> stages) Checks if a player has any of the passed stages.
static boolean	hasAnyOf(net.minecraft.entity.player.ServerPlayerEntity player, IStageData playerData, java.util.Collection<java.lang.String> stages) Checks if a player data has any of the passed stages.
static boolean	hasAnyOf(net.minecraft.entity.player.ServerPlayerEntity player, IStageData playerData, java.lang.String... stages) Checks if a player data has any of the passed stages.
static boolean	hasAnyOf(net.minecraft.entity.player.ServerPlayerEntity player, java.lang.String... stages) Checks if a player has any of the passed stages.
static boolean	hasStage(net.minecraft.entity.player.ServerPlayerEntity player, IStageData data, java.lang.String stage) Internal helper method to fire a stage check.
static boolean	hasStage(net.minecraft.entity.player.ServerPlayerEntity player, java.lang.String stage) Checks if a player has a stage.
static boolean	isStageKnown(java.lang.String stage) Checks if a stage is known to GameStages.
static boolean	isValidStageName(java.lang.String stageName) Checks if a given string is valid as a stage name.
static void	removeStage(net.minecraft.entity.player.ServerPlayerEntity player, java.lang.String stage) Removes a stages from a player.
static void	syncPlayer(net.minecraft.entity.player.ServerPlayerEntity player) Syncs a client's data with the data that is on the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

GameStageHelper

public GameStageHelper()

Method Detail

isValidStageName

public static boolean isValidStageName(java.lang.String stageName)

Checks if a given string is valid as a stage name.

Parameters:

stageName - The name to test.

Returns:

Whether or not the name is valid.

getKnownStages

public static java.util.Set<java.lang.String> getKnownStages()

Gets all the stages that are known to GameStages.

Returns:

All the known stages.

isStageKnown

public static boolean isStageKnown(java.lang.String stage)

Checks if a stage is known to GameStages.

Parameters:

stage - The name of the stage to check.

Returns:

Whether or not the stage is known.

hasStage

public static boolean hasStage(net.minecraft.entity.player.ServerPlayerEntity player,
                               java.lang.String stage)

Checks if a player has a stage. This will also fire the check event which can be used to change the result.

Parameters:

player - The player to check the stages of.

stage - The stage to look for.

Returns:

Whether or not the player has access to this stage.

hasAnyOf

public static boolean hasAnyOf(net.minecraft.entity.player.ServerPlayerEntity player,
                               java.lang.String... stages)

Checks if a player has any of the passed stages. This will also fire the check event for each stage.

Parameters:

player - The player to check the stages of.

stages - The stages to look for.

Returns:

Whether or not the player has at least one of the stages.

hasAnyOf

public static boolean hasAnyOf(net.minecraft.entity.player.ServerPlayerEntity player,
                               java.util.Collection<java.lang.String> stages)

Checks if a player has any of the passed stages. This will also fire the check event for each stage.

Parameters:

player - The player to check the stages of.

stages - The stages to look for.

Returns:

Whether or not the player has at least one of the stages.

hasAnyOf

public static boolean hasAnyOf(net.minecraft.entity.player.ServerPlayerEntity player,
                               @Nullable
                               IStageData playerData,
                               java.util.Collection<java.lang.String> stages)

Checks if a player data has any of the passed stages. This will also fire the check event for each stage.

Parameters:

player - The player to check the stages of.

playerData - The player data to check.

stages - The stages to look for.

Returns:

Whether or not the player has at least one of the stages.

hasAnyOf

public static boolean hasAnyOf(net.minecraft.entity.player.ServerPlayerEntity player,
                               @Nullable
                               IStageData playerData,
                               java.lang.String... stages)

Checks if a player data has any of the passed stages. This will also fire the check event for each stage.

Parameters:

player - The player to check the stages of.

playerData - The player data to check.

stages - The stages to look for.

Returns:

Whether or not the player has at least one of the stages.

hasAllOf

public static boolean hasAllOf(net.minecraft.entity.player.ServerPlayerEntity player,
                               java.lang.String... stages)

Checks if a player has all of the passed stages. This will also fire the check event for each stage.

Parameters:

player - The player to check the stages of.

stages - The stages to look for.

Returns:

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

hasAllOf

public static boolean hasAllOf(net.minecraft.entity.player.ServerPlayerEntity player,
                               java.util.Collection<java.lang.String> stages)

Checks if a player has all of the passed stages. This will also fire the check event for each stage.

Parameters:

player - The player to check the stages of.

stages - The stages to look for.

Returns:

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

hasAllOf

public static boolean hasAllOf(net.minecraft.entity.player.ServerPlayerEntity player,
                               @Nullable
                               IStageData playerData,
                               java.util.Collection<java.lang.String> stages)

Checks if a player data has all of the passed stages. This will also fire the check event for each stage.

Parameters:

player - The player to check the stages of.

playerData - The player data to check.

stages - The stages to look for.

Returns:

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

hasAllOf

public static boolean hasAllOf(net.minecraft.entity.player.ServerPlayerEntity player,
                               @Nullable
                               IStageData playerData,
                               java.lang.String... stages)

Checks if a player data has all of the passed stages. This will also fire the check event for each stage.

Parameters:

player - The player to check the stages of.

playerData - The player data to check.

stages - The stages to look for.

Returns:

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

hasStage

public static boolean hasStage(net.minecraft.entity.player.ServerPlayerEntity player,
                               @Nullable
                               IStageData data,
                               java.lang.String stage)

Internal helper method to fire a stage check. It's used to reduce the total amount of code needed for the event firing, and improve performance for multiple stage lookups.

Parameters:

player - The player to check the stages of.

data - The player's stage data. This is to allow multiple stage checks to look this up only once.

stage - The stage to check for.

Returns:

Whether or not the player has the stage.

addStage

public static void addStage(net.minecraft.entity.player.ServerPlayerEntity player,
                            java.lang.String stage)

Adds a stage to a player. This will fire the add event which can be canceled, and the added event if the stage is added successfully.

Parameters:

player - The player to add the stage too.

stage - The stage to add.

removeStage

public static void removeStage(net.minecraft.entity.player.ServerPlayerEntity player,
                               java.lang.String stage)

Removes a stages from a player. This will fire the remove event which can be canceled, and the removed event if the stage is removed successfully.

Parameters:

player - The player to remove the stage from.

stage - The stage to remove.

clearStages

public static int clearStages(net.minecraft.entity.player.ServerPlayerEntity player)

Removes all stages that a player has unlocked.

Parameters:

player - The player to remove stages from.

Returns:

The amount of stages the player had before they were removed.

getPlayerData

@Nullable
public static IStageData getPlayerData(@Nullable
                                                 net.minecraft.entity.player.ServerPlayerEntity player)

Gets the stage data for the player. If this is a fake player it will use their fake player data.

Parameters:

player - The server player to get stage data for.

Returns:

The players data. May be null if player is null or they have no matching data.

getPlayerData

@Nullable
public static IStageData getPlayerData(net.minecraft.entity.player.PlayerEntity player)

Gets the stage data for the player. If this is a fake player it will use their fake player data. If it's a client player it will use the client data.

Parameters:

player - The player to get stage data for.

Returns:

The players data. May be null if the player was null or there is no matching data.

syncPlayer

public static void syncPlayer(net.minecraft.entity.player.ServerPlayerEntity player)

Syncs a client's data with the data that is on the server. This can only be called server side.

Parameters:

player - The player to sync.