Artemis/src/Artemis.Core/Models/Profile/Conditions/ICondition.cs

using System;
using Artemis.Storage.Entities.Profile.Abstract;

namespace Artemis.Core;

/// <summary>
///     Represents a condition applied to a <see cref="ProfileElement" />
/// </summary>
public interface ICondition : IDisposable, IStorageModel, IPluginFeatureDependent
{
    /// <summary>
    ///     Gets the entity used to store this condition
    /// </summary>
    public IConditionEntity Entity { get; }

    /// <summary>
    ///     Gets the profile element this condition applies to
    /// </summary>
    public RenderProfileElement ProfileElement { get; }

    /// <summary>
    ///     Gets a boolean indicating whether the condition is currently met
    /// </summary>

    bool IsMet { get; }

    /// <summary>
    ///     Updates the condition
    /// </summary>
    void Update();

    /// <summary>
    ///     Updates the timeline according to the provided <paramref name="deltaTime" /> as the display condition sees fit.
    /// </summary>
    void UpdateTimeline(double deltaTime);

    /// <summary>
    ///     Overrides the timeline to the provided <paramref name="position" /> as the display condition sees fit.
    /// </summary>
    void OverrideTimeline(TimeSpan position);
}

/// <summary>
///     Represents a condition applied to a <see cref="ProfileElement" /> using a <see cref="INodeScript" />
/// </summary>
public interface INodeScriptCondition : ICondition
{
    /// <summary>
    ///     Gets the node script of this node script condition
    /// </summary>
    INodeScript? NodeScript { get; }

    /// <summary>
    ///     Loads the node script this node script condition uses
    /// </summary>
    void LoadNodeScript();
}