TorqueScript Reference
Resource Manager

Functions

void addResPath (path, [ignoreZips=false]?)
void dumpResources (onlyLoaded?)
String getModPaths ()
Boolean isUsingVFS ()
void purgeResources ()
void removeResPath (pathExpression)
void setModPaths (path)

Detailed Description

Function Documentation

◆ addResPath()

void addResPath ( path ,
[ignoreZips=false] ?  )

Add a path to the resource manager

◆ dumpResources()

void dumpResources ( onlyLoaded? )

Use the dumpLoadedResources function to dump a listing of the currently in-use resources to the console. This will include such things as sound files, font files, etc. For this to work, the engine must have been compiled with TORQUE_DEBUG defined.

Returns
No return value.
See also
purgeResources

◆ getModPaths()

String getModPaths ( )

Use the getModPaths function to get the current mod path information.

Returns
Returns a string equivalent to the complete current mod path, that is all pads that are visible to the file manager.
See also
setModPaths

◆ isUsingVFS()

Boolean isUsingVFS ( )
Returns
Returns true if using Virtual File System

◆ purgeResources()

void purgeResources ( )

Use the purgeResources function to purge all game resources.

Returns
No return value.
See also
clearTextureHolds, dumpResourceStats, dumpTextureStats, flushTextureCache

◆ removeResPath()

void removeResPath ( pathExpression )

Remove a path from the resource manager. Path is an expression as in findFirstFile()

◆ setModPaths()

void setModPaths ( path )

Use the setModPaths function to set the current mod path to the value specified in path.

Parameters
pathA string containing a semi-colon (;) separated list of game and mod paths.
Returns
No return value.
See also
getModPaths