Class CompletionResult

Namespace

BSGameLib.Chat

Assembly

BSGameLib.Chat.dll

What can be typed at the end of a chat line, from CommandCompleter.

public sealed record CompletionResult : IEquatable<CompletionResult>

Inheritance

object

CompletionResult

Implements

IEquatable<CompletionResult>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

CompletionResult(int, IReadOnlyList<string>, string, string, IReadOnlyList<string>)

What can be typed at the end of a chat line, from CommandCompleter.

public CompletionResult(int Start, IReadOnlyList<string> Options, string Hint, string Suggestions, IReadOnlyList<string> Arguments)

Parameters

Start int

Where the word being typed starts in the line: what a chosen option replaces from.

Options IReadOnlyList<string>

What the word could be, those starting as it does first; empty for none.

Hint string

The parts still to type, "<map> [x] [y]", for showing after the line; empty for none.

Suggestions string

The name of the values being completed, when the word is a parameter's that suggests values; null otherwise.

Arguments IReadOnlyList<string>

The parameters typed before it, for values that depend on them -- a plugin's tables on the plugin.

Properties

Arguments

The parameters typed before it, for values that depend on them -- a plugin's tables on the plugin.

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

Property Value

IReadOnlyList<string>

Hint

The parts still to type, "<map> [x] [y]", for showing after the line; empty for none.

public string Hint { get; init; }

Property Value

string

None

Nothing to complete: the line is not a command.

public static CompletionResult None { get; }

Property Value

CompletionResult

Options

What the word could be, those starting as it does first; empty for none.

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

Property Value

IReadOnlyList<string>

Start

Where the word being typed starts in the line: what a chosen option replaces from.

public int Start { get; init; }

Property Value

int

Suggestions

The name of the values being completed, when the word is a parameter's that suggests values; null otherwise.

public string Suggestions { get; init; }

Property Value

string