perf!: events refactored throughout all the project to use Event<> class

All delegate events are refactored to use the Event<TSender> and Event<TSender, TArgument> for performance issues regarding delegate events creating garbage, also this gives us better control on event invocation since C# Delegates did also create unnecessary garbage during Delegate.DynamicInvoke
This commit is contained in:
2025-05-31 00:14:43 +03:00
parent 996e61d0ad
commit 61e2761580
58 changed files with 637 additions and 485 deletions

View File

@@ -4,15 +4,15 @@ namespace Syntriax.Engine.Systems.Input;
public interface IButtonInputs<T> : IHasStateEnable
{
event ButtonCallbackEventHandler? OnAnyButtonPressed;
event ButtonCallbackEventHandler? OnAnyButtonReleased;
Event<IButtonInputs<T>, ButtonCallbackArguments> OnAnyButtonPressed { get; }
Event<IButtonInputs<T>, ButtonCallbackArguments> OnAnyButtonReleased { get; }
void RegisterOnPress(T button, ButtonCallbackEventHandler callback);
void UnregisterOnPress(T button, ButtonCallbackEventHandler callback);
void RegisterOnRelease(T button, ButtonCallbackEventHandler callback);
void UnregisterOnRelease(T button, ButtonCallbackEventHandler callback);
void RegisterOnPress(T button, Event<IButtonInputs<T>, ButtonCallbackArguments>.EventHandler callback);
void UnregisterOnPress(T button, Event<IButtonInputs<T>, ButtonCallbackArguments>.EventHandler callback);
void RegisterOnRelease(T button, Event<IButtonInputs<T>, ButtonCallbackArguments>.EventHandler callback);
void UnregisterOnRelease(T button, Event<IButtonInputs<T>, ButtonCallbackArguments>.EventHandler callback);
bool IsPressed(T button);
delegate void ButtonCallbackEventHandler(IButtonInputs<T> buttonInputs, T button);
readonly record struct ButtonCallbackArguments(T Button);
}

View File

@@ -4,10 +4,10 @@ namespace Syntriax.Engine.Systems.StateMachine;
public interface IState : IEntity, INameable
{
event StateUpdateEventHandler? OnStateUpdate;
event StateTransitionedFromEventHandler? OnStateTransitionedFrom;
event StateTransitionedToEventHandler? OnStateTransitionedTo;
event StateTransitionReadyEventHandler? OnStateTransitionReady;
Event<IState> OnStateUpdate { get; }
Event<IState, StateTransitionedFromArguments> OnStateTransitionedFrom { get; }
Event<IState, StateTransitionedToArguments> OnStateTransitionedTo { get; }
Event<IState, StateTransitionReadyArguments> OnStateTransitionReady { get; }
IState? GetNextState();
@@ -15,8 +15,7 @@ public interface IState : IEntity, INameable
void TransitionTo(IState from);
void TransitionFrom(IState to);
delegate void StateUpdateEventHandler(IState sender);
delegate void StateTransitionedFromEventHandler(IState sender, IState toState);
delegate void StateTransitionedToEventHandler(IState sender, IState fromState);
delegate void StateTransitionReadyEventHandler(IState sender, IState toState);
readonly record struct StateTransitionedFromArguments(IState ToState);
readonly record struct StateTransitionedToArguments(IState FromState);
readonly record struct StateTransitionReadyArguments(IState ToState);
}

View File

