FinalEngine.Resources 2023.4.0-pre

FinalEngine.Resources

FinalEngine.Resources provides a set of classes and interfaces that can be used to manager resources within a Final Engine game. The general goal of this library is to provide users with an IResourceManager used to load and unload references to resources.

Getting started

Below you'll find instructions on how to take advantage of this package. Please note that Final Engine is in active development and a full release is still underway.

Prerequisites

First off, you need to make sure you register a resource loader to the resource manager. Standard resource loaders can be found in the FinalEngine.Extensions.Resources package. So, just install the package and you're good to go.

Additionally, you can implement your own resource loader by creating your own implementation of the ResourceLoaderBase<TResource> class. Note that TResource refers to a generic of type IResource.

Usage

Once the additional dependencies have been implemented you can now use the resource manager. To get started, we need to register any and all resource loaders we wish to use. This should be done before loading any resources.

// If for some reason you haven't yet created a file system object, create one.
var fileSystem = new FileSystem();

// Now let's create and register a sound resource loader.
var loader = new SoundResourceLoader(fileSystem);
ResourceManager.Instance.RegisterLoader<ISound>(loader);

Cool, so once all resource loaders are registered you can load and unload resources like so:

// Load a sound.
var sound = ResourceManager.Instance.LoadResource<ISound>("sound.mp3");

// Later on we can unload
ResourceManager.Instance.UnloadResource(sound);

Additional documentation

• Remember to unload your resources when you're done with them to remove unnecessary references to the resource and free up memory.
• Refrain from using the Dispose function provided by a loaded resource; this will most likely be omitted in a future release. The resource manager should be responsible for the lifecycle of any and all resources it manages.

Feedback

Want to provide feedback? Perhaps you have a found a bug or wish to provide a feature request? Look no further!

• GitHub
• Discord