Skip to content
This repository was archived by the owner on Oct 11, 2019. It is now read-only.

Commit ac91982

Browse files
authored
Merge pull request #7 from spatialos/release-1.0.1-rc-01
Release 1.0.1-rc-01
2 parents ac40752 + 6b6df44 commit ac91982

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+602
-264
lines changed
Binary file not shown.

Assets/Plugins/Improbable/Sdk/Dll/Improbable.WorkerSdkCsharp.Framework.dll.meta

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Assets/Plugins/Improbable/Sdk/Dll/Improbable.WorkerSdkCsharp.Framework.xml

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Assets/Plugins/Improbable/Sdk/Dll/Improbable.WorkerSdkCsharp.Framework.xml.meta

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Assets/Plugins/Improbable/Sdk/Dll/Improbable.WorkerSdkCsharp.dll.meta

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Assets/Plugins/Improbable/Sdk/Dll/Improbable.WorkerSdkCsharp.xml.meta

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Assets/Plugins/Improbable/Sdk/Src/Unity/Core/ConnectionLifecycle.cs

+3-2
Original file line numberDiff line numberDiff line change
@@ -149,8 +149,8 @@ private IEnumerator Connect()
149149
var connect = WorkerConnection.ConnectAsync(parameters, Deployment, AttachConnection);
150150
yield return connect;
151151

152-
SpatialOS.ConnectionWasSuccesful = Connection.IsConnected;
153-
if (SpatialOS.ConnectionWasSuccesful)
152+
SpatialOS.ConnectionWasSuccessful = Connection.IsConnected;
153+
if (SpatialOS.ConnectionWasSuccessful)
154154
{
155155
logger = new LogSender(() => SpatialOS.IsConnected, Connection.SendLogMessage, SpatialOS.Configuration, SpatialOS.LogFilter);
156156
SetupComponents();
@@ -200,6 +200,7 @@ private void Update()
200200
// before calling the first OnDestroy).
201201
private void OnApplicationQuit()
202202
{
203+
SpatialOS.SignalApplicationQuit();
203204
Dispose();
204205
}
205206

Assets/Plugins/Improbable/Sdk/Src/Unity/Core/SpatialOS.cs

+13-2
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ static SpatialOS()
5050
};
5151
}
5252

53-
internal static bool ConnectionWasSuccesful { get; set; }
53+
internal static bool ConnectionWasSuccessful { get; set; }
5454

5555
/// <summary>
5656
/// A callback that will be invoked when the deployment list has been retrieved from the Locator.
@@ -691,10 +691,21 @@ internal static void Disconnected(DisconnectOp disconnectOp)
691691
receivedDisconnectOp = disconnectOp;
692692
Disconnecting = true;
693693
}
694+
695+
internal static void SignalApplicationQuit()
696+
{
697+
if (!ConnectionWasSuccessful)
698+
{
699+
receivedDisconnectOp = new DisconnectOp
700+
{
701+
Reason = "An application quit signal was received."
702+
};
703+
}
704+
}
694705

