docs: Core IAssignable
This commit is contained in:
parent
3e9c393817
commit
4ce9c8e0d9
@ -8,7 +8,7 @@ namespace Syntriax.Engine.Core.Abstract;
|
|||||||
public interface IAssignable
|
public interface IAssignable
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Callback triggered when the <see cref="IAssignable"/>'s fields are unassigned and completely ready to recycle.
|
/// Event triggered when the <see cref="IAssignable"/>'s fields are unassigned and completely ready to recycle.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
Action<IAssignable>? OnUnassigned { get; set; }
|
Action<IAssignable>? OnUnassigned { get; set; }
|
||||||
|
|
||||||
|
@ -8,7 +8,7 @@ namespace Syntriax.Engine.Core.Abstract;
|
|||||||
public interface IAssignableBehaviourController : IAssignable
|
public interface IAssignableBehaviourController : IAssignable
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Callback triggered when the <see cref="IBehaviourController"/> value has has been assigned a new value.
|
/// Event triggered when the <see cref="IBehaviourController"/> value has has been assigned a new value.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
Action<IAssignableBehaviourController>? OnBehaviourControllerAssigned { get; set; }
|
Action<IAssignableBehaviourController>? OnBehaviourControllerAssigned { get; set; }
|
||||||
|
|
||||||
@ -16,7 +16,7 @@ public interface IAssignableBehaviourController : IAssignable
|
|||||||
IBehaviourController BehaviourController { get; }
|
IBehaviourController BehaviourController { get; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Assign a value to the <see cref="IBehaviourController"/> field of this object
|
/// Assign a value to the <see cref="IBehaviourController"/> field of this object.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="behaviourController">New <see cref="IBehaviourController"/> to assign.</param>
|
/// <param name="behaviourController">New <see cref="IBehaviourController"/> to assign.</param>
|
||||||
/// <returns>
|
/// <returns>
|
||||||
|
@ -8,7 +8,7 @@ namespace Syntriax.Engine.Core.Abstract;
|
|||||||
public interface IAssignableEntity : IAssignable
|
public interface IAssignableEntity : IAssignable
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Callback triggered when the <see cref="IEntity"/> value has has been assigned a new value.
|
/// Event triggered when the <see cref="IEntity"/> value has has been assigned a new value.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
Action<IAssignableEntity>? OnEntityAssigned { get; set; }
|
Action<IAssignableEntity>? OnEntityAssigned { get; set; }
|
||||||
|
|
||||||
@ -16,7 +16,7 @@ public interface IAssignableEntity : IAssignable
|
|||||||
IEntity Entity { get; }
|
IEntity Entity { get; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Assign a value to the <see cref="IEntity"/> field of this object
|
/// Assign a value to the <see cref="IEntity"/> field of this object.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="entity">New <see cref="IEntity"/> to assign.</param>
|
/// <param name="entity">New <see cref="IEntity"/> to assign.</param>
|
||||||
/// <returns>
|
/// <returns>
|
||||||
|
@ -8,7 +8,7 @@ namespace Syntriax.Engine.Core.Abstract;
|
|||||||
public interface IAssignableGameManager : IAssignable
|
public interface IAssignableGameManager : IAssignable
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Callback triggered when the <see cref="IGameManager"/> value has has been assigned a new value.
|
/// Event triggered when the <see cref="IGameManager"/> value has has been assigned a new value.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
Action<IAssignableGameManager>? OnGameManagerAssigned { get; set; }
|
Action<IAssignableGameManager>? OnGameManagerAssigned { get; set; }
|
||||||
|
|
||||||
@ -16,7 +16,7 @@ public interface IAssignableGameManager : IAssignable
|
|||||||
IGameManager GameManager { get; }
|
IGameManager GameManager { get; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Assign a value to the <see cref="IGameManager"/> field of this object
|
/// Assign a value to the <see cref="IGameManager"/> field of this object.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="gameManager">New <see cref="IGameManager"/> to assign.</param>
|
/// <param name="gameManager">New <see cref="IGameManager"/> to assign.</param>
|
||||||
/// <returns>
|
/// <returns>
|
||||||
|
@ -8,7 +8,7 @@ namespace Syntriax.Engine.Core.Abstract;
|
|||||||
public interface IAssignableGameObject : IAssignable
|
public interface IAssignableGameObject : IAssignable
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Callback triggered when the <see cref="IGameObject"/> value has has been assigned a new value.
|
/// Event triggered when the <see cref="IGameObject"/> value has has been assigned a new value.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
Action<IAssignableGameObject>? OnGameObjectAssigned { get; set; }
|
Action<IAssignableGameObject>? OnGameObjectAssigned { get; set; }
|
||||||
|
|
||||||
@ -16,7 +16,7 @@ public interface IAssignableGameObject : IAssignable
|
|||||||
IGameObject GameObject { get; }
|
IGameObject GameObject { get; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Assign a value to the <see cref="IGameObject"/> field of this object
|
/// Assign a value to the <see cref="IGameObject"/> field of this object.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="gameObject">New <see cref="IGameObject"/> to assign.</param>
|
/// <param name="gameObject">New <see cref="IGameObject"/> to assign.</param>
|
||||||
/// <returns>
|
/// <returns>
|
||||||
|
@ -8,7 +8,7 @@ namespace Syntriax.Engine.Core.Abstract;
|
|||||||
public interface IAssignableStateEnable : IAssignable
|
public interface IAssignableStateEnable : IAssignable
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Callback triggered when the <see cref="IStateEnable"/> value has has been assigned a new value.
|
/// Event triggered when the <see cref="IStateEnable"/> value has has been assigned a new value.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
Action<IAssignableStateEnable>? OnStateEnableAssigned { get; set; }
|
Action<IAssignableStateEnable>? OnStateEnableAssigned { get; set; }
|
||||||
|
|
||||||
@ -16,7 +16,7 @@ public interface IAssignableStateEnable : IAssignable
|
|||||||
IStateEnable StateEnable { get; }
|
IStateEnable StateEnable { get; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Assign a value to the <see cref="IStateEnable"/> field of this object
|
/// Assign a value to the <see cref="IStateEnable"/> field of this object.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="stateEnable">New <see cref="IStateEnable"/> to assign.</param>
|
/// <param name="stateEnable">New <see cref="IStateEnable"/> to assign.</param>
|
||||||
/// <returns>
|
/// <returns>
|
||||||
|
@ -8,7 +8,7 @@ namespace Syntriax.Engine.Core.Abstract;
|
|||||||
public interface IAssignableTransform : IAssignable
|
public interface IAssignableTransform : IAssignable
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Callback triggered when the <see cref="ITransform"/> value has has been assigned a new value.
|
/// Event triggered when the <see cref="ITransform"/> value has has been assigned a new value.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
Action<IAssignableTransform>? OnTransformAssigned { get; set; }
|
Action<IAssignableTransform>? OnTransformAssigned { get; set; }
|
||||||
|
|
||||||
@ -16,7 +16,7 @@ public interface IAssignableTransform : IAssignable
|
|||||||
ITransform Transform { get; }
|
ITransform Transform { get; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Assign a value to the <see cref="ITransform"/> field of this object
|
/// Assign a value to the <see cref="ITransform"/> field of this object.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="transform">New <see cref="ITransform"/> to assign.</param>
|
/// <param name="transform">New <see cref="ITransform"/> to assign.</param>
|
||||||
/// <returns>
|
/// <returns>
|
||||||
|
Loading…
x
Reference in New Issue
Block a user