04-07-2018, 05:17 AM
Blog: Encapsulated scene architecture for large teams in Unity
<div style="margin: 5px 5% 10px 5%;"><img src="https://www.sickgamedev.win/wp-content/uploads/2018/04/blog-encapsulated-scene-architecture-for-large-teams-in-unity.png" width="646" height="215" title="" alt="" /></div><div><p><strong><em><small>The following blog post, unless otherwise noted, was written by a member of Gamasutra’s community.<br />The thoughts and opinions expressed are those of the writer and not Gamasutra or its parent company.</small></em></strong></p>
<hr />
<p>Development in a big team is always an issue in Unity when we are talking about a scene file.</p>
<p>Multiple people working on the same scene may experience problems when the time for merging parallel work arrives.</p>
<p>Some solutions have been developed to account for that, but more often than not, bumps are present during production stage of the game.</p>
<p>The solution found here at Black River Studios was custom built from ground up and from day 0 to fit development of multiple people on the same scene causing as little interference as possible and the results were quite pleasing.</p>
<p><img alt="" src="https://www.sickgamedev.win/wp-content/uploads/2018/04/blog-encapsulated-scene-architecture-for-large-teams-in-unity.png" /></p>
<p>Two rules were defined at the beginning of production:</p>
<ul>
<li>Game flow controlled by waypoint;</li>
<li>No direct references shall exist in a scene;</li>
</ul>
<p>By having the team following this two rules, the only possible scene conflict would only fall on the scene composition work.</p>
<p>If two or more artists would add and edit what the scene actually looks like, that could cause a conflict.</p>
<p>Luckily that did not happen during the whole production phase of the game, and rarely there was more than one developer working on the scene composition at the same time.</p>
<h2><strong>Waypoint System</strong></h2>
<p>A waypoint system was created, where the philosophy was that all the game flow of a current waypoint is controlled by it, and every waypoint is self contained.</p>
<p>That means that anyone could set any of the waypoints as the starting waypoint, and the game would work perfectly from that point on.</p>
<p>That meant that each waypoint would guarantee that all the systems it needed to run would exist, all actors were set correctly, and from that point on, the game flow could start flawlessly.</p>
<p>This architecture sped up the development process considerably, since we could focus test each waypoint, and bugs found during the execution of a waypoint would be contained to that execution, making it extremely easy to pinpoint them in matter of minutes.</p>
<p><img alt="" src="https://www.sickgamedev.win/wp-content/uploads/2018/04/blog-encapsulated-scene-architecture-for-large-teams-in-unity-1.png" /></p>
<p>Playmaker was chosen as the tool that would handle the game flow so game designers would have more control and less dependency of engineers to create their own waypoints, but this system can be adapted to use any type of flow management the team decides to use.</p>
<p>The SceneManager sends an event to the FSM called “Initialize”, and from that point on, the waypoint should do everything it needs to run correctly.</p>
<p>Spawning of enemies, start and end of battles, opening doors, setting traps, triggering big events should all be done by the waypoint, and actors only satisfies the condition of each node in the waypoint flow that triggers the next node to activate.</p>
<p>Ideally, a waypoint could start in any node and work correctly, but that level of encapsulation may hurt the flexibility of the system and is not required.</p>
<p>[embedded content]</p>
<h2><strong>Scene References</strong></h2>
<p>The second part of this system is the indirect scene references.</p>
<p>Only one GameObject on the scene holds references to anything that is inside the scene that might be needed by any script or FSM.</p>
<p>It is a singleton, and the references are mapped via string path, with a custom editor controlling said references.</p>
<p><img alt="" src="https://www.sickgamedev.win/wp-content/uploads/2018/04/blog-encapsulated-scene-architecture-for-large-teams-in-unity-2.png" /></p>
<p>References in the scene are divided by categories and references, making it easy to map the variables to any script or FSM.</p>
<p>Additionally, an automated FSM variable addition was created to reduce the overhead work for dealing with references this way instead of directly linking a GameObject to a script variable.</p>
<p>This allows the waypoints to be prefabs, and manipulate the scene just by programming using the empty references instead of the actual objects.</p>
<p>At the start of the game, all scripts and FSMs have access to the SceneManager in order to fill the empty references with actual scene objects, allowing the code in them to affect actors and objects in the scene during run time.</p>
<p><img alt="" src="https://www.sickgamedev.win/wp-content/uploads/2018/04/blog-encapsulated-scene-architecture-for-large-teams-in-unity.jpg" /></p>
<h2> </h2>
<h2><strong>Conclusion</strong></h2>
<p>By building an indirect reference and encapsulated flow from ground up , the scene conflicts during development were practically nullified and stability and control over what is happening made bug hunting the easiest the studio has seen so far.</p>
<p>This system is flexible enough that most projects can at least adapt a version of it, allowing to reap the benefits of disconnecting direct references from development and controlling game flow.</p>
</div>
<div style="margin: 5px 5% 10px 5%;"><img src="https://www.sickgamedev.win/wp-content/uploads/2018/04/blog-encapsulated-scene-architecture-for-large-teams-in-unity.png" width="646" height="215" title="" alt="" /></div><div><p><strong><em><small>The following blog post, unless otherwise noted, was written by a member of Gamasutra’s community.<br />The thoughts and opinions expressed are those of the writer and not Gamasutra or its parent company.</small></em></strong></p>
<hr />
<p>Development in a big team is always an issue in Unity when we are talking about a scene file.</p>
<p>Multiple people working on the same scene may experience problems when the time for merging parallel work arrives.</p>
<p>Some solutions have been developed to account for that, but more often than not, bumps are present during production stage of the game.</p>
<p>The solution found here at Black River Studios was custom built from ground up and from day 0 to fit development of multiple people on the same scene causing as little interference as possible and the results were quite pleasing.</p>
<p><img alt="" src="https://www.sickgamedev.win/wp-content/uploads/2018/04/blog-encapsulated-scene-architecture-for-large-teams-in-unity.png" /></p>
<p>Two rules were defined at the beginning of production:</p>
<ul>
<li>Game flow controlled by waypoint;</li>
<li>No direct references shall exist in a scene;</li>
</ul>
<p>By having the team following this two rules, the only possible scene conflict would only fall on the scene composition work.</p>
<p>If two or more artists would add and edit what the scene actually looks like, that could cause a conflict.</p>
<p>Luckily that did not happen during the whole production phase of the game, and rarely there was more than one developer working on the scene composition at the same time.</p>
<h2><strong>Waypoint System</strong></h2>
<p>A waypoint system was created, where the philosophy was that all the game flow of a current waypoint is controlled by it, and every waypoint is self contained.</p>
<p>That means that anyone could set any of the waypoints as the starting waypoint, and the game would work perfectly from that point on.</p>
<p>That meant that each waypoint would guarantee that all the systems it needed to run would exist, all actors were set correctly, and from that point on, the game flow could start flawlessly.</p>
<p>This architecture sped up the development process considerably, since we could focus test each waypoint, and bugs found during the execution of a waypoint would be contained to that execution, making it extremely easy to pinpoint them in matter of minutes.</p>
<p><img alt="" src="https://www.sickgamedev.win/wp-content/uploads/2018/04/blog-encapsulated-scene-architecture-for-large-teams-in-unity-1.png" /></p>
<p>Playmaker was chosen as the tool that would handle the game flow so game designers would have more control and less dependency of engineers to create their own waypoints, but this system can be adapted to use any type of flow management the team decides to use.</p>
<p>The SceneManager sends an event to the FSM called “Initialize”, and from that point on, the waypoint should do everything it needs to run correctly.</p>
<p>Spawning of enemies, start and end of battles, opening doors, setting traps, triggering big events should all be done by the waypoint, and actors only satisfies the condition of each node in the waypoint flow that triggers the next node to activate.</p>
<p>Ideally, a waypoint could start in any node and work correctly, but that level of encapsulation may hurt the flexibility of the system and is not required.</p>
<p>[embedded content]</p>
<h2><strong>Scene References</strong></h2>
<p>The second part of this system is the indirect scene references.</p>
<p>Only one GameObject on the scene holds references to anything that is inside the scene that might be needed by any script or FSM.</p>
<p>It is a singleton, and the references are mapped via string path, with a custom editor controlling said references.</p>
<p><img alt="" src="https://www.sickgamedev.win/wp-content/uploads/2018/04/blog-encapsulated-scene-architecture-for-large-teams-in-unity-2.png" /></p>
<p>References in the scene are divided by categories and references, making it easy to map the variables to any script or FSM.</p>
<p>Additionally, an automated FSM variable addition was created to reduce the overhead work for dealing with references this way instead of directly linking a GameObject to a script variable.</p>
<p>This allows the waypoints to be prefabs, and manipulate the scene just by programming using the empty references instead of the actual objects.</p>
<p>At the start of the game, all scripts and FSMs have access to the SceneManager in order to fill the empty references with actual scene objects, allowing the code in them to affect actors and objects in the scene during run time.</p>
<p><img alt="" src="https://www.sickgamedev.win/wp-content/uploads/2018/04/blog-encapsulated-scene-architecture-for-large-teams-in-unity.jpg" /></p>
<h2> </h2>
<h2><strong>Conclusion</strong></h2>
<p>By building an indirect reference and encapsulated flow from ground up , the scene conflicts during development were practically nullified and stability and control over what is happening made bug hunting the easiest the studio has seen so far.</p>
<p>This system is flexible enough that most projects can at least adapt a version of it, allowing to reap the benefits of disconnecting direct references from development and controlling game flow.</p>
</div>