docs(core): Abstract

This commit is contained in:
2024-02-01 12:14:53 +03:00
parent 4ce9c8e0d9
commit 2f4137dae2
10 changed files with 178 additions and 47 deletions

View File

@@ -3,22 +3,22 @@ using System;
namespace Syntriax.Engine.Core.Abstract;
/// <summary>
/// Responsible for every behaviour an object in the game might have, controlled by <see cref="IBehaviourController"/>.
/// Represents a behaviour that any object in the game might use to interact with itself or other objects.
/// </summary>
public interface IBehaviour : IEntity, IAssignableBehaviourController, IAssignableStateEnable, IInitialize
{
/// <summary>
/// Callback triggered when the <see cref="Priority"/> has changed.
/// Event triggered when the priority of the <see cref="IBehaviour"/> changes.
/// </summary>
Action<IBehaviour>? OnPriorityChanged { get; set; }
/// <summary>
/// Call priority of the <see cref="IBehaviour"/>.
/// The priority of the <see cref="IBehaviour"/>.
/// </summary>
int Priority { get; set; }
/// <summary>
/// If the <see cref="IBehaviour"/> is active.
/// The value indicating whether the <see cref="IBehaviour"/> is active.
/// </summary>
bool IsActive { get; }
}