Tightly-Coupled Components<\/h1>\n
Let’s say you wanted to create a Player component. You want the GameObject to which the Player component is attached to move when movement input is given, relative to the facing of the camera.<\/p>\n
using UnityEngine;\r\n\r\npublic class Player : MonoBehaviour\r\n{\r\n void Update()\r\n {\r\n Vector2 moveInput = inputManager.MoveInput;\r\n\r\n if(moveInput != Vector2.zero)\r\n {\r\n const float speed = 0.2f;\r\n float time = Time.deltaTime;\r\n float distance = time * speed;\r\n\r\n Vector3 moveDirection = camera.transform.rotation * moveInput;\r\n\r\n transform.Translate(moveDirection * distance);\r\n }\r\n }\r\n}<\/pre>\nIn order for this Player class to function, it requires instances of the InputManager and Camera classes.<\/p>\n
Now one common and straight-forward strategy for resolving a dependency is by having a static property that holds a shared instance of a class, which the dependent class can use to retrieve the instance. This is often implemented using the singleton pattern<\/a>.<\/p>\nusing UnityEngine;\r\n\r\npublic class Player : MonoBehaviour\r\n{\r\n void Update()\r\n {\r\n \/\/ Gets the singleton instance via the static property.\r\n Vector2 moveInput = InputManager.Instance.MoveInput;\r\n\r\n if(moveInput != Vector2.zero)\r\n {\r\n const float speed = 0.2f;\r\n float time = Time.deltaTime;\r\n float distance = time * speed;\r\n\r\n \/\/ Gets the first active Camera with the tag \"MainCamera\" from the loaded scenes.\r\n Vector3 moveDirection = Camera.main.transform.rotation * moveInput;\r\n\r\n transform.Translate(moveDirection * distance);\r\n }\r\n }\r\n}<\/pre>\nThis approach has some issues though. One of them is that the dependencies of the component are hidden, scattered across the body of the class. This means you need to read through the whole script to understand what other objects you need to add to your scene for this component to work.<\/p>\n
Another issue is that it’s very rigid: the class only works with a specific InputManager singleton object, and only with a specific Camera in the scene that has been assigned the “MainCamera” tag.<\/p>\n
You could also take a different approach, and use serialized fields<\/a> instead.<\/p>\nusing UnityEngine;\r\n\r\npublic class Player : MonoBehaviour\r\n{\r\n [SerializeField]\r\n InputManager inputManager;\r\n\r\n [SerializeField]\r\n Camera camera;\r\n\r\n void Update()\r\n {\r\n Vector2 moveInput = inputManager.MoveInput;\r\n\r\n if(moveInput != Vector2.zero)\r\n {\r\n const float speed = 0.2f;\r\n float time = Time.deltaTime;\r\n float distance = time * speed;\r\n\r\n Vector3 moveDirection = camera.transform.rotation * moveInput;\r\n\r\n transform.Translate(moveDirection * distance);\r\n }\r\n }\r\n}<\/pre>\nThis solves some of the issues when it comes to flexibility. Now it’s possible to drag-and-drop any Camera or InputManager object in and the Player class will use them! This is in fact a form of dependency injection.<\/p>\n
But this approach isn’t without its problems either. If you need to change your InputManager to a different instance a couple months later, you will need to go change references in all components across the whole project by hand to point to the new instance. Also when working with prefabs, multiple scenes, or objects that are only created at runtime, it could be impossible to drag-and-drop references in. Not to mention creating unit tests for this component would be very difficult.<\/p>\n
So how can we get rid of all these limitations and downsides, and create loosely coupled components that are as flexible as possible, as well as easily unit testable by default?<\/p>\n
MonoBehaviour<T…><\/h1>\n
The first thing we need to change is explicitly define all the other types that the Player class depends on, as generic arguments of the MonoBehaviour base class.<\/p>\n
public class Player : MonoBehaviour<InputManager, Camera><\/pre>\nTo make this component as flexible as possible, let’s also change the dependency from the concrete InputManager class, into a dependency to an IInputManager interface instead. This way it’s possible to very easily swap the component to use a different implementation at any point. This can be especially useful when writing unit tests.<\/p>\n
public class Player : MonoBehaviour<IInputManager, Camera><\/pre>\nNormally using interfaces in Unity is problematic, firstly because Unity’s serializer doesn’t support Object references in interface type fields, and secondly because there’s no Inspector support for interfaces that would allow any other type of data into these fields either. With Init(args) these are no longer an issue, so we can use interfaces as much as we want.<\/p>\n
After this you’ll need to do two things to get the code to compile:<\/p>\n
\n- Import types from the
Sisus.Init<\/code> namespace with a using directive.<\/li>\n- Implement the
Init<\/code> method to receive the IInputManager and Camera references and assign them into fields.<\/li>\n<\/ol>\nYou can automatically do both by selecting the Generate Init method<\/code> context action in your IDE.<\/p>\n![\"Generate](\"https:\/\/docs.sisus.co\/init-args\/wp-content\/uploads\/sites\/6\/2022\/09\/2026-09-17-12_58_06-Init-args-\u2013-Player.cs_.png\")
<\/p>\n
If your IDE cannot resolve the Sisus<\/code> namespace, you might need first add InitArgs<\/em> to the Assembly Definition References<\/em> list in your Assembly Definition Asset<\/em><\/a>.<\/p>\n![\"\"](\"https:\/\/docs.sisus.co\/init-args\/wp-content\/uploads\/sites\/6\/2022\/09\/2022-09-17-17_04_21-Greenshot.png\")
<\/p>\n
After this you can get rid of the [SerializeField]<\/code> attributes above our fields – the dependencies will now be getting provided through the Init<\/code> method at runtime, not stored in these fields.<\/p>\nusing Sisus.Init;\r\nusing UnityEngine;\r\n\r\npublic class Player : MonoBehaviour<IInputManager, Camera>\r\n{\r\n\u00a0 \u00a0 IInputManager inputManager;\r\n\u00a0 \u00a0 Camera camera;\r\n\r\n\u00a0 \u00a0 protected override void Init(IInputManager inputManager, Camera camera) \u00a0 \u00a0\r\n\u00a0 \u00a0 {\r\n\u00a0 \u00a0 \u00a0 \u00a0 this.inputManager = inputManager;\r\n\u00a0 \u00a0 \u00a0 \u00a0 this.camera = camera;\r\n\u00a0 \u00a0 }\r\n\r\n\u00a0 \u00a0 void Update()\r\n\u00a0 \u00a0 {\r\n\u00a0 \u00a0 \u00a0 \u00a0 Vector2 moveInput = inputManager.MoveInput;\r\n\u00a0 \u00a0 \u00a0 \u00a0 if(moveInput != Vector2.zero)\r\n\u00a0 \u00a0 \u00a0 \u00a0 {\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 const float speed = 0.2f;\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 float time = Time.deltaTime;\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 float distance = time * speed;\r\n \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 Vector3 moveDirection = camera.transform.rotation * moveInput;\r\n \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 transform.Translate(moveDirection * distance);\r\n\u00a0 \u00a0 \u00a0 \u00a0 }\r\n\u00a0 \u00a0 }\r\n}<\/pre>\nAnd that’s it, we are now all done creating our extra flexible Player component that receives all its dependencies via dependency injection.<\/p>\n
If both IInputManager and Camera are turned into services<\/a>, then the component will receive them automatically.<\/p>\nIf you want to configure them using the Inspector with cross-scene reference<\/a> support, that’s also possible using an Initializer<\/a>.<\/p>\n