ClearFileCacheShowOff

From GECK
Jump to: navigation, search


A function added by the ShowOff NVSE Plugin version 1.45.

Description

Clears the cached data of a given file. Supported file cache functions are listed in Cached File Functions (ShowOff).

The type of the cached file must be specified via toClearType.

  • Valid values are listed in Notes.

Returns true (1) if the cache was found and cleared, false (0) otherwise.

Details on caching files:

  • Caching eats memory, but allows faster access to the data.
  • Caches should be cleared when they cease to be useful.

Syntax

[help]
(success:bool) ClearFileCacheShowOff filePath:string toClearType:int 

Or:

(success:bool) CloseFileSO filePath:string toClearType:int 

Notes

  • Valid values for toClearType:
To Clear Type Value
INI 0
JSON 1
    • If the Clear Type is INI, then filePath will be relative to "Data\Config".
    • If the Clear Type is JSON, then filePath will be relative to the root folder.