Class CommandSpec

Namespace

BSGameLib.Chat

Assembly

BSGameLib.Chat.dll

A command as a client completes it: what is typed for it, what it takes, and for a group, the commands under it. Plain data, unlike CommandDescription, so a server can send its players the commands each of them may use.

public sealed record CommandSpec : IEquatable<CommandSpec>

Inheritance

object

CommandSpec

Implements

IEquatable<CommandSpec>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

CommandSpec(IReadOnlyList<string>, IReadOnlyList<ParameterSpec>, IReadOnlyList<CommandSpec>)

A command as a client completes it: what is typed for it, what it takes, and for a group, the commands under it. Plain data, unlike CommandDescription, so a server can send its players the commands each of them may use.

public CommandSpec(IReadOnlyList<string> Keywords, IReadOnlyList<ParameterSpec> Parameters, IReadOnlyList<CommandSpec> Commands)

Parameters

Keywords IReadOnlyList<string>

What is typed for it: the first is the one offered, the rest are also understood.

Parameters IReadOnlyList<ParameterSpec>

What it takes, in order.

Commands IReadOnlyList<CommandSpec>

For a group, the commands under it; its default, typed as nothing, left out.

Properties

Commands

For a group, the commands under it; its default, typed as nothing, left out.

public IReadOnlyList<CommandSpec> Commands { get; init; }

Property Value

IReadOnlyList<CommandSpec>

Keywords

What is typed for it: the first is the one offered, the rest are also understood.

public IReadOnlyList<string> Keywords { get; init; }

Property Value

IReadOnlyList<string>

Parameters

What it takes, in order.

public IReadOnlyList<ParameterSpec> Parameters { get; init; }

Property Value

IReadOnlyList<ParameterSpec>

Methods

From(CommandDescription)

A described command as a client completes it.

public static CommandSpec From(CommandDescription command)

Parameters

command CommandDescription

Returns

CommandSpec