Back End connection

Editor setup

If you want to test the connection with the back-end, the steps are the following:

1. Go to the main scene, which can be found in Assets/Scenes/Main.unity.
2. Make sure that there is a game object called World Controller with the WorldControls.cs script attached and a SocketIOController prefab as a child. It also has another child, something called VIC. It stands for Very Important Cube. On the early stages of the development, the scene would not render without an object on it, that's why we added an invisible cube. Do not remove it.
3. Click on the SocketIOController and in the inspector you'll be able to see the host and port variables.
4. Run the main aimmo game (only working on the unity branch), open it in a browser and 'Save' the game or level you want to visualise in Unity. A more detailed explanation on how to run it can be found on the repository's README.
5. Find out which port the game is running in and put that value in the SocketIOController.
6. Click the play button on Unity, and you should be seeing a map with an avatar moving in it.

WorldControls

As explained above, the game object World Controller should have the WorldControls component attached to it and there should be the appropriate prefab in the SocketIOController field.

Regarding the code, we will discuss how it works when it's built to WebGL since locally it works in a simpler way for the sake of testing. The steps are the following:

1. Start: The map feature managers and the player manager are initialised. So is the dataQueue. There is an external call, named SendAllConnect, which will call a method in the Javascript that contains the Unity view. When this method is called it means that Unity has loaded the scene and can safely set the host and the port. (See the unity.html on the unity branch).
2. EstablishConnection: This is the last call made from the Javascript which will set up the socket connection. When the back-end is also connected, it will emit a world-init event to which the Unity client will respond with client-ready and its user id. After that, it will only be listening to the world-update event.
3. WorldUpdate: Every time the server sends an update, this method will put the JSON in the dataQueue.
4. Update: This is the Unity MonoBehaviour update function, which will dequeue an update every ProcessingInterval seconds and delegate it to ProcessUpdate which will finally change the view in the scene through the managers.