Load via

In coherence, it's possible to specify how the Prefab for a network entity will be loaded into memory at runtime using the Load via option on the CoherenceSync.

Built-in asset loaders

We support three default implementations, or you can create your own. The three default implementations are Resources, Direct Reference or Addressables:

Resources

Resources loader will be used if your Prefab is inside a Resources folder. If you wish to use any other type of loading method, you will be prompted to move the Prefab outside of the Resources folder.

Direct Reference

This loader will be used if your Prefab is outside of a Resources folder, and the Prefab is not marked as Addressable. This means that we will need to hard reference the Prefab in the CoherenceSyncConfig, which means it will always be loaded into memory from the moment you start your game.

Addressables

This option is only available if you have the Addressables Package installed.

This loader will be used if your Prefab is marked as an Addressable asset, and it will be soft referenced using Addressables' AssetReference class, meaning it's not loaded in memory at the beginning of the game but it gets loaded on demand, when needed.

When you choose this method, you don't have to implement Addressables code: coherence takes care of doing the loading for you, transparently.

Creating your own asset loader

You can implement the INetworkObjectProvider interface to create your custom implementations that will be used by coherence when we need to load the Prefab into memory.

Custom implementations can be Serializable and have your own custom serialized data.

To begin, use the dropdown menu on the CoherenceSync and use the Create Implementation... option:

Selecting a loader or creating your own

Let coherence generate the scripts for you, and customise them as you see fit.

Once created, implementations of this interface will appear in the Load via dropdown shown above, or in the corresponding CoherenceSyncObject asset.