DiskCache

• Properties • Methods • Method Details •

Description

Supported Script Types:

Interface Scripts
Client Entity Scripts
Avatar Scripts

The DiskCache API lets you manage your cache.

Properties

Name	Type	Summary
maximumCacheSize	number	The maximum cache size in gigabytes.
usedCacheSize	number	The used cache size in gigabytes. Read-only.
cacheDirectory	string	The path to the cache directory.

Methods

Name	Return Value	Summary
`clearCache`	None	Clears all the cache.
`getCacheDirectory`	string	Gets the path to the cache directory.
`getMaximumCacheSize`	number	Gets the maximum cache size in gigabytes.
`getUsedCacheSize`	number	Gets the used cache size in gigabytes.
`restoreDefaultCacheDirectory`	None	Sets the path to the cache directory back to the default.
`restoreDefaultMaximumCacheSize`	None	Sets the maximum cache size in gigabytes back to the default.
`setCacheDirectory`	None	Sets the path to the cache directory.
`setMaximumCacheSize`	None	Sets the maximum cache size in gigabytes.

Method Details

(static) clearCache( )
Clears all the cache.

(static) getCacheDirectory( ) → {string} Returns: cacheDirectory - The path to the cache directory.
Gets the path to the cache directory.

(static) getMaximumCacheSize( ) → {number} Returns: maximumCacheSize - The maximum cache size in gigabytes.
Gets the maximum cache size in gigabytes.

(static) getUsedCacheSize( ) → {number} Returns: usedCacheSize - The used cache size in gigabytes.
Gets the used cache size in gigabytes.

(static) restoreDefaultCacheDirectory( )
Sets the path to the cache directory back to the default.

(static) restoreDefaultMaximumCacheSize( )
Sets the maximum cache size in gigabytes back to the default.

(static) setCacheDirectory( cacheDirectory )

Sets the path to the cache directory.

Parameters

Name	Type	Description
`cacheDirectory`	string	The path to the cache directory.

(static) setMaximumCacheSize( maximumCacheSize )

Sets the maximum cache size in gigabytes.

Parameters

Name	Type	Description
`maximumCacheSize`	number	The maximum cache size in gigabytes.