695706
internal static void SignalDisconnection()
696707
{
697-
if (!ConnectionWasSuccesful)
708+
if (!ConnectionWasSuccessful)
698709
{
699710
OnConnectionFailedInternal();
700711
OnConnectionFailedWithReasonInternal();

Improbable/bin/UnityCodeGenerator.exe

0 Bytes
Binary file not shown.

docs/customize/configure-build.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -217,8 +217,8 @@ The menu `Improbable -> Prefabs -> Export All EntityPrefabs` runs the entity exp
217217

218218
This method puts files into the `<project root>/build/assembly/` directory; when you run `spatial cloud upload`, the
219219
contents of this directory are uploaded so they can be used by a
220-
[cloud deployment (SpatialOS documentation)](https://docs.improbable.io/reference/12.2/shared/glossary#cloud-deployment). For more information
221-
on deploying, see [Deploying to the cloud (SpatialOS documentation)](https://docs.improbable.io/reference/12.2/shared/deploy/deploy-cloud).
220+
[cloud deployment (SpatialOS documentation)](https://docs.improbable.io/reference/13.0/shared/glossary#cloud-deployment). For more information
221+
on deploying, see [Deploying to the cloud (SpatialOS documentation)](https://docs.improbable.io/reference/13.0/shared/deploy/deploy-cloud).
222222

223223
### Customizing the exporting of prefabs
224224

@@ -277,7 +277,7 @@ If you use the `Local` asset database, workers will load asset bundles from a di
277277
on disk. Assets are bundled into the worker executable, which means workers don't need to download prefab information
278278
at entity spawn time.
279279

280-
Set this in the [launch section of the worker configuration file (SpatialOS documentation)](https://docs.improbable.io/reference/12.2/shared/worker-configuration/launch-configuration)
280+
Set this in the [launch section of the worker configuration file (SpatialOS documentation)](https://docs.improbable.io/reference/13.0/shared/worker-configuration/launch-configuration)
281281
(eg `spatialos.UnityClient.worker.json`) in the `arguments` section, for example:
282282

283283
```
@@ -298,7 +298,7 @@ However, it might take longer to load initially, depending on internet speed, an
298298
This is the default asset database, but we recommend switching to the local asset database.
299299

300300
To explicitly use the streaming asset database, set this in the
301-
[launch section of the worker configuration file (SpatialOS documentation)](https://docs.improbable.io/reference/12.2/shared/worker-configuration/launch-configuration)
301+
[launch section of the worker configuration file (SpatialOS documentation)](https://docs.improbable.io/reference/13.0/shared/worker-configuration/launch-configuration)
302302
(eg `spatialos.UnityClient.worker.json`) in the `arguments` section, for example:
303303

304304
```

docs/customize/entity-pipeline.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ is experimental.
33

44
# Entity pipeline
55

6-
The **entity pipeline** is the logic which a [worker (SpatialOS documentation)](https://docs.improbable.io/reference/12.2/shared/glossary#worker) uses to create and
6+
The **entity pipeline** is the logic which a [worker (SpatialOS documentation)](https://docs.improbable.io/reference/13.0/shared/glossary#worker) uses to create and
77
manage their representations of entities.
88

9-
A SpatialOS [deployment (SpatialOS documentation)](https://docs.improbable.io/reference/12.2/shared/glossary#deploying) communicates with connected workers to instruct them
9+
A SpatialOS [deployment (SpatialOS documentation)](https://docs.improbable.io/reference/13.0/shared/glossary#deploying) communicates with connected workers to instruct them
1010
when an entity needs to be added/removed from the worker's view. For example, when an entity moves into or out of a
11-
worker's [checkout area (SpatialOS documentation)](https://docs.improbable.io/reference/12.2/shared/glossary#checking-out). The entity pipeline handles:
11+
worker's [checkout area (SpatialOS documentation)](https://docs.improbable.io/reference/13.0/shared/glossary#checking-out). The entity pipeline handles:
1212

1313
* choosing how to represent an entity locally - in Unity, we use a prefab to represent an entity
1414
* dealing with changes in an entity's components (one being added or removed) and changes in the properties of those
@@ -104,7 +104,7 @@ entity spawning to the next frame if necessary.
104104
> Make sure that those two components are attached to every entity (see
105105
[Creating an entity](../interact-with-world/create-delete-entities.md#create-an-entity)
106106
for more details) and that your
107-
[bridge configuration (SpatialOS documentation)](https://docs.improbable.io/reference/12.2/shared/worker-configuration/bridge-config#component-delivery) adds these
107+
[bridge configuration (SpatialOS documentation)](https://docs.improbable.io/reference/13.0/shared/worker-configuration/bridge-config#component-delivery) adds these
108108
components to your worker.
109109

110110
> If you can't include the components, consider replacing this block with a modified version of

docs/customize/logging.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Logging
22

33
Unity SDK will send messages logged via Unity's `Debug.Log` family of functions to SpatialOS. You can view these logs
4-
in your cloud deployment's web interface. See the documentation for [cloud deployments (SpatialOS documentation)](https://docs.improbable.io/reference/12.2/shared/operate/logs#cloud-deployments)
4+
in your cloud deployment's web interface. See the documentation for [cloud deployments (SpatialOS documentation)](https://docs.improbable.io/reference/13.0/shared/operate/logs#cloud-deployments)
55
for more information.
66

77
## Global log levels

docs/customize/minimal-build.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ This system does have a few downsides:
2929

3030
To set up Unity to use the new build system:
3131

32-
1. In the `spatialos.*.worker.json` files for both the UnityClient and UnityWorker, change the value of [`tasks_filename` (SpatialOS documentation)](https://docs.improbable.io/reference/12.2/shared/worker-configuration/worker-build#using-custom-build-scripts):
32+
1. In the `spatialos.*.worker.json` files for both the UnityClient and UnityWorker, change the value of [`tasks_filename` (SpatialOS documentation)](https://docs.improbable.io/reference/13.0/shared/worker-configuration/worker-build#using-custom-build-scripts):
3333
* For `spatialos.UnityClient.worker.json`, change `spatialos.unity.client.build.json` to `Improbable/build_script/spatialos.unity.client.build.experimental.json`
3434
* For `spatialos.UnityWorker.worker.json`, change `spatialos.unity.worker.build.experimental.json` to `Improbable/build_script/spatialos.unity.worker.build.experimental.json`
35-
1. In the root folder of your project, run [`spatial codegen` (SpatialOS documentation)](https://docs.improbable.io/reference/12.2/shared/spatial-cli/spatial-worker-codegen#spatial-worker-codegen).
35+
1. In the root folder of your project, run [`spatial codegen` (SpatialOS documentation)](https://docs.improbable.io/reference/13.0/shared/spatial-cli/spatial-worker-codegen#spatial-worker-codegen).
3636
1. Open your project in Unity.
3737
1. Open the UnityClient scene, and select the "Bootstrap" or "GameEntry" `GameObject` in the hierarchy.
3838
1. Remove the `DefaultTemplateProvider` component if it is there, then add the `BasicTemplateProvider` component.
@@ -49,15 +49,15 @@ There are two ways to build your workers:
4949
* The console will print a log after the build has completed.
5050

5151
* From a command prompt in your project folder
52-
* With Unity closed, run [`spatial worker build --target=local` (SpatialOS documentation)](https://docs.improbable.io/reference/12.2/shared/spatial-cli/spatial-worker-build#spatial-worker-build)
52+
* With Unity closed, run [`spatial worker build --target=local` (SpatialOS documentation)](https://docs.improbable.io/reference/13.0/shared/spatial-cli/spatial-worker-build#spatial-worker-build)
5353

5454
## Configuring your build
5555

5656
You can use the build configuration asset created in [Getting started](#getting-started) to configure how the workers should be built.
5757

5858
### Local and cloud environment
5959

60-
Use the local and cloud environments to have different build settings for [local (SpatialOS documentation)](https://docs.improbable.io/reference/12.2/shared/glossary#local-deployment) and [cloud (SpatialOS documentation)](https://docs.improbable.io/reference/12.2/shared/glossary#cloud-deployment) deployments. Both environments will produce the same results if they have the same settings, with the exception of the compression on the final zip file: to save build time, the local environment will not enable compression.
60+
Use the local and cloud environments to have different build settings for [local (SpatialOS documentation)](https://docs.improbable.io/reference/13.0/shared/glossary#local-deployment) and [cloud (SpatialOS documentation)](https://docs.improbable.io/reference/13.0/shared/glossary#cloud-deployment) deployments. Both environments will produce the same results if they have the same settings, with the exception of the compression on the final zip file: to save build time, the local environment will not enable compression.
6161

6262
> 'local' and 'cloud' environments were previously called 'development' and 'deployment'.
6363
@@ -142,4 +142,4 @@ You can revert to the old system using the following steps:
142142
1. Delete the build configuration asset that was created in step 7 of [Getting Started](#getting-started).
143143
1. Revert the changes to the UnityClient and UnityWorker scenes.
144144
1. Revert the changes to the `spatialos.*.worker.json` files.
145-
1. Run [`spatial codegen` (SpatialOS documentation)](https://docs.improbable.io/reference/12.2/shared/spatial-cli/spatial-worker-codegen#spatial-worker-codegen) in your project's root folder.
145+
1. Run [`spatial codegen` (SpatialOS documentation)](https://docs.improbable.io/reference/13.0/shared/spatial-cli/spatial-worker-codegen#spatial-worker-codegen) in your project's root folder.

docs/customize/playfab.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ the secret key.
5454

5555
### Pass a command-line argument
5656

57-
The command-line arguments used to launch each worker are defined in the [worker launch configuration files (SpatialOS documentation)](https://docs.improbable.io/reference/12.2/shared/worker-configuration/launch-configuration#worker-launch-configuration). To add a command line argument:
57+
The command-line arguments used to launch each worker are defined in the [worker launch configuration files (SpatialOS documentation)](https://docs.improbable.io/reference/13.0/shared/worker-configuration/launch-configuration#worker-launch-configuration). To add a command line argument:
5858

5959
0. Open `workers/unity/spatialos.UnityWorker.worker.json`. The command-line arguments for
6060
each target are defined in the arguments object.

docs/customize/steam.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ At this stage, you can start a game client from Steam. However, the current impl
110110

111111
* UnityClients can only be started from Steam and nowhere else.
112112
* UnityWorkers won't connect.
113-
* The [Launcher (SpatialOS documentation)](https://docs.improbable.io/reference/12.2/shared/glossary#launcher) will no longer work.
113+
* The [Launcher (SpatialOS documentation)](https://docs.improbable.io/reference/13.0/shared/glossary#launcher) will no longer work.
114114
115115
To fix these problems, you can wrap the Steam logic in a check for a command-line argument: `steamClient`.
116116
This argument will be present when you launch a client from Steam. But it won't be there when you launch a client
@@ -158,8 +158,8 @@ To do this:
158158
* Executable: Your client executable, for example `UnityClient@Windows.exe` or `UnityClient@Mac.app`.
159159
* Arguments: `+appName <your SpatialOS project name> +assetDatabaseStrategy Streaming +steamClient true`
160160
* `+appName` needs to be set to your
161-
[SpatialOS project name (SpatialOS documentation)](https://docs.improbable.io/reference/12.2/shared/glossary#project-name), as specified in
162-
your [`spatialos.json` (SpatialOS documentation)](https://docs.improbable.io/reference/12.2/shared/reference/file-formats/spatialos-json).
161+
[SpatialOS project name (SpatialOS documentation)](https://docs.improbable.io/reference/13.0/shared/glossary#project-name), as specified in
162+
your [`spatialos.json` (SpatialOS documentation)](https://docs.improbable.io/reference/13.0/shared/reference/file-formats/spatialos-json).
163163
* `+assetDatabaseStrategy Streaming` specifies that entity prefabs loaded as part of your project assemblies
164164
will be downloaded to the game client at runtime.
165165
* `+steamClient true` means that clients launched from Steam will use Steam authentication, using the
@@ -181,7 +181,7 @@ To do this for all the deployments in your project:
181181

182182
Alternatively, you can:
183183

184-
* Add the tag when [launching a cloud deployment (SpatialOS documentation)](https://docs.improbable.io/reference/12.2/shared/deploy/deploy-cloud) (replacing `steam_deployment` with your own string):
184+
* Add the tag when [launching a cloud deployment (SpatialOS documentation)](https://docs.improbable.io/reference/13.0/shared/deploy/deploy-cloud) (replacing `steam_deployment` with your own string):
185185
186186
```
187187
spatial cloud launch [...] --tags=steam_deployment

0 commit comments

Comments
 (0)