LazyAPI 基础库

作者: cc004, UnrealMultiple 成员
原始出处: Github
插件基础库

命令行参数

-culture zh|en 此命令行参数用于切换生成配置文件的语言，默认跟随ts语言。

自动注册指令详解

类声明

如此声明一个类，给类添加一个CommandAttribute，LazyAPI会在插件实例化阶段进行检测并进行下一步操作。

[Command("test")]
public class TestCommand
{

}

指令方法

声明的方法必须为静态且公开的，第一个参数类型必须是CommandArgs，否则不会加载或出错!

[Command("test")]
public class TestCommand
{
	public static void Run(CommandArgs args)
	{
		...方法内部实现...
	}
}

子命令

以下示例，在被加载后test命令会出现两个子命令/test run 和 /test go，默认情况下子命令以小写的方法名命名，第二条则是因为添加了AliasAttribute

[Command("test")]
public class TestCommand
{
	public static void Run(CommandArgs args)
	{
		...方法内部实现...
	}

	[Alias("go")]
	public static void Execute(CommandArgs args)
	{
		...方法内部实现...
	}
}

如果不希望其成为子命令则只需要添加一个MainAttribute，这样当你运行/test就不存在子命令可以直接运行

[Command("test")]
public class TestCommand
{
	[Main]
	public static void Execute(CommandArgs args)
	{
		...方法内部实现...
	}
}

其他Attribute

PermissionsAttribute为指令附加了权限，如此一来便不需要再使用HasPermission(...)来进行判断

RealPlayerAttribute则是为了防止机器人或其他非玩家的用户执行指令，LazyAPI会自动判断并阻止执行。

FlexibleAttribute的存在则是为了处理翻页Page的情况，后续将会提到。

[Command("test")]
[Permissions("test")]
public class TestCommand
{
	[Flexible]
	[RealPlayer]
	[Permissions("test.use")]
	public static void Execute(CommandArgs args)
	{
		...方法内部实现...
	}
}

LazyAPI的指令系统拥有参数匹配功能

以下示例中，方法多了一个string和int类型参数，LazyAPI在处理指令时，会从args.Parameters中找到这些参数并尝试转换。

并且在默认情况下，参数是严格匹配的，例如输入指令的参数和声明函数参数数量不同时不会执行，若参数转换失败同样如此。

可自动处理的参数类型:int，long，TSPlayer，bool，string，UserAccount，DateTime

[Command("test")]
[Permissions("test")]
public class TestCommand
{
	[Permissions("test.use")]
	public static void Execute(CommandArgs args, string name, int age)
	{
		...方法内部实现...
	}
}

FlexibleAttribute

为了处理那些特殊指令，例如:test list [页码]，因为参数匹配限制，所以添加了这个Attribute，你只需给方法添加它，那么LazyAPI就不会那么严格要求参数数量，只要大于方法参数数量即可。

[Command("test")]
[Permissions("test")]
public class TestCommand
{
	[Flexible]
	[Permissions("test.list")]
	public static void List(CommandArgs args)
	{
		var OnlineInfo = PlayerOnline.GetOnlineRank().Select(online => GetString($"{online.Name} 在线时长: {Math.Ceiling(Convert.ToDouble(online.Duration * 1.0f / 60))}分钟").Color(TShockAPI.Utils.GreenHighlight)).ToList();
        args.SendPage(OnlineInfo, 1, new PaginationTools.Settings
        {
            MaxLinesPerPage = 30,
            NothingToDisplayString = GetString("当前没有玩家在线数据"),
            HeaderFormat = GetString("在线排行 ({0}/{1})："),
            FooterFormat = GetString("输入 {0}在线排行 {{0}} 查看更多").SFormat(Commands.Specifier)
        });
	}
}