RigsofRods  2023.09
Soft-body Physics Simulation
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Private Member Functions
Script2Game::CacheSystemClass Class Reference

Binding of RoR::CacheSystem; A database of all installed game content, allowing search and live updating. More...

#include <CacheSystemClass.h>

Private Member Functions

CacheEntryClass findEntryByFilename (LoaderType type, bool partial, const string &in _filename_maybe_bundlequalified)
 Returns null if none found; "Bundle-qualified" format also specifies the ZIP/directory in modcache, i.e. More...
 
CacheEntryClass getEntryByNumber (int)
 Returns null if such number doesn't exist. More...
 
dictionary query (dictionary@ query)
 Searches the installed content - syntax is exactly the same as used by the Loader UI. More...
 
CacheEntryClass findEntryByFilename (LoaderType type, bool partial, const string &in _filename_maybe_bundlequalified)
 Returns null if none found; "Bundle-qualified" format also specifies the ZIP/directory in modcache, i.e. More...
 
CacheEntryClass getEntryByNumber (int)
 Returns null if such number doesn't exist. More...
 
dictionary query (dictionary@ query)
 Searches the installed content - syntax is exactly the same as used by the Loader UI. More...
 

Detailed Description

Binding of RoR::CacheSystem; A database of all installed game content, allowing search and live updating.

Note
This object is created automatically as global variable modcache.

Definition at line 20 of file CacheSystemClass.h.

Member Function Documentation

◆ findEntryByFilename() [1/2]

CacheEntryClass Script2Game::CacheSystemClass::findEntryByFilename ( LoaderType  type,
bool  partial,
const string &in  _filename_maybe_bundlequalified 
)
private

Returns null if none found; "Bundle-qualified" format also specifies the ZIP/directory in modcache, i.e.

"mybundle.zip:myactor.truck"

◆ findEntryByFilename() [2/2]

CacheEntryClass Script2Game::CacheSystemClass::findEntryByFilename ( LoaderType  type,
bool  partial,
const string &in  _filename_maybe_bundlequalified 
)
private

Returns null if none found; "Bundle-qualified" format also specifies the ZIP/directory in modcache, i.e.

"mybundle.zip:myactor.truck"

◆ getEntryByNumber() [1/2]

CacheEntryClass Script2Game::CacheSystemClass::getEntryByNumber ( int  )
private

Returns null if such number doesn't exist.

◆ getEntryByNumber() [2/2]

CacheEntryClass Script2Game::CacheSystemClass::getEntryByNumber ( int  )
private

Returns null if such number doesn't exist.

◆ query() [1/2]

dictionary Script2Game::CacheSystemClass::query ( dictionary@  query)
private

Searches the installed content - syntax is exactly the same as used by the Loader UI.

Parameters
queryA dictionary representing the Query Parameters of RoR::CacheQuery; required params are "filter_type" (LoaderType), "filter_category_id" (int), "filter_guid" (string) and "search_expr" (string).
Returns
A dictionary representing the Query Results of RoR::CacheQuery

◆ query() [2/2]

dictionary Script2Game::CacheSystemClass::query ( dictionary@  query)
private

Searches the installed content - syntax is exactly the same as used by the Loader UI.

Parameters
queryA dictionary representing the Query Parameters of RoR::CacheQuery; required params are "filter_type" (LoaderType), "filter_category_id" (int), "filter_guid" (string) and "search_expr" (string).
Returns
A dictionary representing the Query Results of RoR::CacheQuery

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