PkmnLib.NET/PkmnLib.Dynamic/ScriptHandling/ItemScript.cs

using PkmnLib.Dynamic.Events;
using PkmnLib.Dynamic.Models;
using PkmnLib.Static;
using PkmnLib.Static.Utils;

namespace PkmnLib.Dynamic.ScriptHandling;

/// <summary>
/// Base class for item scripts.
/// </summary>
public abstract class ItemScript : IDeepCloneable
{
    /// <inheritdoc cref="ItemScript"/>
    protected ItemScript(IItem item)
    {
        Item = item;
    }

    /// <summary>
    /// The item associated with this script.
    /// </summary>
    protected IItem Item { get; private set; }

    /// <summary>
    /// Initializes the script with the given parameters for a specific item
    /// </summary>
    public virtual void OnInitialize(IReadOnlyDictionary<StringKey, object?>? parameters)
    {
    }

    /// <summary>
    /// Returns whether the item is usable in the current context.
    /// </summary>
    public virtual bool IsItemUsable => false;

    /// <summary>
    /// Returns whether the item requires a target to be used.
    /// </summary>
    public virtual bool RequiresTarget => false;

    /// <summary>
    /// Returns whether the item is usable on the given target.
    /// </summary>
    public virtual bool IsTargetValid(IPokemon target) => false;

    /// <summary>
    /// Returns whether the item can be held by a Pokémon.
    /// </summary>
    public virtual bool IsHoldable => false;

    /// <summary>
    /// Returns whether the item can be held by the given target.
    /// </summary>
    public virtual bool CanTargetHold(IPokemon pokemon) => false;

    /// <summary>
    /// Handles the use of the item.
    /// </summary>
    public virtual void OnUse(EventHook eventHook)
    {
    }

    /// <summary>
    /// Handles the use of the item on the given target.
    /// </summary>
    public virtual void OnUseWithTarget(IPokemon target, EventHook eventHook)
    {
    }
}