@@ -6,11 +6,11 @@ namespace Syntriax.Engine.Systems.StateMachine;
public class State : BaseEntity, IState
{
public event IState.StateUpdateEventHandler? OnStateUpdate = null;
public event IState.StateTransitionedFromEventHandler? OnStateTransitionedFrom = null;
public event IState.StateTransitionedToEventHandler? OnStateTransitionedTo = null;
public event IState.StateTransitionReadyEventHandler? OnStateTransitionReady = null;
public event INameable.NameChangedEventHandler? OnNameChanged = null;
public Event<IState> OnStateUpdate { get; } = new();
public Event<IState, IState.StateTransitionedFromArguments> OnStateTransitionedFrom { get; } = new();
public Event<IState, IState.StateTransitionedToArguments> OnStateTransitionedTo { get; } = new();
public Event<IState, IState.StateTransitionReadyArguments> OnStateTransitionReady { get; } = new();
public Event<INameable, INameable.NameChangedArguments> OnNameChanged { get; } = new();
private readonly List<StateTransition> transitions = [];
private readonly Dictionary<string, StateTransition> possibleTransitions = [];
@@ -28,7 +28,7 @@ public class State : BaseEntity, IState
string previousName = _name;
_name = value;
OnNameChanged?.Invoke(this, previousName);
OnNameChanged?.Invoke(this, new(previousName));
}
}
@@ -53,12 +53,12 @@ public class State : BaseEntity, IState
public void Update()
{
if (GetNextState() is IState transitionState)
OnStateTransitionReady?.Invoke(this, transitionState);
OnStateTransitionReady?.Invoke(this, new(transitionState));
OnStateUpdate?.Invoke(this);
}
public void TransitionTo(IState from) => OnStateTransitionedTo?.Invoke(this, from);
public void TransitionFrom(IState to) => OnStateTransitionedFrom?.Invoke(this, to);
public void TransitionTo(IState from) => OnStateTransitionedTo?.Invoke(this, new(from));
public void TransitionFrom(IState to) => OnStateTransitionedFrom?.Invoke(this, new(to));
public IState? GetNextState()
{

View File

@@ -4,12 +4,11 @@ namespace Syntriax.Engine.Systems.StateMachine;
public abstract class StateBehaviourBase : Behaviour, IState
{
public event IState.StateUpdateEventHandler? OnStateUpdate = null;
public event IState.StateTransitionedFromEventHandler? OnStateTransitionedFrom = null;
public event IState.StateTransitionedToEventHandler? OnStateTransitionedTo = null;
public event INameable.NameChangedEventHandler? OnNameChanged = null;
public abstract event IState.StateTransitionReadyEventHandler? OnStateTransitionReady;
public Event<IState> OnStateUpdate { get; } = new();
public Event<IState, IState.StateTransitionedFromArguments> OnStateTransitionedFrom { get; } = new();
public Event<IState, IState.StateTransitionedToArguments> OnStateTransitionedTo { get; } = new();
public Event<IState, IState.StateTransitionReadyArguments> OnStateTransitionReady { get; } = new();
public Event<INameable, INameable.NameChangedArguments> OnNameChanged { get; } = new();
private string _name = string.Empty;
public string Name
@@ -22,7 +21,7 @@ public abstract class StateBehaviourBase : Behaviour, IState
string previousName = _name;
_name = value;
OnNameChanged?.Invoke(this, previousName);
OnNameChanged?.Invoke(this, new(previousName));
}
}
@@ -37,14 +36,14 @@ public abstract class StateBehaviourBase : Behaviour, IState
public void TransitionTo(IState from)
{
OnTransitionedToState(from);
OnStateTransitionedTo?.Invoke(this, from);
OnStateTransitionedTo?.Invoke(this, new(from));
}
protected virtual void OnTransitionedFromState(IState to) { }
public void TransitionFrom(IState to)
{
OnTransitionedFromState(to);
OnStateTransitionedFrom?.Invoke(this, to);
OnStateTransitionedFrom?.Invoke(this, new(to));
}
public abstract IState? GetNextState();

View File

@@ -5,9 +5,17 @@ namespace Syntriax.Engine.Systems.StateMachine;
public class StateMachine : Behaviour
{
public event StateChangedEventHandler? OnStateChanged = null;
public Event<StateMachine, StateChangedArguments> OnStateChanged { get; } = new();
private readonly Event<IState, IState.StateTransitionReadyArguments>.EventHandler delegateOnStateTransitionReady = null!;
private IState _state = new State();
public StateMachine()
{
delegateOnStateTransitionReady = OnStateTransitionReady;
}
[Serialize]
public IState State
{
@@ -18,20 +26,20 @@ public class StateMachine : Behaviour
return;
IState previousState = _state;
previousState.OnStateTransitionReady -= OnStateTransitionReady;
previousState.OnStateTransitionReady.RemoveListener(delegateOnStateTransitionReady);
_state = value;
previousState.TransitionFrom(value);
value.TransitionTo(_state);
OnStateChanged?.Invoke(this, previousState, value);
OnStateChanged?.Invoke(this, new(value, previousState));
value.OnStateTransitionReady += OnStateTransitionReady;
value.OnStateTransitionReady.AddListener(delegateOnStateTransitionReady);
}
}
private void OnStateTransitionReady(IState sender, IState toState)
private void OnStateTransitionReady(IState sender, IState.StateTransitionReadyArguments args)
{
State = toState;
State = args.ToState;
while (State.GetNextState() is IState nextState)
State = nextState;
}
@@ -47,5 +55,5 @@ public class StateMachine : Behaviour
State.Update();
}
public delegate void StateChangedEventHandler(StateMachine sender, IState previousState, IState newState);
public readonly record struct StateChangedArguments(IState CurrentState, IState PreviousState);
}

