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
NamestringWhat it is called, as help shows it.
IsRequiredboolWhether it has to be typed.
CapturesRemainderboolWhether it takes the rest of the line, spaces and all.
SuggestionsstringWhat 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
IsRequired
Whether it has to be typed.
public bool IsRequired { get; init; }
Property Value
Name
What it is called, as help shows it.
public string Name { get; init; }
Property Value
Suggestions
What the game suggests for it as it is typed, by name; null for nothing.
public string Suggestions { get; init; }