GameCore

Code patterns and tools required in absolutely every game.

Requires the Addressables and Editor Coroutines packages!

Tools

• Ctrl + G: Simulate physics for selected GameObjects
• Ctrl + R: Replace selected GameObjects
• Ctrl + Shift + T: Apply world transform positions to the children of all selected GameObjects and move the selected GameObjects to (0,0,0); This is useful for folder GameObjects

Event

Simple global, type based event system. Events must be classes and derive from IEvent.

public struct DeathEvent : IEvent {
    public Actor Player;
    public DeathEvent(Actor player) {
        Player = player;
    }
}

EventHub<DeathEvent>.Emit(new(...));

You can either have a delegate to a specific event:

void OnDeath(DeathEvent evt) { }

EventHub<DeathEvent>.AddHandler(OnDeath);
...
EventHub<DeathEvent>.RemoveHandler(OnDeath);

or listen to all events and filter the ones you care for yourself. This is much more performant and simpler to use in case you have a lot of handlers in a single place (such as UI):

public class MyUI : MonoBehaviour, IEventListener {
    void OnEnable() {
        EventHub.AddListener(this);
    }

    void OnDisable() {
        EventHub.RemoveListener(this);
    }

    public void OnEvent(IEvent evt) {
        switch (evt) {
            case DeathEvent evt2:
                OnDeath(evt2);
                break;
        }
    }

    void OnDeath(DeathEvent evt) {}
}

To trigger a global event with a UI Button place a EventSource component on the button, link the Buttons onClick event to EventSource.Emit and setup your event in EventSource inspector (your need to have an IEvent-derived class first). Then add a listener in code.

Service

Simple global, type based service system. This basically allows 2 things over the usual global static reference: bind to an interface (as shown in the example) and have more consistent usage and lifetime.

public interface ISearchService : IService { }

public class GoogleSearchService : ISearchService {}
public class DuckDuckGoSearchService : ISearchService {}

...

ServiceHub<ISearchService>.Bind(new GoogleSearchService());

...

ServiceHub<ISearchService>.Instance

StateMachine

public class MyContext {
}

public class TestState : State<MyContext> {
    // No instance per Context, but per class
    // Instance specific things are kept in MyContext
    static TestState _instance;
    static public TestState Instance {
        get {
            if (_instance == null) {
                _instance = new TestState();
            }
            return _instance;
        }
    }

    public override void EnterState(MyContext ctx) {
    }

    public override void ExitState(MyContext ctx) {
    }

    public override void UpdateState(MyContext ctx) {
    }
}

...

var ctx = new MyContext();
var stateMachine = new StateMachine<MyContext>(ctx);
stateMachine.ChangeState(TestState.Instance);

SelectImplementation

In combination with SerializeReference this allows for lists of derived objects.

public interface IEntry {}

public class MyList : ScriptableObject {
    [SerializableReference]
    [SelectImplementation(typeof(IEntry))]
    public IEntry[] Entries;
}

GlobalData

Very simple and convinient global ScriptableObject singleton system.

The system enforces uniform semantics for global data and systems. Derive from the class and open the editor at Window/Global Data where all GlobalData derived classes are listed with their editable instances. No need to create the ScriptableObject asset yourself.

public class SomeSystemOrData : GlobalData<SomeSystemOrData> {
    public int Data;
}

...

void Start() {
    StartCoroutine(LoadGame());
}

IEnumerator LoadGame() {
    yield return SomeSystemOrData.Load(); // Load data via Addressables
    
    ...

    Debug.Log($"Data: {SomeSystemOrData.Instance.Data}");
}

DebugExt

Proper debug drawing for Unity. Call from everywhere, nothing to setup, stays on the screen when the game is paused, works in editor and game viewports and is toggable via the Gizmos button. 3d shapes, 3d text, 2d viewport lines.

DebugExt.DrawLine
DebugExt.DrawRect
DebugExt.DrawText
DebugExt.DrawWireSphere
DebugExt.DrawWireCapsule
DebugExt.DrawViewportLine