View File

@@ -1,18 +1,19 @@
using Syntriax.Engine.Core;
namespace Syntriax.Engine.Systems.Time;
public interface IReadOnlyStopwatch
{
event StopwatchEventHandler? OnStarted;
event StopwatchDeltaEventHandler? OnDelta;
event StopwatchEventHandler? OnStopped;
Event<IReadOnlyStopwatch> OnStarted { get; }
Event<IReadOnlyStopwatch, StopwatchDeltaArguments> OnDelta { get; }
Event<IReadOnlyStopwatch> OnStopped { get; }
double Time { get; }
TimerState State { get; }
event StopwatchEventHandler? OnPaused;
event StopwatchEventHandler? OnResumed;
Event<IReadOnlyStopwatch> OnPaused { get; }
Event<IReadOnlyStopwatch> OnResumed { get; }
delegate void StopwatchEventHandler(IReadOnlyStopwatch sender);
delegate void StopwatchDeltaEventHandler(IReadOnlyStopwatch sender, double delta);
readonly record struct StopwatchDeltaArguments(double Delta);
}

View File

@@ -1,11 +1,11 @@
using Syntriax.Engine.Core;
namespace Syntriax.Engine.Systems.Time;
public interface IReadOnlyTicker : IReadOnlyStopwatch
{
event TickerTickEventHandler? OnTick;
Event<IReadOnlyTicker> OnTick { get; }
int TickCounter { get; }
double TickPeriod { get; set; }
delegate void TickerTickEventHandler(IReadOnlyTicker sender);
}

View File

@@ -1,13 +1,15 @@
using Syntriax.Engine.Core;
namespace Syntriax.Engine.Systems.Time;
public interface IReadOnlyTimer
{
event TimerEventHandler? OnStarted;
event TimerDeltaEventHandler? OnDelta;
event TimerEventHandler? OnStopped;
Event<IReadOnlyTimer> OnStarted { get; }
Event<IReadOnlyTimer, TimerDeltaArguments> OnDelta { get; }
Event<IReadOnlyTimer> OnStopped { get; }
event TimerEventHandler? OnPaused;
event TimerEventHandler? OnResumed;
Event<IReadOnlyTimer> OnPaused { get; }
Event<IReadOnlyTimer> OnResumed { get; }
double StartTime { get; }
double Remaining { get; }
@@ -16,7 +18,6 @@ public interface IReadOnlyTimer
TimerState State { get; }
delegate void TimerEventHandler(IReadOnlyTimer sender);
delegate void TimerDeltaEventHandler(IReadOnlyTimer sender, double delta);
readonly record struct TimerDeltaArguments(double delta);
}

View File

@@ -1,11 +1,11 @@
using Syntriax.Engine.Core;
namespace Syntriax.Engine.Systems.Time;
public interface ITicker : IStopwatch
{
event TickerTickEventHandler? OnTick;
Event<ITicker> OnTick { get; }
int TickCounter { get; }
double Period { get; set; }
delegate void TickerTickEventHandler(ITicker sender);
}

View File

@@ -4,11 +4,11 @@ namespace Syntriax.Engine.Systems.Time;
public class StopwatchBehaviour : Behaviour, IStopwatch
{
public event IReadOnlyStopwatch.StopwatchEventHandler? OnStarted = null;
public event IReadOnlyStopwatch.StopwatchDeltaEventHandler? OnDelta = null;
public event IReadOnlyStopwatch.StopwatchEventHandler? OnStopped = null;
public event IReadOnlyStopwatch.StopwatchEventHandler? OnPaused = null;
public event IReadOnlyStopwatch.StopwatchEventHandler? OnResumed = null;
public Event<IReadOnlyStopwatch> OnStarted { get; } = new();
public Event<IReadOnlyStopwatch, IReadOnlyStopwatch.StopwatchDeltaArguments> OnDelta { get; } = new();
public Event<IReadOnlyStopwatch> OnStopped { get; } = new();
public Event<IReadOnlyStopwatch> OnPaused { get; } = new();
public Event<IReadOnlyStopwatch> OnResumed { get; } = new();
public double Time { get; protected set; } = 0f;
public TimerState State { get; protected set; } = TimerState.Idle;
@@ -46,7 +46,7 @@ public class StopwatchBehaviour : Behaviour, IStopwatch
double delta = Universe.Time.DeltaSpan.TotalSeconds;
Time += delta;
OnDelta?.Invoke(this, delta);
OnDelta?.Invoke(this, new(delta));
}
protected override void OnEnteredUniverse(IUniverse universe)

View File

