Class ModuleBuilder

Namespace

Kook.Commands.Builders

Assembly

Kook.Net.Commands.dll

表示一个模块构建器。

public class ModuleBuilder

Inheritance

object

ModuleBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Aliases

获取此模块的别名。

public IReadOnlyList<string?> Aliases { get; }

Property Value

IReadOnlyList<string>

Attributes

获取此模块的特性。

public IReadOnlyList<Attribute> Attributes { get; }

Property Value

IReadOnlyList<Attribute>

Commands

获取此模块的别名。

public IReadOnlyList<CommandBuilder> Commands { get; }

Property Value

IReadOnlyList<CommandBuilder>

Group

获取或设置此模块的分组。

public string? Group { get; set; }

Property Value

string

Modules

获取此模块的子模块。

public IReadOnlyList<ModuleBuilder> Modules { get; }

Property Value

IReadOnlyList<ModuleBuilder>

Name

获取或设置此模块的基本名称。

public string? Name { get; set; }

Property Value

string

Parent

获取此模块构建器所属的父模块构建器。

public ModuleBuilder? Parent { get; }

Property Value

ModuleBuilder

Preconditions

获取此模块的先决条件。

public IReadOnlyList<PreconditionAttribute> Preconditions { get; }

Property Value

IReadOnlyList<PreconditionAttribute>

Remarks

获取或设置此模块的备注。

public string? Remarks { get; set; }

Property Value

string

Service

获取此模块构建器所属的命令服务。

public CommandService Service { get; }

Property Value

CommandService

Summary

获取或设置此模块的摘要。

public string? Summary { get; set; }

Property Value

string

Methods

AddAliases(params string?[])

添加别名到此模块。

public ModuleBuilder AddAliases(params string?[] aliases)

Parameters

aliases string[]

要添加到此模块的别名数组。

Returns

ModuleBuilder

此模块构建器。

AddAttributes(params Attribute[])

添加特性到此模块。

public ModuleBuilder AddAttributes(params Attribute[] attributes)

Parameters

attributes Attribute[]

要添加到此模块的特性数组。

Returns

ModuleBuilder

此模块构建器。

AddCommand(string, Func<ICommandContext, object?[], IServiceProvider, CommandInfo, Task>, Action<CommandBuilder>)

添加命令到此模块。

public ModuleBuilder AddCommand(string primaryAlias, Func<ICommandContext, object?[], IServiceProvider, CommandInfo, Task> callback, Action<CommandBuilder> createFunc)

Parameters

primaryAlias string

此命令的首要别名。

callback Func<ICommandContext, object[], IServiceProvider, CommandInfo, Task>

当执行此命令时调用的回调。

createFunc Action<CommandBuilder>

一个创建命令构建器的委托。

Returns

ModuleBuilder

此模块构建器。

AddModule(string, Action<ModuleBuilder>)

添加子模块到此模块。

public ModuleBuilder AddModule(string primaryAlias, Action<ModuleBuilder> createFunc)

Parameters

primaryAlias string

此模块的首要别名。

createFunc Action<ModuleBuilder>

一个创建模块构建器的委托。

Returns

ModuleBuilder

此模块构建器。

AddPrecondition(PreconditionAttribute)

添加先决条件到此模块。

public ModuleBuilder AddPrecondition(PreconditionAttribute precondition)

Parameters

precondition PreconditionAttribute

要添加到此模块的先决条件。

Returns

ModuleBuilder

此模块构建器。

Build(CommandService, IServiceProvider)

构建此模块构建器为模块。

public ModuleInfo Build(CommandService service, IServiceProvider services)

Parameters

service CommandService

此模块构建器所属的命令服务。

services IServiceProvider

此模块构建器所属的服务提供程序。

Returns

ModuleInfo

构建的模块。

WithName(string)

设置此模块的名基本称。

public ModuleBuilder WithName(string name)

Parameters

name string

此模块的基本名称。

Returns

ModuleBuilder

此模块构建器。

WithRemarks(string)

设置此模块的备注。

public ModuleBuilder WithRemarks(string remarks)

Parameters

remarks string

此模块的备注。

Returns

ModuleBuilder

此模块构建器。

WithSummary(string)

设置此模块的摘要。

public ModuleBuilder WithSummary(string summary)

Parameters

summary string

此模块的摘要。

Returns

ModuleBuilder

此模块构建器。