ResourceManager Class

A versatile resource management system for loading, unloading, caching, reading, saving and parsing assets with support for modding and async methods.

Inheritance Hierarchy

SystemObject
KitResourceManager

Namespace: Kit
Assembly: Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0

Syntax

Copy

public static class ResourceManager

Request Example View Source

The ResourceManager type exposes the following members.

Methods

	Name	Description
	ClearCache	Clear the cache and (optionally) unload assets not in use.
	ClearCacheAsync	Clear the cache and unload assets not in use asynchronously.
	ComparePath	Returns whether two paths are equal.
	CreateDirectoryForFile	Create directories for a file.
	Delete(String)	Delete a file.
	Delete(ResourceFolder, String)	Delete a file.
	Exists(String)	Returns whether a file exists.
	Exists(ResourceFolder, String)	Returns whether a file exists.
	GetPath(ResourceFolder)	Get the absolute path to a folder.
	GetPath(ResourceFolder, String)	Get the absolute path to a file.
	Load(Type, String)	Load a resource from an absolute path with the list of parsers registered. Does not cache.
	Load(Type, ResourceFolder, String, Boolean, Boolean)	Load and cache a resource. If folder is Resources the asset is loaded with Resources.Load. If it's not, it's parsed manually with the list of parsers registered.
	LoadT(String)	Load a resource from an absolute path with the list of parsers registered. Does not cache.
	LoadT(ResourceFolder, String, Boolean, Boolean)	Load and cache a resource. If folder is Resources the asset is loaded with Resources.Load. If it's not, it's parsed manually with the list of parsers registered.
	LoadAsync(Type, String)	Load a resource asynchronously from an absolute path with the list of parsers registered. Does not cache.
	LoadAsync(Type, ResourceFolder, String, Boolean, Boolean)	Load and cache a resource asynchronously. If folder is Resources the asset is loaded with Resources.Load. If it's not, it's parsed manually with the list of parsers registered.
	LoadAsyncT(String)	Load a resource asynchronously from an absolute path with the list of parsers registered. Does not cache.
	LoadAsyncT(ResourceFolder, String, Boolean, Boolean)	Load and cache a resource asynchronously. If folder is Resources the asset is loaded with Resources.Load. If it's not, it's parsed manually with the list of parsers registered.
	LoadEx	Load a resource from an absolute path with the list of parsers registered. Does not cache.
	LoadExAsync	Load a resource asynchronously from an absolute path with the list of parsers registered. Does not cache.
	LoadMerged(Type, ResourceFolder, String)	Load a resource merging the game version with all the mod versions and cache it. Useful to allow modding of configuration files like Json. If folder is Resources the base asset is loaded with If it's not, it's parsed manually with the list of parsers registered.
	LoadMergedT(ResourceFolder, String)	Load a resource merging the game version with all the mod versions and cache it. Useful to allow modding of configuration files like Json. If folder is Resources the base asset is loaded with If it's not, it's parsed manually with the list of parsers registered.
	LoadMergedAsync(Type, ResourceFolder, String)	Load a resource asynchronously merging the game version with all the mod versions and cache it. Useful to allow modding of configuration files like Json. If folder is Resources the base asset is loaded with Resources.Load. If it's not, it's parsed manually with the list of parsers registered.
	LoadMergedAsyncT(ResourceFolder, String)	Load a resource asynchronously merging the game version with all the mod versions and cache it. Useful to allow modding of configuration files like Json. If folder is Resources the base asset is loaded with Resources.Load. If it's not, it's parsed manually with the list of parsers registered.
	LoadUnmodded(Type, ResourceFolder, String)	Load and cache a resource without regarding mods. If folder is Resources the asset is loaded with Resources.Load. If it's not, it's parsed manually with the list of parsers registered.
	LoadUnmoddedT(ResourceFolder, String)	Load and cache a resource without regarding mods. If folder is Resources the asset is loaded with Resources.Load. If it's not, it's parsed manually with the list of parsers registered.
	LoadUnmoddedAsync(Type, ResourceFolder, String)	Load and cache a resource asynchronously without regarding mods. If folder is Resources the asset is loaded with If it's not, it's parsed manually with the list of parsers registered.
	LoadUnmoddedAsyncT(ResourceFolder, String)	Load and cache a resource asynchronously without regarding mods. If folder is Resources the asset is loaded with If it's not, it's parsed manually with the list of parsers registered.
	MatchExtension(String, IEnumerableString)	Returns whether a path matches one of the extensions specified.
	MatchExtension(String, String)	Returns whether a path matches the extension specified.
	ReadBytes(String)	Read the contents of a file in binary-mode.
	ReadBytes(ResourceFolder, String, Boolean)	Read the contents of a file in binary-mode.
	ReadBytesAsync(String)	Read the contents of a file asynchronously in binary-mode.
	ReadBytesAsync(ResourceFolder, String, Boolean)	Read the contents of a file asynchronously in text-mode.
	ReadText(String)	Read the contents of a file in text-mode.
	ReadText(ResourceFolder, String, Boolean)	Read the contents of a file in text-mode.
	ReadTextAsync(String)	Read the contents of a file asynchronously in text-mode.
	ReadTextAsync(ResourceFolder, String, Boolean)	Read the contents of a file asynchronously in text-mode.
	Save(String, Object)	Save the contents of an object to a file.
	Save(ResourceFolder, String, Object)	Save the contents of an object to a file.
	SaveAsync(String, Object)	Save the contents of an object asynchronously to a file.
	SaveAsync(ResourceFolder, String, Object)	Save the contents of an object asynchronously to a file.
	SaveBytes(String, Byte)	Save binary content to a file.
	SaveBytes(ResourceFolder, String, Byte)	Save binary content to a file.
	SaveBytesAsync(String, Byte)	Save binary content asynchronously to a file.
	SaveBytesAsync(ResourceFolder, String, Byte)	Save binary content asynchronously to a file.
	SaveText(String, String)	Save text content to a file.
	SaveText(ResourceFolder, String, String)	Save text content to a file.
	SaveTextAsync(String, String)	Save text content asynchronously to a file.
	SaveTextAsync(ResourceFolder, String, String)	Save text content asynchronously to a file.
	Unload(Object)	Unload a resource from cache and memory.
	Unload(Type, ResourceFolder, String)	Unload a resource from cache and memory.
	UnloadT(ResourceFolder, String)	Unload a resource from cache and memory.

Top

Events

	Name	Description
	ResourceLoaded	Event fired when when any resource is loaded. Returns the folder, path, reference to the resource and whether the resource was actually loaded () or re-used from cache ().
	ResourceUnloaded	Event fired when when any resource is unloaded. Returns the folder and path to the resource unloaded.

Top

Fields

	Name	Description
	LogCategory	Category name to use for logging messages.
	LogEvents	Whether to log load and unload events.
	Parsers	Instances of classes to use for parsing data when calling Load / Save methods on a folder other than Resources.
	Paths	Absolute paths to ResourceFolders.

Top

Remarks

Can handle file-names without extensions from Resources. Otherwise you have to provide it, as you can't enumerate and match files in StreamingAssets on platforms like Android.

Examples

Copy

ResourceManager.Load<Texture>(ResourceFolder.Resources, "Textures/Background");

Copy

ResourceManager.LoadAsync<GameState>(ResourceFolder.PersistentData, "GameState.json");

Reference

Kit Namespace