@@ -4,7 +4,7 @@ namespace Syntriax.Engine.Systems.Time;
public class TickerBehaviour : StopwatchBehaviour, ITicker
{
public event ITicker.TickerTickEventHandler? OnTick = null;
public Event<ITicker> OnTick { get; } = new();
public double Period { get; set; } = 1f;
public int TickCounter { get; private set; } = 0;

View File

@@ -4,11 +4,11 @@ namespace Syntriax.Engine.Systems.Time;
public class TimerBehaviour : Behaviour, ITimer
{
public event IReadOnlyTimer.TimerEventHandler? OnStarted = null;
public event IReadOnlyTimer.TimerDeltaEventHandler? OnDelta = null;
public event IReadOnlyTimer.TimerEventHandler? OnStopped = null;
public event IReadOnlyTimer.TimerEventHandler? OnPaused = null;
public event IReadOnlyTimer.TimerEventHandler? OnResumed = null;
public Event<IReadOnlyTimer> OnStarted { get; } = new();
public Event<IReadOnlyTimer, IReadOnlyTimer.TimerDeltaArguments> OnDelta { get; } = new();
public Event<IReadOnlyTimer> OnStopped { get; } = new();
public Event<IReadOnlyTimer> OnPaused { get; } = new();
public Event<IReadOnlyTimer> OnResumed { get; } = new();
public TimerState State { get; protected set; } = TimerState.Idle;
public double StartTime { get; protected set; } = 0f;
@@ -61,7 +61,7 @@ public class TimerBehaviour : Behaviour, ITimer
double delta = Universe.Time.DeltaSpan.TotalSeconds;
Remaining -= delta;
OnDelta?.Invoke(this, delta);
OnDelta?.Invoke(this, new(delta));
if (Remaining <= .0f)
Stop();

View File

@@ -1,16 +1,18 @@
using Syntriax.Engine.Core;
namespace Syntriax.Engine.Systems.Tween;
public interface ITween
{
event TweenEventHandler? OnStarted;
event TweenEventHandler? OnPaused;
event TweenEventHandler? OnResumed;
event TweenEventHandler? OnCancelled;
event TweenEventHandler? OnCompleted;
event TweenEventHandler? OnEnded;
Event<ITween> OnStarted { get; }
Event<ITween> OnPaused { get; }
Event<ITween> OnResumed { get; }
Event<ITween> OnCancelled { get; }
Event<ITween> OnCompleted { get; }
Event<ITween> OnEnded { get; }
event TweenEventHandler? OnUpdated;
event TweenDeltaEventHandler? OnDeltaUpdated;
Event<ITween> OnUpdated { get; }
Event<ITween, TweenDeltaArguments> OnDeltaUpdated { get; }
TweenState State { get; set; }
@@ -19,7 +21,6 @@ public interface ITween
float Progress { get; }
float Value { get; }
delegate void TweenEventHandler(ITween sender);
delegate void TweenDeltaEventHandler(ITween sender, float delta);
readonly record struct TweenDeltaArguments(float Delta);
}

View File

@@ -4,14 +4,14 @@ namespace Syntriax.Engine.Systems.Tween;
internal class Tween : ITween
{
public event ITween.TweenEventHandler? OnStarted = null;
public event ITween.TweenEventHandler? OnPaused = null;
public event ITween.TweenEventHandler? OnResumed = null;
public event ITween.TweenEventHandler? OnCancelled = null;
public event ITween.TweenEventHandler? OnCompleted = null;
public event ITween.TweenEventHandler? OnEnded = null;
public event ITween.TweenEventHandler? OnUpdated = null;
public event ITween.TweenDeltaEventHandler? OnDeltaUpdated = null;
public Event<ITween> OnStarted { get; } = new();
public Event<ITween> OnPaused { get; } = new();
public Event<ITween> OnResumed { get; } = new();
public Event<ITween> OnCancelled { get; } = new();
public Event<ITween> OnCompleted { get; } = new();
public Event<ITween> OnEnded { get; } = new();
public Event<ITween> OnUpdated { get; } = new();
public Event<ITween, ITween.TweenDeltaArguments> OnDeltaUpdated { get; } = new();
private TweenState _state = TweenState.Idle;
public TweenState State
@@ -60,7 +60,7 @@ internal class Tween : ITween
Progress = Counter / Duration;
OnUpdated?.Invoke(this);
OnDeltaUpdated?.Invoke(this, Easing.Evaluate(Progress) - Easing.Evaluate(previousProgress));
OnDeltaUpdated?.Invoke(this, new(Easing.Evaluate(Progress) - Easing.Evaluate(previousProgress)));
if (_counter >= Duration)
State = TweenState.Completed;
@@ -74,6 +74,22 @@ internal class Tween : ITween
State = TweenState.Idle;
}
internal void Wipe()
{
OnStarted.Clear();
OnPaused.Clear();
OnResumed.Clear();
OnCancelled.Clear();
OnCompleted.Clear();
OnEnded.Clear();
OnUpdated.Clear();
OnDeltaUpdated.Clear();
Easing = EaseLinear.Instance;
Reset();
}
public Tween() { }
public Tween(float duration)
{

View File

@@ -1,7 +1,5 @@
using System;
using Syntriax.Engine.Core;
namespace Syntriax.Engine.Systems.Tween;
public static class TweenExtensions
@@ -11,14 +9,14 @@ public static class TweenExtensions
Tween tweenConcrete = (Tween)tween;
int counter = count;
tweenConcrete.OnCompleted += _ =>
tweenConcrete.OnCompleted.AddListener(_ =>
{
if (counter-- <= 0)
return;
tweenConcrete.Reset();
tweenConcrete.State = TweenState.Playing;
};
});
return tween;
}
@@ -26,11 +24,11 @@ public static class TweenExtensions
public static ITween LoopInfinitely(this ITween tween)
{
Tween tweenConcrete = (Tween)tween;
tweenConcrete.OnCompleted += _ =>
tweenConcrete.OnCompleted.AddListener(_ =>
{
tweenConcrete.Reset();
tweenConcrete.State = TweenState.Playing;
};
});
return tween;
}
@@ -45,57 +43,49 @@ public static class TweenExtensions
public static ITween OnStart(this ITween tween, Action callback)
{
Tween tweenConcrete = (Tween)tween;
tweenConcrete.OnStarted += _ => callback.Invoke();
tween.OnStarted.AddListener(_ => callback.Invoke());
return tween;
}
public static ITween OnPause(this ITween tween, Action callback)
{
Tween tweenConcrete = (Tween)tween;
tweenConcrete.OnPaused += _ => callback.Invoke();
tween.OnPaused.AddListener(_ => callback.Invoke());
return tween;
}
public static ITween OnResume(this ITween tween, Action callback)
{
Tween tweenConcrete = (Tween)tween;
tweenConcrete.OnResumed += _ => callback.Invoke();
tween.OnResumed.AddListener(_ => callback.Invoke());
return tween;
}
public static ITween OnCancel(this ITween tween, Action callback)
{
Tween tweenConcrete = (Tween)tween;
tweenConcrete.OnCancelled += _ => callback.Invoke();
tween.OnCancelled.AddListener(_ => callback.Invoke());
return tween;
}
public static ITween OnComplete(this ITween tween, Action callback)
{
Tween tweenConcrete = (Tween)tween;
tweenConcrete.OnCompleted += _ => callback.Invoke();
tween.OnCompleted.AddListener(_ => callback.Invoke());
return tween;
}
public static ITween OnEnd(this ITween tween, Action callback)
{
Tween tweenConcrete = (Tween)tween;
tweenConcrete.OnEnded += _ => callback.Invoke();
tween.OnEnded.AddListener(_ => callback.Invoke());
return tween;
}
public static ITween OnUpdate(this ITween tween, Action callback)
{
Tween tweenConcrete = (Tween)tween;
tweenConcrete.OnUpdated += _ => callback.Invoke();
tween.OnUpdated.AddListener(_ => callback.Invoke());
return tween;
}
public static ITween OnDeltaUpdate(this ITween tween, Action<float> callback)
{
Tween tweenConcrete = (Tween)tween;
tweenConcrete.OnDeltaUpdated += (_, delta) => callback.Invoke(delta);
tween.OnDeltaUpdated.AddListener((_, arguments) => callback.Invoke(arguments.Delta));
return tween;
}
}

View File

@@ -15,7 +15,7 @@ public class TweenManager : UniverseObject, ITweenManager
public ITween StartTween(float duration, ITweenManager.TweenSetCallback? setCallback = null)
{
Tween tween = Get(duration);
tween.OnUpdated += tween => setCallback?.Invoke(tween.Value);
tween.OnUpdated.AddListener(tween => setCallback?.Invoke(tween.Value));
runningCoroutines.Add(tween, coroutineManager.StartCoroutine(RunTween(tween)));
return tween;
}
@@ -59,6 +59,7 @@ public class TweenManager : UniverseObject, ITweenManager
}
runningCoroutines.Remove(tween);
Return(tween);
}
public void CancelTween(ITween tween)