LuaSTG-x Core API
lstg::ResourcePack Class Reference
Inheritance diagram for lstg::ResourcePack:

Public Member Functions

function cacheAllFiles ()
 
function cacheAllFilesAsync ()
 
function cacheFile (local fpath)
 
function cacheFileAsync (local fpath, local callback)
 
function clearFileCache ()
 
function create (local fullPath, local password)
 
function getCompressedSize (local fpath)
 
function getCRC32 (local fpath)
 
function getFileCount ()
 
function getPath ()
 
function getPriority ()
 
function getStringFromFile (local fpath)
 
function getUncompressedSize (local fpath)
 
function isFileCached (local fpath)
 
function isFileOrDirectoryExist (local fpath)
 
function listCachedFiles ()
 
function listFiles ()
 
function loadAndCache (local fpath)
 
function removeFileCache (local fpath)
 
function setPriority (local v)
 

Member Function Documentation

◆ cacheAllFiles()

function cacheAllFiles ( )

◆ cacheAllFilesAsync()

function cacheAllFilesAsync ( )

◆ cacheFile()

function cacheFile ( local  fpath)
Parameters
fpathstring
Returns
boolean

◆ cacheFileAsync()

function cacheFileAsync ( local  fpath,
local  callback 
)
Parameters
fpathstring
callbackfun()
Returns
lstg.ResourcePack

◆ clearFileCache()

function clearFileCache ( )

◆ create()

function create ( local  fullPath,
local  password 
)
Parameters
fullPathstring
passwordstring
Returns
lstg.ResourcePack

◆ getCompressedSize()

function getCompressedSize ( local  fpath)
Parameters
fpathstring
Returns
number

◆ getCRC32()

function getCRC32 ( local  fpath)
Parameters
fpathstring
Returns
number

◆ getFileCount()

function getFileCount ( )
Returns
number

◆ getPath()

function getPath ( )
Returns
string

◆ getPriority()

function getPriority ( )
Returns
number

◆ getStringFromFile()

function getStringFromFile ( local  fpath)
Parameters
fpathstring
Returns
string

◆ getUncompressedSize()

function getUncompressedSize ( local  fpath)
Parameters
fpathstring
Returns
number

◆ isFileCached()

function isFileCached ( local  fpath)
Parameters
fpathstring
Returns
boolean

◆ isFileOrDirectoryExist()

function isFileOrDirectoryExist ( local  fpath)
Parameters
fpathstring
Returns
boolean

◆ listCachedFiles()

function listCachedFiles ( )
Returns
array_table

◆ listFiles()

function listFiles ( )
Returns
array_table

◆ loadAndCache()

function loadAndCache ( local  fpath)
Parameters
fpathstring
Returns
lstg.Buffer

◆ removeFileCache()

function removeFileCache ( local  fpath)
Parameters
fpathstring
Returns
boolean

◆ setPriority()

function setPriority ( local  v)
Parameters
vnumber
Returns
lstg.ResourcePack

The documentation for this class was generated from the following file: