SDK Update Guide

General Updates

  • After an sdk upgrade a bake process will be initiated automatically by the sdk to make sure the baked scripts are up to date.

  • If you run into any compilation or runtime errors in coherence code after the update these steps might help resolve the issue:

1) Go to coherence -> Schema and Baking -> Bake schemas (Safe Mode)

This will generate baked skeleton scripts which will compile but not work at runtime.

2) Go to coherence -> Schema and Baking -> Bake schemas

To fully generate the baked code (This can also be done via any of the other baking options).

3) This process should handle old bindings which are different on the updated version. If the errors persist check the bindings window for the relevant prefab to make sure they are set up properly then perform steps 1 and 2 again.

SDK Upgrade 0.4.x -> 0.5.0

  • Notable api changes you should be aware of:

commands are now called like so:

sync.SendCommand<ComponentType>("CommandMethodName", MessageTarget.All);

For example:

  • Notice the MessageTarget parameter and generic type argument which might be missing in the version you were using before.

Method parameters should be added after the MessageTarget parameter.

  • Notice the MessageTarget must be set for command methods in the Bindings window as well. If this is not set up in accordance with the way the method is called at runtime the command will not go through and a warning will be given about improper routing.

Last updated