Table of Contents

Class ParameterSpec

Namespace
BSGameLib.Chat
Assembly
BSGameLib.Chat.dll

A command's parameter as a client completes it: plain data, sent from a server to its players.

public sealed record ParameterSpec : IEquatable<ParameterSpec>
Inheritance
ParameterSpec
Implements
Inherited Members

Constructors

ParameterSpec(string, bool, bool, string)

A command's parameter as a client completes it: plain data, sent from a server to its players.

public ParameterSpec(string Name, bool IsRequired, bool CapturesRemainder, string Suggestions)

Parameters

Name string

What it is called, as help shows it.

IsRequired bool

Whether it has to be typed.

CapturesRemainder bool

Whether it takes the rest of the line, spaces and all.

Suggestions string

What the game suggests for it as it is typed, by name; null for nothing.

Properties

CapturesRemainder

Whether it takes the rest of the line, spaces and all.

public bool CapturesRemainder { get; init; }

Property Value

bool

IsRequired

Whether it has to be typed.

public bool IsRequired { get; init; }

Property Value

bool

Name

What it is called, as help shows it.

public string Name { get; init; }

Property Value

string

Suggestions

What the game suggests for it as it is typed, by name; null for nothing.

public string Suggestions { get; init; }

Property Value

string