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) Attempts to give a player a stage.
static int	clearStages(net.minecraft.entity.player.ServerPlayerEntity player) Removes all stages from a player.
static java.util.Set<java.lang.String>	getKnownStages() Gets an immutable set of all the stages defined in the known stages json file.
static IStageData	getPlayerData(net.minecraft.entity.player.PlayerEntity player) Attempts to resolve the stage data for a player.
static boolean	hasAllOf(net.minecraft.entity.player.PlayerEntity player, java.util.Collection<java.lang.String> stages) Checks if the player has all of the stages.
static boolean	hasAllOf(net.minecraft.entity.player.PlayerEntity player, IStageData data, java.util.Collection<java.lang.String> stages) Checks if the player has all of the stages.
static boolean	hasAllOf(net.minecraft.entity.player.PlayerEntity player, IStageData data, java.lang.String... stages) Checks if the player has all of the stages.
static boolean	hasAllOf(net.minecraft.entity.player.PlayerEntity player, java.lang.String... stages) Checks if the player has all of the stages.
static boolean	hasAnyOf(net.minecraft.entity.player.PlayerEntity player, java.util.Collection<java.lang.String> stages) Checks if the player has at least one of many possible stages.
static boolean	hasAnyOf(net.minecraft.entity.player.PlayerEntity player, IStageData data, java.util.Collection<java.lang.String> stages) Checks if the player has at least one of many possible stages.
static boolean	hasAnyOf(net.minecraft.entity.player.PlayerEntity player, IStageData data, java.lang.String... stages) Checks if the player has at least one of many possible stages.
static boolean	hasAnyOf(net.minecraft.entity.player.PlayerEntity player, java.lang.String... stages) Checks if the player has at least one of many possible stages.
static boolean	hasStage(net.minecraft.entity.player.PlayerEntity player, IStageData data, java.lang.String stage) Checks if a player has a stage.
static boolean	hasStage(net.minecraft.entity.player.PlayerEntity player, java.lang.String stage) Checks if a player has a stage.
static boolean	isStageKnown(java.lang.String stage) Checks if a stage has been defined in the known stages file.
static boolean	isValidStageName(java.lang.String stageName) Checks if a string is valid as a stage name.
static void	removeStage(net.minecraft.entity.player.ServerPlayerEntity player, java.lang.String stage) Attempts to remove a stage from a player.
static void	syncPlayer(net.minecraft.entity.player.ServerPlayerEntity player) Syncs a player's stage data from the server to the client.

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 string is valid as a stage name. Compares against STAGE_PATTERN.

Parameters:

stageName - The potential name.

Returns:

Whether or not the name is valid as a stage name.

getKnownStages

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

Gets an immutable set of all the stages defined in the known stages json file.

Returns:

An immutable set of all known stages.

isStageKnown

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

Checks if a stage has been defined in the known stages file.

Parameters:

stage - The stage name to search for.

Returns:

Whether or not the stage name exists in the known stages.

hasStage

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

Checks if a player has a stage.

Parameters:

player - The player to check.

stage - The stage to look for.

Returns:

Whether or not they have the stage.

hasStage

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

Checks if a player has a stage.

Parameters:

player - The player to check.

data - The player's stage data.

stage - The stage to look for.

Returns:

Whether or not they have the stage.

hasAnyOf

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

Checks if the player has at least one of many possible stages.

Parameters:

player - The player to check.

stages - The stages to look for.

Returns:

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

hasAnyOf

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

Checks if the player has at least one of many possible stages.

Parameters:

player - The player to check.

stages - The stages to look for.

Returns:

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

hasAnyOf

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

Checks if the player has at least one of many possible stages.

Parameters:

player - The player to check.

data - The player's stage data.

stages - The stages to look for.

Returns:

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

hasAnyOf

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

Checks if the player has at least one of many possible stages.

Parameters:

player - The player to check.

data - The player's stage data.

stages - The stages to look for.

Returns:

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

hasAllOf

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

Checks if the player has all of the stages.

Parameters:

player - The player to check.

stages - The stages to look for.

Returns:

Whether or not the player had all the stages.

hasAllOf

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

Checks if the player has all of the stages.

Parameters:

player - The player to check.

stages - The stages to look for.

Returns:

Whether or not the player had all the stages.

hasAllOf

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

Checks if the player has all of the stages.

Parameters:

player - The player to check.

data - The player's stage data.

stages - The stages to look for.

Returns:

Whether or not the player had all the stages.

hasAllOf

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

Checks if the player has all of the stages.

Parameters:

player - The player to check.

data - The player's stage data.

stages - The stages to look for.

Returns:

Whether or not the player had all the stages.

addStage

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

Attempts to give a player a stage. Events may cancel this.

Parameters:

player - The player to give the stage.

stage - The stage to give.

removeStage

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

Attempts to remove a stage from a player. Events may cancel this.

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 from a player.

Parameters:

player - The player to clear the stages of.

Returns:

The amount of stages that were removed.

getPlayerData

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

Attempts to resolve the stage data for a player. If it is a real server player it will lookup their data using UUID. If it's a FakePlayer it will check the fake player data file. If it's a client player it will use the client's synced data cache.

Parameters:

player - The player to resolve.

Returns:

The stage data that was found. Will be null if nothing could be found.

syncPlayer

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

Syncs a player's stage data from the server to the client.

Parameters:

player - The player to sync.