Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: SaveFile

[14:7] extends: FxObj

Wraps FXGL's SaveFile (com.almasb.fxgl.profile.SaveFile), a value object that pairs a save-file name with its date-time and DataFile payload. Returned by SaveLoadService read tasks and accepted by write tasks.

Methods

  • SaveFile (string Name = "save.sav")

    Creates a new SaveFile with the given name. DateTime defaults to now and the DataFile defaults to empty.

    • @p Name is the save-file name (e.g. "save1.sav" or "profile/save1.sav").
  • adopt (object Ajo)

    Wraps an existing SaveFile AussomJavaObject.

    • @p Ajo is an AussomJavaObject around a SaveFile.
    • @r A new wrapper.
  • getName ()

    Returns the save file's name string.

  • getData ()

    Returns the save file's DataFile payload as a wrapper.

    • @r A DataFile wrapper.
  • getDateTime ()

    Returns the save file's date-time as an AussomJavaObject around a java.time.LocalDateTime.

    • @r An AussomJavaObject.