AuthClient API changes

We've greatly simplified the AuthClient API which should make it much easier to use and much harder to get wrong.

Part of the changes is moving the responsibility of storing the guest login credentials to the consumer of the AuthClient.

All Login methods return a LoginResult object which contains credentials required for further sign-ins, including the SessionToken which was previously stored in the AuthClient. It is in caller's best interest to store those credentials so they can be reuse in the next session.

Example of a new sign up / sign in flow:

async Task<bool> SignUp(AuthClient authClient, string username, string password)
{
    LoginResult loginResult = await authClient.LoginWithPassword(username, password, autoSignup: true);
    if(loginResult.Type != Result.Success)
    {
        // ... handle failure
        return false;
    }

    // Custom token saving function
    SaveSessionToken(loginResult.SessionToken);
    return true;
}

async Task<bool> SignIn(AuthClient authClient)
{
    // Custom token loading function
    var sessionToken = LoadSessionToken();
    if(sessionToken == null)
    {
        // ... handle failure
        return false;
    }

    LoginResult loginResult = await authClient.LoginWithToken(sessionToken);
    return loginResult.Type == Result.Success;
}

The new AuthClient API looks as follows:

event Action<LoginResponse> OnLogin;
event Action OnLogout;
event Action<LoginError> OnError;

bool LoggedIn { get; }

Task<LoginResult> LoginAsGuest();
Task<LoginResult> LoginWithPassword(string username, string password, bool autoSignup);
Task<LoginResult> LoginWithToken(SessionToken sessionToken);

void Logout();
void Dispose();

If you wish to get started and install the coherence Unity SDK, please refer to the installation page.

Upgrading to a new version

Open Unity Package Manager under Window > Package Manager and check the Packages - coherence section. It will state the currently installed version and if there are any recommended updates available:

Upgrade Guides

For example, if your project is on 0.7 and would like to upgrade to 1.0, upgrade from 0.7 to 0.8, then from 0.8 to 0.9, and so on. Always back up your project before upgrading, to avoid any risk of losing your data.

Versions prior to 0.9 are considered legacy. We don't provide a detailed upgrade guide for those versions.

CoherenceBridge.GlobalQueryOn 🠚 EnableClientConnections

The GlobalQueryOn property on the Coherence.Toolkit.CoherenceBridge class has been marked as obsolete, and should no longer be used. If you had references in your code to this property, you should see warnings in your Console about this.

To fix the warnings, update your code to use the CoherenceBridge.EnableClientConnections property instead.

RuntimeSettings.instance 🠚 Instance

The instance property on the Coherence.RuntimeSettings class has been marked as obsolete, and should no longer be used. If you had references in your code to this property, you should see warnings in your Console about this.

To fix the warnings, update your code to use the RuntimeSettings.Instance property instead.

RuntimeSettings.DefaultTransportMode 🠚 TransportType

The DefaultTransportMode property on the Coherence.RuntimeSettings class was removed, and replaced with the property TransportType.

Binding.RuntimeInterpolationSettings 🠚 ValueBinding.Interpolator

The RuntimeInterpolationSettings property on the Coherence.Toolkit.Bindings.Binding class was removed.

A new property Interpolator was added to Coherence.Toolkit.Bindings.ValueBinding, offering comparable binding interpolation functionality.

ComponentChange.Mask 🠚 Data.FieldMask

The Mask property was removed from the Coherence.Entities.ComponentChange struct.

The same value can be acquired using ComponentChange.Data.FieldsMask instead.

ChannelID Relocated

The Coherence.ChannelID struct was moved into the Coherence.Common assembly.

If you get compile errors about this type not being found, make sure that your Assembly Definition Asset has a reference to the Coherence.Common assembly.

Notable API changes include:

• Coherence.Network is removed now. OnConnected and OnDisconnected events are moved to IClient and have changed a signature:

    private void OnEnable()
    {
        if (!BridgeStore.TryGetBridge(gameObject.scene, out CoherenceBridge Bridge))
            return; 
        
        client = Bridge.Client;
        client.OnConnected += OnConnect;
        client.OnDisconnected += OnDisconnect;
    }

    private void OnDisable()
    {
        client.OnConnected -= OnConnect;
        client.OnDisconnected -= OnDisconnect;
    }

    private void OnConnect(ushort u)
    {
        onConnect.Invoke();
    }

    private void OnDisconnect(ConnectionCloseReason reason)
    {
        onDisconnect.Invoke();
    }

• BridgeStore.GetBridge is now obsolete, and will be replaced with BridgeStore.TryGetBridge.

BridgeStore.TryGetBridge(gameObject.scene, out Bridge);

• CoherenceSync.isSimulated is now obsolete, and will be replaced with CoherenceSync.HasStateAuthority.

• CoherenceSync.RequestAuthority is now obsolete, and will be replaced with CoherenceSync.RequestAuthority(AuthorityType).

CLI Tools

The CLI tools have been updated, especially the ones that handle Simulators. To learn more about this, see CLI utilities.

• using Coherence.Entity; -> using Coherence.Entities;

If your project is using the Source Generator baking strategy

It is recommended to switch to Assets strategy before upgrading. If you upgrade while using the Source Generator, you might see an error popup, guiding you to switch back to Assets. After the upgrade and a clean Bake, you can switch back to Source Generators baking strategy.

This page lists changes in coherence 1.0.0 version which might affect existing projects when upgrading from a 0.10.x version to 1.0.0.

Baked code and Prefabs with missing scripts

Version 1.0.0 includes breaking changes to the baked scripts, which means your current ones will cause compilation errors. It is recommended to delete your current baked scripts under Assets/coherence/baked before performing a coherence Unity SDK update.

