HPL3/Amnesia: Rebirth/Scripting/cLuxSaveHandler

From Frictional Wiki
Jump to navigation Jump to search

Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!

Fields

cLuxSaveHandler has no public fields.

Functions

Return Type Function And Description
bool AutoSave(bool abSaveCheckpoint, bool abDelayed = true)
void ContinueLoading(bool abDisableWaits)
void DelayedLoadGameFromFile(const tWString &in asSaveFile, const tString &in asCallbackObject, const tString &in asCallbackFunction, bool abWaitAfterHeader, bool abWaitAfterLoad)
void DelayedSaveGameToFile(const tWString &in asSaveFile, bool abSaveAsCheckpoint)
void DeleteSaveFile(const tWString &in asSaveFile)
bool GetSaveFiles(array<tWString> avNames, array<tString> avDates, array<tWString> avFiles)
bool GetSaveThreadActive()
bool HasLoadError(tString &out asError)
bool IsDoneLoadingHeader()
bool IsDoneLoadingSavedGame()
void LoadGameFromFile(const tWString &in asSaveFile)
void SaveGameToFile(const tWString &in asSaveFile)
void StartLoadedGame()

Details

AutoSave

bool AutoSave(bool abSaveCheckpoint,
              bool abDelayed = true)


Parameters

  • abSaveCheckpoint (bool) —
  • abDelayed (bool) —

Returns:

  • bool

ContinueLoading

void ContinueLoading(bool abDisableWaits)


Parameters

  • abDisableWaits (bool) —

Returns:

  • void

DelayedLoadGameFromFile

void DelayedLoadGameFromFile(const tWString &in asSaveFile,
                             const tString &in asCallbackObject,
                             const tString &in asCallbackFunction,
                             bool abWaitAfterHeader,
                             bool abWaitAfterLoad)


Parameters

  • asSaveFile (tWString) —
  • asCallbackObject (tString) —
  • asCallbackFunction (tString) —
  • abWaitAfterHeader (bool) —
  • abWaitAfterLoad (bool) —

Returns:

  • void

DelayedSaveGameToFile

void DelayedSaveGameToFile(const tWString &in asSaveFile,
                           bool abSaveAsCheckpoint)


Parameters

  • asSaveFile (tWString) —
  • abSaveAsCheckpoint (bool) —

Returns:

  • void

DeleteSaveFile

void DeleteSaveFile(const tWString &in asSaveFile)


Parameters

Returns:

  • void

GetSaveFiles

bool GetSaveFiles(tWString avNames,
                  tString avDates,
                  tWString avFiles)


Parameters

Returns:

  • bool

GetSaveThreadActive

bool GetSaveThreadActive()

Returns:

  • bool

HasLoadError

bool HasLoadError(tString &out asError)


Parameters

Returns:

  • bool

IsDoneLoadingHeader

bool IsDoneLoadingHeader()

Returns:

  • bool

IsDoneLoadingSavedGame

bool IsDoneLoadingSavedGame()

Returns:

  • bool

LoadGameFromFile

void LoadGameFromFile(const tWString &in asSaveFile)


Parameters

Returns:

  • void

SaveGameToFile

void SaveGameToFile(const tWString &in asSaveFile)


Parameters

Returns:

  • void

StartLoadedGame

void StartLoadedGame()

Returns:

  • void

References

See all references...