net.darkhax.gamestages.data

Class GameStageSaveHandler

java.lang.Object

net.darkhax.gamestages.data.GameStageSaveHandler

public class GameStageSaveHandler
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
GameStageSaveHandler()

Method Summary

Modifier and Type	Method and Description
static void	addFakePlayer(FakePlayerData data) WARNING: This method has the potential to cause all sorts of issues.
static IStageData	getClientData() Gets the game stage data of the current player that has been synced to the client.
static IStageData	getFakeData(java.lang.String fakePlayerName) Gets data for a fake player.
static java.util.Set<java.lang.String>	getKnownStages() Gets all the stages that are known to GameStages.
static IStageData	getPlayerData(java.util.UUID uuid) Looks up a players stage data.
static boolean	hasFakePlayer(java.lang.String fakePlayerName) Checks if the fake player is in the fake stage map.
static boolean	isStageKnown(java.lang.String stage) Checks if a stage is known to GameStages.
static void	onPlayerLoad(net.minecraftforge.event.entity.player.PlayerEvent.LoadFromFile event) Hook for the player LoadFromFile event.
static void	onPlayerLoggedIn(net.minecraftforge.event.entity.player.PlayerEvent.PlayerLoggedInEvent event) Hook for the PlayerLoggedInEvent.
static void	onPlayerLoggedOut(net.minecraftforge.event.entity.player.PlayerEvent.PlayerLoggedOutEvent event) Hook for the PlayerLoggedInEvent.
static void	onPlayerSave(net.minecraftforge.event.entity.player.PlayerEvent.SaveToFile event) Hook for the player SaveToFile event.
static void	reloadFakePlayers() Reloads fake player data from the fake player json file.
static void	reloadKnownStages() Reloads all the known player data.
static void	removeFakePlayer(java.lang.String fakePlayerName) WARNING: This method has the potential to cause all sorts of issues.
static void	setClientData(IStageData stageData) Sets the client's synced stage data.

Methods inherited from class java.lang.Object

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

Constructor Detail

GameStageSaveHandler

public GameStageSaveHandler()

Method Detail

onPlayerLoad

public static void onPlayerLoad(net.minecraftforge.event.entity.player.PlayerEvent.LoadFromFile event)

Hook for the player LoadFromFile event. Allows game stage data to be loaded when the player's data is loaded.

Parameters:

event - The forge event.

onPlayerSave

public static void onPlayerSave(net.minecraftforge.event.entity.player.PlayerEvent.SaveToFile event)

Hook for the player SaveToFile event. Allows game stage data to be saved when the player's data is saved.

Parameters:

event - The Forge event.

onPlayerLoggedIn

public static void onPlayerLoggedIn(net.minecraftforge.event.entity.player.PlayerEvent.PlayerLoggedInEvent event)

Hook for the PlayerLoggedInEvent. If the player is a valid server side player, their data will be synced to the client.

Parameters:

event - The Forge event.

onPlayerLoggedOut

public static void onPlayerLoggedOut(net.minecraftforge.event.entity.player.PlayerEvent.PlayerLoggedOutEvent event)

Hook for the PlayerLoggedInEvent. If the player is a valid server side player, their data will be synced to the client.

Parameters:

event - The Forge event.

getPlayerData

@Nullable
public static IStageData getPlayerData(java.util.UUID uuid)

Looks up a players stage data. This should only be used with real players, fake players use getFakeData(String). Alternatively, the GameStageHelper.getPlayerData(net.minecraft.entity.player.PlayerEntity) can be used to automatically resolve a player.

Parameters:

uuid - The uuid of the player to lookup.

Returns:

The stage data for the player. If one does not exist, it will be created.

reloadFakePlayers

public static void reloadFakePlayers()

Reloads fake player data from the fake player json file.

reloadKnownStages

public static void reloadKnownStages()

Reloads all the known player data.

hasFakePlayer

public static boolean hasFakePlayer(java.lang.String fakePlayerName)

Checks if the fake player is in the fake stage map.

Parameters:

fakePlayerName - The fake player name to check for.

Returns:

Whether or not the fake player exists.

addFakePlayer

public static void addFakePlayer(FakePlayerData data)

WARNING: This method has the potential to cause all sorts of issues. Please do not use it unless you're absolutely sure you know what you're doing. Adds fake player data to the fake stage map.

Parameters:

data - The fake player data to take into account.

removeFakePlayer

public static void removeFakePlayer(java.lang.String fakePlayerName)

WARNING: This method has the potential to cause all sorts of issues. Please do not use it unless you're absolutely sure you know what you're doing. Removes fake player data to the fake stage map.

Parameters:

fakePlayerName - The fake player name to remove.

getFakeData

public static IStageData getFakeData(java.lang.String fakePlayerName)

Gets data for a fake player. Real players should use getPlayerData(UUID) Alternatively GameStageHelper.getPlayerData(net.minecraft.entity.player.PlayerEntity) can be used to automatically resolve players.

Parameters:

fakePlayerName - The name of the fake player.

Returns:

The fake players stage data, or the default value if one does not exist.

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.

getClientData

public static IStageData getClientData()

Gets the game stage data of the current player that has been synced to the client.

Returns:

The current client side stage data.

setClientData

public static void setClientData(IStageData stageData)

Sets the client's synced stage data.

Parameters:

stageData - The stage data for the client.