net.darkhax.gamestages.data

Class GameStageSaveHandler

java.lang.Object

net.darkhax.gamestages.data.GameStageSaveHandler

public class GameStageSaveHandler
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static IStageData	clientData A reference to the client's current stage data.
static IStageData	EMPTY_STAGE_DATA A constant reference to empty stage data.

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	getFakeData(java.lang.String fakePlayerName) Gets data for a fake player.
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 void	onPlayerLoad(net.minecraftforge.event.entity.player.PlayerEvent.LoadFromFile event) Hook for the player LoadFromFile event.
static void	onPlayerLoggedIn(net.minecraftforge.fml.common.gameevent.PlayerEvent.PlayerLoggedInEvent event) Hook for the PlayerLoggedInEvent.
static void	onPlayerLoggedOut(net.minecraftforge.fml.common.gameevent.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	removeFakePlayer(java.lang.String fakePlayerName) WARNING: This method has the potential to cause all sorts of issues.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_STAGE_DATA

public static final IStageData EMPTY_STAGE_DATA

A constant reference to empty stage data. This is used internally to improve memory usage in some situations, and also to prevent null pointers and to keep code minimal.

clientData

public static IStageData clientData

A reference to the client's current stage data. This will be overridden every time the player joins a save instance.

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.

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.

onPlayerLoggedIn

public static void onPlayerLoggedIn(net.minecraftforge.fml.common.gameevent.PlayerEvent.PlayerLoggedInEvent event)

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

onPlayerLoggedOut

public static void onPlayerLoggedOut(net.minecraftforge.fml.common.gameevent.PlayerEvent.PlayerLoggedOutEvent event)

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

getPlayerData

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.EntityPlayer) can be used to automatically resolve an EntityPlayer.

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.

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.

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(String). Alternatively GameStageHelper.getPlayerData(net.minecraft.entity.player.EntityPlayer) 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.