CoherenceMonoBridge has been renamed to CoherenceBridge

There have been a number of updates to the old CoherenceMonoBridge, which have resulted in a rebranding of the component to CoherenceBridge.

The script asset GUID and the public API of the component remain unchanged, so asset references to CoherenceMonoBridge components should remain intact.

CoherenceSyncConfigRegistry and removal of PrefabMapper

In coherence 1.0.0, we have revamped our asset management systems to make them more scalable and customizable, both in Editor and in runtime. Read more about the new implementations and the possibilities in the Asset Management article.

Upon upgrading the SDK, a new CoherenceSyncConfigRegistry asset will be automatically created in Assets/coherence/CoherenceSyncConfigRegistry.asset and populated with sub-assets for each of your Prefabs that have a CoherenceSync component attached.

If the automatic migration completed successfully, you can browse all your networked Prefabs in the new CoherenceSync Objects window found under the coherence menu item:

If something has gone wrong during the automatic migration, you can restart the process by deleting the current CoherenceSyncConfigRegistry asset, and selecting the Reimport coherence Assets option under the coherence menu item. This will automatically create a config entry for each of your CoherenceSync Prefabs:

Changes to CoherenceSync lifetime in runtime

In previous versions of coherence, Prefabs with the CoherenceSync component would be automatically synced over the network in the Start method, and they would stop being synced only when destroyed. This prevented us from supporting things like object pooling and reusing the same CoherenceSync instance to represent different network entities across its lifetime.

As a result, CoherenceSync instances are now automatically synced and unsynced with the network in the OnEnable and OnDisable methods of the MonoBehaviour. This means you can disable the GameObject instance in the hierarchy and it will stop being synced, you can also keep the local visual representation by only disabling the CoherenceSync component.

You can learn more about the CoherenceSync lifetime cycle in the Order Of Execution page.

Play API deprecation

The Play API was the public API we offered to connect with your coherence Cloud project in runtime. It has been deprecated in favor of a new non-static API called CloudService, with separation of a ReplicationServerRoomsService so you can talk to self-hosted Room Replication Servers with a lot more customization and without having to use the coherence Cloud.

The Play API includes the following classes:

• PlayResolver

• PlayClient

• Play

• WorldsResolverClient

• RoomsResolverClient

If you were using PlayResolver static calls, you can now access CloudService instance from CoherenceBridge instead, and you will be able to use the CloudService.Worlds or CloudService.Rooms instances to fetch Worlds or to create, delete or fetch available Rooms respectively.

CloudService offers callback-based methods and an async variant for all of the available requests.

You can learn more about the Cloud Service API under the Unity Cloud Service section.

"No Domain Reload" Unity Editor option is now supported

No Domain Reload is a Unity Editor option that allows users to enter Play mode very fast without having to recompile all your code. This wasn't properly supported in earlier versions of coherence, but now it is!

You can find this option under Edit > Project Settings > Editor > Enter Play Mode Settings.

CoherenceSync.OnNetworkedInstantiation and OnBeforeNetworkedInstantiation events behaviour change

In previous releases of coherence, this event would be fired strictly for CoherenceSync prefab instances created by coherence, which means it would be fired for instances you didn't have authority over.

In 1.0, this event will be fired for every instance of CoherenceSync that starts being synchronized over the network.

If you wish to hook behaviour to non-authority instances, please use the OnStateRemote event instead, which is fired when a CoherenceSync instance is non-authoritative.

Changes to the Client Connections system

In 1.0, there has been two major changes to Client Connection instances.

• Client Connection instances now live in the DontDestroyOnLoad scene. Since now we support Scene Transitioning, and Client Connections instances are managed by coherence, they need to survive the destruction of the Scene they were in.

• References to the Client Connection Prefab in the CoherenceBridge Component have been changed from hard referencing a Unity Prefab, to referencing a CoherenceSyncConfig asset. If you were using a Unity Prefab reference, it still exists serialized but is deprecated. If you wish to stop using the Unity Prefab reference, please delete the CoherenceBridge Component and add it again.

Major changes for CoherenceSyncConfigRegistry

There has been a major refactor on how we deal with the registry.

First off, we're deprecating the registry holding configs as sub-assets. This has been the default up to 1.1, but on 1.2, it has been changed to store the configs in the Assets/coherence/CoherenceSyncConfigs folder.

For 1.2, we have avoided manual migration of existing subassets. You can trigger this operation from the registry inspector (Assets/coherence/CoherenceSyncRegistry). We don't automate this operation, since the extraction changes the asset GUIDs of the configs, which could lead to missing references. This is specially true if your project is referencing the configs directly, instead of going through the registry. Keep this in mind when you decide to extract existing subassets.

The APIs provided have changed too. Check CoherenceSyncConfigRegistry, CoherenceSyncConfigUtils and CoherenceSyncUtils. Exposed functionality has been documented.

Compilation Errors

When the package imports, if there are any compilation errors, Unity won't do a domain reload. This means the previous package is still in memory and executing, but the contents of the package (might) have changed drastically. This can yield numerous errors and warnings on the Console, that will fade away once the compilation (followed by a domain reload) is completed.

If, after compilation, you are still experiencing issues using the SDK (errors hitting the Bake button, CoherenceSync throwing exceptions or warnings that weren't there before the upgrade, etc), please reach out to us on our Discord or the Community forum.

Client Hosting

In this update, bundling the Replication Server has been revamped to work with Streaming Assets. On the Settings window, instead of different toggles per platform, there's now one unified toggle: