Class PlayerEvent.SaveToFile

  • Enclosing class:
    PlayerEvent

    public static class PlayerEvent.SaveToFile
    extends PlayerEvent
    The player is being saved to the world store. Note that the player may be in the process of logging out or otherwise departing from the world. Don't assume it's association with the world. This allows mods to load an additional file from the players directory containing additional mod related player data.
    Use this event to save the additional mod related player data to the world.
    WARNING: Do not overwrite the player's .dat file here. You will corrupt the world state.
    • Field Detail

      • playerDirectory

        private final java.io.File playerDirectory
      • playerUUID

        private final java.lang.String playerUUID
    • Constructor Detail

      • SaveToFile

        public SaveToFile​(PlayerEntity player,
                          java.io.File originDirectory,
                          java.lang.String playerUUID)
    • Method Detail

      • getPlayerFile

        public java.io.File getPlayerFile​(java.lang.String suffix)
        Construct and return a recommended file for the supplied suffix
        Parameters:
        suffix - The suffix to use.
        Returns:
      • getPlayerDirectory

        public java.io.File getPlayerDirectory()
        The directory where player data is being stored. Use this to locate your mod additional file.
      • getPlayerUUID

        public java.lang.String getPlayerUUID()
        The UUID is the standard for player related file storage. It is broken out here for convenience for quick file generation.