ResourceManager Interface Reference

Inheritance diagram for ResourceManager:

Public Member Functions
proto external MetaFile	GetMetaFile (string absFilePath)
proto external bool	RegisterResourceFile (string absFilePath, bool bBuildRuntimeResource)
	Register register resource (create meta file) and optionally also build runtime resource.
proto external void	RebuildResourceFile (string filePath, string configuration, bool selectFiles)
	Rebuild already registered resource.
proto external void	RebuildResourceFiles (notnull array< string > filePaths, string configuration)
	Rebuild already registered resources.
proto external bool	WaitForFile (string filePath, int maxTimeMs=1000)
	Waits for file to be acknowledged by Resource Database.
proto external void	GetResourceBrowserSelection (WorkbenchSearchResourcesCallback callback, bool recursive=false)
	Return exact paths of selected items from ResourceBrowser panel in ResourceManager.
Public Member Functions inherited from WBModuleDef
proto external bool	SetOpenedResource (string filename)
proto external BaseContainer	GetContainer (int index=0)
proto external int	GetNumContainers ()
proto external bool	Save ()
proto external bool	GetCmdLine (string name, out string value)
proto external bool	Close ()
proto external bool	ExecuteAction (notnull array< string > menuPath, bool bKeepFocus=true)
proto external WorkbenchPlugin	GetPlugin (TypeName pluginType)
Public Member Functions inherited from pointer
proto string	ToString ()

Member Function Documentation

GetMetaFile()

proto external MetaFile ResourceManager.GetMetaFile

(

string

absFilePath

)

GetResourceBrowserSelection()

proto external void ResourceManager.GetResourceBrowserSelection	(	WorkbenchSearchResourcesCallback	callback,
		bool	recursive = false )

Return exact paths of selected items from ResourceBrowser panel in ResourceManager.

RebuildResourceFile()

proto external void ResourceManager.RebuildResourceFile	(	string	filePath,
		string	configuration,
		bool	selectFiles )

Rebuild already registered resource.

Usage:

rm.RebuildResourceFiles({"UI\\Imagesets\\Test\\Test.tga"}, "PC");

RebuildResourceFiles()

proto external void ResourceManager.RebuildResourceFiles	(	notnull array< string >	filePaths,
		string	configuration )

Rebuild already registered resources.

Usage:

rm.RebuildResourceFiles({"UI\\Imagesets\\Test\\Test.tga"}, "PC");

RegisterResourceFile()

proto external bool ResourceManager.RegisterResourceFile	(	string	absFilePath,
		bool	bBuildRuntimeResource )

Register register resource (create meta file) and optionally also build runtime resource.

Usage:

// register resource
ResourceManager rm = Workbench.GetModule(ResourceManager);
rm.RegisterResourceFile("c:\\DATA\\UI\\Imagesets\\Test\\Test.tga", true);

WaitForFile()

proto external bool ResourceManager.WaitForFile	(	string	filePath,
		int	maxTimeMs = 1000 )

Waits for file to be acknowledged by Resource Database.

Returns true if the file is ready, otherwise returns false due to time out.

---

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

• GameLib/generated/WorkbenchAPI/Modules/ResourceManager.c