IW4M-Admin/SharedLibraryCore/Interfaces/IScriptCommandFactory.cs

31 lines
1.3 KiB
C#
Raw Normal View History

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
2023-04-04 19:24:13 -04:00
using Data.Models;
using SharedLibraryCore.Commands;
namespace SharedLibraryCore.Interfaces
{
/// <summary>
2022-01-26 11:32:16 -05:00
/// defines capabilities of script command factory
/// </summary>
public interface IScriptCommandFactory
{
/// <summary>
2022-01-26 11:32:16 -05:00
/// generate a new script command from parsed source
/// </summary>
/// <param name="name">name of command</param>
/// <param name="alias">alias of command</param>
/// <param name="description">description of command</param>
/// <param name="permission">minimum required permission</param>
/// <param name="isTargetRequired">target required or not</param>
/// <param name="args">command arguments (name, is required)</param>
2023-04-04 19:24:13 -04:00
/// <param name="executeAction">action to perform when command is executed</param>
/// <param name="supportedGames"></param>
/// <returns></returns>
2022-01-26 11:32:16 -05:00
IManagerCommand CreateScriptCommand(string name, string alias, string description, string permission,
2023-04-04 19:24:13 -04:00
bool isTargetRequired, IEnumerable<CommandArgument> args, Func<GameEvent, Task> executeAction,
IEnumerable<Reference.Game> supportedGames);
}
}