PlayerEvent.SaveToFile (forge 1.16.5)

java.lang.Object
- net.minecraftforge.eventbus.api.Event
- - net.minecraftforge.event.entity.EntityEvent
  - - net.minecraftforge.event.entity.living.LivingEvent
    - - net.minecraftforge.event.entity.player.PlayerEvent
      - net.minecraftforge.event.entity.player.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.

Nested Class Summary
- Nested classes/interfaces inherited from class net.minecraftforge.event.entity.player.PlayerEvent
  PlayerEvent.BreakSpeed, PlayerEvent.Clone, PlayerEvent.HarvestCheck, PlayerEvent.ItemCraftedEvent, PlayerEvent.ItemPickupEvent, PlayerEvent.ItemSmeltedEvent, PlayerEvent.LoadFromFile, PlayerEvent.NameFormat, PlayerEvent.PlayerChangedDimensionEvent, PlayerEvent.PlayerChangeGameModeEvent, PlayerEvent.PlayerLoggedInEvent, PlayerEvent.PlayerLoggedOutEvent, PlayerEvent.PlayerRespawnEvent, PlayerEvent.SaveToFile, PlayerEvent.StartTracking, PlayerEvent.StopTracking, PlayerEvent.TabListNameFormat, PlayerEvent.Visibility
- Nested classes/interfaces inherited from class net.minecraftforge.event.entity.living.LivingEvent
  LivingEvent.LivingJumpEvent, LivingEvent.LivingUpdateEvent, LivingEvent.LivingVisibilityEvent
- Nested classes/interfaces inherited from class net.minecraftforge.event.entity.EntityEvent
  EntityEvent.CanUpdate, EntityEvent.EnteringChunk, EntityEvent.EntityConstructing, EntityEvent.Size
- Nested classes/interfaces inherited from class net.minecraftforge.eventbus.api.Event
  net.minecraftforge.eventbus.api.Event.HasResult, net.minecraftforge.eventbus.api.Event.Result

Field Summary

Fields
Modifier and Type Field Description

private java.io.File playerDirectory

private java.lang.String playerUUID

Constructor Summary

Constructors
Constructor Description

SaveToFile(PlayerEntity player, java.io.File originDirectory, java.lang.String playerUUID)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.io.File`	`getPlayerDirectory()`	The directory where player data is being stored.
`java.io.File`	`getPlayerFile(java.lang.String suffix)`	Construct and return a recommended file for the supplied suffix
`java.lang.String`	`getPlayerUUID()`	The UUID is the standard for player related file storage.

Methods inherited from class net.minecraftforge.event.entity.player.PlayerEvent
getPlayer

Methods inherited from class net.minecraftforge.event.entity.living.LivingEvent
getEntityLiving

Methods inherited from class net.minecraftforge.event.entity.EntityEvent
getEntity

Methods inherited from class net.minecraftforge.eventbus.api.Event
getListenerList, getParentListenerList, getPhase, getResult, hasResult, isCancelable, isCanceled, setCanceled, setPhase, setResult, setup

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 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.