net.darkhax.gamestages.capabilities

Interface PlayerDataHandler.IAdditionalStageData

Enclosing class:

PlayerDataHandler

public static interface PlayerDataHandler.IAdditionalStageData

The backing interface for additional stage data. Can be used, along with PlayerDataHandler.registerDataHandler(String, IAdditionalStageData) and PlayerDataHandler.getDataHandler(String) to have custom player nbt data.

Method Summary

Modifier and Type	Method and Description
void	onClientSync(net.minecraft.entity.player.EntityPlayer player, java.lang.String stageName, boolean isUnlocking) Called when the packet is sent to the client.
void	readNBT(net.minecraft.entity.player.EntityPlayer player, PlayerDataHandler.IStageData stageData, net.minecraft.nbt.NBTTagCompound tag) Called when the player's data is being read.
void	writeNBT(net.minecraft.entity.player.EntityPlayer player, PlayerDataHandler.IStageData stageData, net.minecraft.nbt.NBTTagCompound tag) Called when the player's data is being written.

Method Detail

writeNBT

void writeNBT(@Nonnull
              net.minecraft.entity.player.EntityPlayer player,
              @Nonnull
              PlayerDataHandler.IStageData stageData,
              @Nonnull
              net.minecraft.nbt.NBTTagCompound tag)

Called when the player's data is being written.

Parameters:

player - The player whos's being saved.

stageData - The stage data.

tag - An NBTTagCompound which is specific to this handler.

readNBT

void readNBT(@Nonnull
             net.minecraft.entity.player.EntityPlayer player,
             @Nonnull
             PlayerDataHandler.IStageData stageData,
             net.minecraft.nbt.NBTTagCompound tag)

Called when the player's data is being read.

Parameters:

player - The player who's being read.

stageData - The stage data.

tag - An NBTTagCompound which is specific to this handler. It can be null if #writeNBT(EntityPlayer, IStageData, NBTTagCompound) was not called yet.

onClientSync

void onClientSync(@Nonnull
                  net.minecraft.entity.player.EntityPlayer player,
                  @Nonnull
                  java.lang.String stageName,
                  boolean isUnlocking)

Called when the packet is sent to the client. Allows you to do packety stuff.

Parameters:

player - The player who's being synced.

stageName - The name of the stage being synced. This can be empty!

isUnlocking - Whether or not the stage is being unlocked.