92 lines
3.7 KiB
C#
92 lines
3.7 KiB
C#
using System.Collections.Generic;
|
|
|
|
namespace Syntriax.Engine.Core.Abstract;
|
|
|
|
/// <summary>
|
|
/// Represents a game world responsible for managing <see cref="IHierarchyObject"/>s.
|
|
/// </summary>
|
|
public interface IGameManager : IEntity, IEnumerable<IHierarchyObject>
|
|
{
|
|
/// <summary>
|
|
/// Event triggered when <see cref="Update(EngineTime)"/> is about to be called called on the <see cref="IGameManager"/>.
|
|
/// </summary>
|
|
event UpdateEventHandler? OnPreUpdate;
|
|
|
|
/// <summary>
|
|
/// Event triggered when <see cref="Update(EngineTime)"/> is called on the <see cref="IGameManager"/>.
|
|
/// </summary>
|
|
event UpdateEventHandler? OnUpdate;
|
|
|
|
/// <summary>
|
|
/// Event triggered when <see cref="PreDraw"/> is called on the <see cref="IGameManager"/>.
|
|
/// </summary>
|
|
event PreDrawEventHandler? OnPreDraw;
|
|
|
|
/// <summary>
|
|
/// Event triggered when a <see cref="IHierarchyObject"/> is registered to the <see cref="IGameManager"/>.
|
|
/// </summary>
|
|
event HierarchyObjectRegisteredEventHandler? OnHierarchyObjectRegistered;
|
|
|
|
/// <summary>
|
|
/// Event triggered when a <see cref="IHierarchyObject"/> is unregistered from the <see cref="IGameManager"/>.
|
|
/// </summary>
|
|
event HierarchyObjectUnRegisteredEventHandler? OnHierarchyObjectUnRegistered;
|
|
|
|
/// <summary>
|
|
/// Current time scale the <see cref="IGameManager"/> operates on.
|
|
/// </summary>
|
|
float TimeScale { get; set; }
|
|
|
|
/// <summary>
|
|
/// Contains time data related to this <see cref="IGameManager"/>.
|
|
/// </summary>
|
|
EngineTime Time { get; }
|
|
|
|
/// <summary>
|
|
/// Contains unscaled time data related to this <see cref="IGameManager"/>.
|
|
/// </summary>
|
|
EngineTime UnscaledTime { get; }
|
|
|
|
/// <summary>
|
|
/// Gets a read-only list of <see cref="IHierarchyObject"/>s managed by the <see cref="IGameManager"/>.
|
|
/// </summary>
|
|
IReadOnlyList<IHierarchyObject> HierarchyObjects { get; }
|
|
|
|
/// <summary>
|
|
/// Registers an <see cref="IHierarchyObject"/> to the <see cref="IGameManager"/>.
|
|
/// </summary>
|
|
/// <param name="hierarchyObject">The <see cref="IHierarchyObject"/> to register.</param>
|
|
void Register(IHierarchyObject hierarchyObject);
|
|
|
|
/// <summary>
|
|
/// Instantiates a <see cref="IHierarchyObject"/> of type T with the given arguments and registers it to the <see cref="IGameManager"/>.
|
|
/// </summary>
|
|
/// <typeparam name="T">The type of <see cref="IHierarchyObject"/> to instantiate.</typeparam>
|
|
/// <param name="args">Constructor parameters for the given type of <see cref="IHierarchyObject"/>.</param>
|
|
/// <returns>The instantiated <see cref="IHierarchyObject"/>.</returns>
|
|
T InstantiateHierarchyObject<T>(params object?[]? args) where T : class, IHierarchyObject;
|
|
|
|
/// <summary>
|
|
/// Removes an <see cref="IHierarchyObject"/> from the <see cref="IGameManager"/>.
|
|
/// </summary>
|
|
/// <param name="hierarchyObject">The <see cref="IHierarchyObject"/> to remove.</param>
|
|
void Remove(IHierarchyObject hierarchyObject);
|
|
|
|
/// <summary>
|
|
/// Updates the <see cref="IGameManager"/> with the given delta time.
|
|
/// </summary>
|
|
/// <param name="engineTime">Delta time.</param>
|
|
void Update(EngineTime engineTime);
|
|
|
|
/// <summary>
|
|
/// Performs operations that should be done before the draw calls.
|
|
/// </summary>
|
|
void PreDraw();
|
|
|
|
delegate void UpdateEventHandler(IGameManager sender, EngineTime engineTime);
|
|
delegate void PreDrawEventHandler(IGameManager sender);
|
|
|
|
delegate void HierarchyObjectRegisteredEventHandler(IGameManager sender, IHierarchyObject hierarchyObjectRegistered);
|
|
delegate void HierarchyObjectUnRegisteredEventHandler(IGameManager sender, IHierarchyObject hierarchyObjectUnregistered);
|
|
}
|