extrys / lightweightsignalbuses Goto Github PK

This is the documentation example that's not correct

//The signal types
public struct SignalPlayerDamaged : ISignalPlayerHpChanged
{
    ISignalPlayerHpChanged.PlayerHp => playerHp;
    public float playerHp;
}
public struct SignalPlayerDamaged : ISignalPlayerHpChanged
{
    ISignalPlayerHpChanged.PlayerHp => playerHp;
    public float playerHp;
}

//The interface for the signals
public struct ISignalPlayerHpChanged
{
    float PlayerHp { get; }
}

This is the correct version that compiles

//The interface for the signals
public interface ISignalPlayerHpChanged
{
    public float PlayerHp { get; }
}

//The signal types
public struct SignalPlayerDamaged : ISignalPlayerHpChanged
{
    public float playerHp;

    public float PlayerHp => playerHp;
}

public struct SignalPlayerHealed : ISignalPlayerHpChanged
{
    public float playerHp;

    public float PlayerHp => playerHp;
}

Actual Behaviour:

You have to call abstract signals using SignalBus.AbstractFire<T>(T t)

Desired Behaviour

You should be able to call it SignalBus<T>.AbstractFire(T t)

Motivation:

SignalBus class is used for everything except for abstract Signals, which feels a little odd. I propose that InterfaceCompatibleSignal.cs classes are just helpers for LightWeightSignalBus.cs abstracted to the user.

Proposal:

Add AbstractFire method to SignalBus that internally calls Signal.AbstractFire(T t)

This repo contains two classes that are similar but not the same and can be confusing to have both. I would suggest splitting the repo into two and improving documentation, as the one we have now in the readme aren't good as it has errors and don't compile