Class CommandBuilder

Namespace

Kook.Commands.Builders

Assembly

Kook.Net.Commands.dll

表示一个命令构建器。

public class CommandBuilder

Inheritance

object

CommandBuilder

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>

IgnoreExtraArgs

获取或设置此命令是否忽略额外的参数。

public bool IgnoreExtraArgs { get; set; }

Property Value

bool

Module

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

public ModuleBuilder Module { get; }

Property Value

ModuleBuilder

Name

获取或设置此命令的基本名称。

public string? Name { get; set; }

Property Value

string

Parameters

获取此命令的参数构建器。

public IReadOnlyList<ParameterBuilder> Parameters { get; }

Property Value

IReadOnlyList<ParameterBuilder>

Preconditions

获取此命令的先决条件。

public IReadOnlyList<PreconditionAttribute> Preconditions { get; }

Property Value

IReadOnlyList<PreconditionAttribute>

PrimaryAlias

获取或设置此命令的首要别名。

public string? PrimaryAlias { get; set; }

Property Value

string

Priority

获取或设置此命令的优先级。

public int Priority { get; set; }

Property Value

int

See Also

PriorityAttribute(int)

Remarks

获取或设置此命令的备注。

public string? Remarks { get; set; }

Property Value

string

RunMode

获取或设置此命令的运行模式。

public RunMode RunMode { get; set; }

Property Value

RunMode

Summary

获取或设置此命令的摘要。

public string? Summary { get; set; }

Property Value

string

Methods

AddAliases(params string?[])

向此命令添加别名。

public CommandBuilder AddAliases(params string?[] aliases)

Parameters

aliases string[]

包含要添加的别名的数组。

Returns

CommandBuilder

当前命令构建器。

AddAttributes(params Attribute[])

添加特性到此命令。

public CommandBuilder AddAttributes(params Attribute[] attributes)

Parameters

attributes Attribute[]

要添加的特性。

Returns

CommandBuilder

当前命令构建器。

AddParameter(string, Type, Action<ParameterBuilder>)

添加参数到此命令。

public CommandBuilder AddParameter(string name, Type type, Action<ParameterBuilder> createFunc)

Parameters

name string

参数的名称。

type Type

参数的类型。

createFunc Action<ParameterBuilder>

一个创建参数构建器的委托。

Returns

CommandBuilder

当前命令构建器。

AddParameter<T>(string, Action<ParameterBuilder>)

添加参数到此命令。

public CommandBuilder AddParameter<T>(string name, Action<ParameterBuilder> createFunc)

Parameters

name string

参数的名称。

createFunc Action<ParameterBuilder>

一个创建参数构建器的委托。

Returns

CommandBuilder

当前命令构建器。

Type Parameters

T

参数的类型。

AddPrecondition(PreconditionAttribute)

添加先决条件到此命令。

public CommandBuilder AddPrecondition(PreconditionAttribute precondition)

Parameters

precondition PreconditionAttribute

要添加的先决条件。

Returns

CommandBuilder

当前命令构建器。

WithName(string)

设置此命令的基本名称。

public CommandBuilder WithName(string name)

Parameters

name string

此命令的基本名称。

Returns

CommandBuilder

当前命令构建器。

WithPriority(int)

设置此命令的优先级。

public CommandBuilder WithPriority(int priority)

Parameters

priority int

此命令的优先级。

Returns

CommandBuilder

当前命令构建器。

See Also

PriorityAttribute(int)

WithRemarks(string)

设置此命令的备注。

public CommandBuilder WithRemarks(string remarks)

Parameters

remarks string

此命令的备注。

Returns

CommandBuilder

当前命令构建器。

WithRunMode(RunMode)

设置此命令的运行模式。

public CommandBuilder WithRunMode(RunMode runMode)

Parameters

runMode RunMode

此命令的运行模式。

Returns

CommandBuilder

当前命令构建器。

WithSummary(string)

设置此命令的摘要。

public CommandBuilder WithSummary(string summary)

Parameters

summary string

此命令的摘要。

Returns

CommandBuilder

当前命令构建器。