Dekuple

A dependancy-injection and entity system designed from the ground up to support both rapid prototyping and long-term development and support of Unity3d based applications.

The system also adds a MVC or Model-View-Controller pattern.

Except in this case, the Controller is called an Agent and uses the Flow library, and Views are based on MonoBehaviors.

The basic architecture is a morphism of a number ideas combined together into an integrated whole:

• Dependancy Injection
• Object Registry/Factory for persistence and networking
• Model/View/Controller, or Model/ViewController/View
• Unity3d Prefabs and Behaviours
• Reactive programming techniques

The code is not 'tricky', other than the hoops required for templates in C#. The key hurdle a user will face is simply understanding the architecture and semantics of the seemingly simple systems.

One key understanding required is that one Registry\<T> class is used for each model/agent/view domains, but of course with a different template parameter T.

There are Readme's in each substantial sub-folder that describes each component in more detail.

Unity Package

This repo is designed to be used as a Untiy3d Package. However, there are also Dekuple.{sln,proj} available so it can be opened in VisualStudio independantly. This results in these files being in the Unity3d package, even though they are unused. They hence also have .meta files.

Do not delete these or their .meta files.

Dependancies

This library uses the external CoLib and Flow libraries. These are added as git sub-modules.

Main Components

• Registry
• Model
• Agent
• View

Request/Response

Used for internal message-passing/queing and in future for networking when combined with the Pyro system.

Future Work

This system is intended to be used with the new Unity3d ECS system.

Currently, only the View system has any reference to Unity3d.

It would be nice to separate that into a separate Assembly, so the system could be used outside the context of Unity3d.

Docs

Obsolete Unity Methods

Awake

Unity's Awake function, do not use within Dekuple entities - see Create.

Start

Unity's Start function, do not use within Dekuple entities - see Begin.

OnDestroy

Unity's OnDestroy function, do not use within Dekuple entities - instead subscribe to the OnDestroyed event.

Dekuple Documentation

Create

Alternative to Awake within Dekuple entities, called before Begin. Ensure that base.Create() is called.

Begin

Alternative to Start within Dekuple entities. Ensure that base.Begin() is called.

AddSubscriptions

Called after the object has been prepared, all dependencies have been resolved and all injections completed. Use this for initialising things that depend on injections.

Main.NewEntity

public TIView Main.NewEntity<TIView, TIAgent, TIModel>(Object prefab)

Create a new, complete entity from the given prefab. The simplest way to create a new entity.

Main.SetupEntities

private TIView[] Main.SetupEntities<TIView, TIAgent, TIModel>(params object[] args)

Create and prepare models and agents for objects of type TIView that exist in the scene.

ViewRegistry.FromPrefab

public TIView FromPrefab<TIView>(Object prefab);
public TIView FromPrefab<TIView>(Object prefab, Transform parent);
public TIView FromPrefab<TIView>(Object prefab,  IRegistry<TIAgent> agents);
public TIView FromPrefab<TIView>(Object prefab,  IAgent agent);
public TIView FromPrefab<TIView>(Object prefab, IRegistry<TIModel> models, IRegistry<TIAgent> agents = null);

Create a new View from the given prefab. Its model and agent will need to be added seperately if required. Equivalent to UnityEngine.Object.Instantiate.

Registry.Bind<TInterface, TImpl>()

Connect the given interface and concrete type together in the registry.

ViewRegistry.Bind<TInterface, TImpl>(T single)

Connect the given interface and concrete together as a singleton instance. Will create a GameObject given a prefab or connect to an existing GameObject within the scene.

ViewRegistry.InjectAllGameObjects()

Resolve all injections for GameObjects of type ViewBase that exist within the scene.

Registry.AddAllSubscriptions()

Invoke AddSubscriptions() for all instances in the given registry.

TODO

Make Error(..) etc log methods return object so they can return null and simplify usage.