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.EntityPlayer player, java.lang.String stage) Adds a stage to a player.
static boolean	clientHasAllOf(net.minecraft.entity.player.EntityPlayer player, java.util.Collection<java.lang.String> stages) Deprecated. Non-client methods should work. Will be removed in 1.13.
static boolean	clientHasAllOf(net.minecraft.entity.player.EntityPlayer player, java.lang.String... stages) Deprecated. Non-client methods should work. Will be removed in 1.13.
static boolean	clientHasAnyOf(net.minecraft.entity.player.EntityPlayer player, java.util.Collection<java.lang.String> stages) Deprecated. Non-client methods should work. Will be removed in 1.13.
static boolean	clientHasAnyOf(net.minecraft.entity.player.EntityPlayer player, java.lang.String... stages) Deprecated. Non-client methods should work. Will be removed in 1.13.
static boolean	clientHasStage(net.minecraft.entity.player.EntityPlayer player, java.lang.String stage) Deprecated. Non-client methods should work. Will be removed in 1.13.
static IStageData	getPlayerData(net.minecraft.entity.player.EntityPlayer player) Gets the player data for an EntityPlayer.
static boolean	hasAllOf(net.minecraft.entity.player.EntityPlayer 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.EntityPlayer 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.EntityPlayer 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.EntityPlayer player, java.lang.String... stages) Checks if a player has all of the passed stages.
static boolean	hasAnyOf(net.minecraft.entity.player.EntityPlayer 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.EntityPlayer 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.EntityPlayer 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.EntityPlayer player, java.lang.String... stages) Checks if a player has any of the passed stages.
static boolean	hasStage(net.minecraft.entity.player.EntityPlayer player, IStageData data, java.lang.String stage) Internal helper method to fire a stage check.
static boolean	hasStage(net.minecraft.entity.player.EntityPlayer player, java.lang.String stage) Checks if a player has a stage.
static void	removeStage(net.minecraft.entity.player.EntityPlayer player, java.lang.String stage) Removes a stages from a player.
static void	syncPlayer(net.minecraft.entity.player.EntityPlayer player) A generic version of syncPlayer(EntityPlayerMP).
static void	syncPlayer(net.minecraft.entity.player.EntityPlayerMP 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

hasStage

public static boolean hasStage(net.minecraft.entity.player.EntityPlayer 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.EntityPlayer 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.EntityPlayer 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.EntityPlayer player,
                               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.EntityPlayer player,
                               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.EntityPlayer 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.EntityPlayer 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.EntityPlayer player,
                               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.EntityPlayer player,
                               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.EntityPlayer player,
                               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.EntityPlayer 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.EntityPlayer 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.

getPlayerData

public static IStageData getPlayerData(net.minecraft.entity.player.EntityPlayer player)

Gets the player data for an EntityPlayer. This will resolve fake players to their special data as well.

Parameters:

player - The player to get the data of.

Returns:

The stage data for the player.

syncPlayer

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

A generic version of syncPlayer(EntityPlayerMP). It still only works for multiplayer, but allows some code to be cleaner.

Parameters:

player - The player to sync.

syncPlayer

public static void syncPlayer(net.minecraft.entity.player.EntityPlayerMP 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.

clientHasStage

@Deprecated
public static boolean clientHasStage(net.minecraft.entity.player.EntityPlayer player,
                                                 java.lang.String stage)

Deprecated. Non-client methods should work. Will be removed in 1.13.

Checks if the client 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.

clientHasAllOf

@Deprecated
public static boolean clientHasAllOf(net.minecraft.entity.player.EntityPlayer player,
                                                 java.lang.String... stages)

Deprecated. Non-client methods should work. Will be removed in 1.13.

Checks if the client 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.

clientHasAllOf

@Deprecated
public static boolean clientHasAllOf(net.minecraft.entity.player.EntityPlayer player,
                                                 java.util.Collection<java.lang.String> stages)

Deprecated. Non-client methods should work. Will be removed in 1.13.

Checks if the client 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.

clientHasAnyOf

@Deprecated
public static boolean clientHasAnyOf(net.minecraft.entity.player.EntityPlayer player,
                                                 java.lang.String... stages)

Deprecated. Non-client methods should work. Will be removed in 1.13.

Checks if the client 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.

clientHasAnyOf

@Deprecated
public static boolean clientHasAnyOf(net.minecraft.entity.player.EntityPlayer player,
                                                 java.util.Collection<java.lang.String> stages)

Deprecated. Non-client methods should work. Will be removed in 1.13.

Checks if the client 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.