Asset manager

Warning

This section is out of date. For now, you should only use it for reference.

Assets

After creating your assets in Game Studio, @'Xenko.Core.Serialization.Assets.AssetManager' is the class responsible for loading, unloading and saving assets.

Creating

You usually create assets directly in Game Studio.

Their URL will match the name (including folder) in Game Studio.

Examples of URLs:

  • knight (user imports knight.fbx directly in main asset folder)
  • level1/room1 (user creates level1 and import room1.fbx inside)For more information, see Assets for more details.

Loading

Loading an asset should be done with the help of @'Xenko.Core.Serialization.Assets.AssetManager' class:

  1. // Load an asset directly from a file:
  2. var texture = Content.Load<Texture>("texture1");
  4. // Load a Scene asset
  5. var scene = Content.Load<Scene>("scenes/scene1");
  7. // Load an Entity asset
  8. var entity = Content.Load<Entity>("entity1");

Note that loading an asset that has already been loaded only increment the reference counter and do not reload the asset.

Unloading

Unloading is also done using the AssetManager class:

  1.  Asset.Unload(asset);

Asset life time

Asset load and unload are working in pairs. For each call to 'load', a corresponding call to 'unload' is expected.

An asset is actually loaded only during the first call to 'load'. All subsequent calls only result to an asset reference increment.

An asset is actually unload only when the number of call to unload match the number of call the load.

The @'Xenko.Core.Serialization.Assets.AssetManager.Get' method returns the reference to a loaded asset but does not increment the asset reference counter.

  1.  var firstReference = Content.Load<Texture>("MyTexture"); // load the asset and increase the reference counter (ref count = 1)
  3. // the texture can be used here
  5. var secondReference = Content.Load<Texture>("MyTexture"); // only increase the reference counter (ref count = 2)
  7. // the texture can still be used here
  9. Asset.Unload(firstReference); // decrease the reference counter (ref count = 1)
  11. // the texture can still be used here
  13. Asset.Get<Texture>("MyTexture"); // return the loaded asset without increasing the reference counter (ref count = 1)
  15. // the texture can still be used here
  16. Asset.Unload(secondReference); // decrease the reference counter and unload the asset (ref count = 0)
  18. // The texture has been unloaded, it cannot be used here any more.