Interface ISyntaxWriter

Namespace

Uncreated.Warfare.Interaction.Commands.Syntax

Assembly

Uncreated.Warfare.dll

Non-thread-safe command syntax formatter/writer.

public interface ISyntaxWriter

Methods

BeginWrite(StringBuilder, SyntaxStringType)

Runs any set-up needed before creating a syntax string.

void BeginWrite(StringBuilder bldr, SyntaxStringType type)

Parameters

bldr StringBuilder

type SyntaxStringType

EndWrite(StringBuilder, SyntaxStringType)

Runs any clean-up needed after creating a syntax string and returns the final string.

string EndWrite(StringBuilder bldr, SyntaxStringType type)

Parameters

bldr StringBuilder

type SyntaxStringType

Returns

string

WriteBasicTag(StringBuilder, TagType, ReadOnlySpan<char>)

Write text for a tag to the StringBuilder.

void WriteBasicTag(StringBuilder stringBuilder, CommandSyntaxFormatter.TagType type, ReadOnlySpan<char> tagName)

Parameters

stringBuilder StringBuilder

type CommandSyntaxFormatter.TagType

tagName ReadOnlySpan<char>

WriteCloseParameterTemplate(StringBuilder, bool)

Write the characters that close a set of parameter options to the StringBuilder. This is usually '>' for required parameters and ']' for optional parameters.

void WriteCloseParameterTemplate(StringBuilder stringBuilder, bool optional)

Parameters

stringBuilder StringBuilder

optional bool

WriteCommandName(StringBuilder, string, bool)

Write the command name (help, home, etc) to the StringBuilder.

void WriteCommandName(StringBuilder stringBuilder, string commandName, bool isAlias)

Parameters

stringBuilder StringBuilder

commandName string

isAlias bool

WriteFlag(StringBuilder, ICommandFlagDescriptor)

Write a flag to the StringBuilder.

void WriteFlag(StringBuilder stringBuilder, ICommandFlagDescriptor flag)

Parameters

stringBuilder StringBuilder

flag ICommandFlagDescriptor

WriteOpenParameterTemplate(StringBuilder, bool)

Write the characters that open a set of parameter options to the StringBuilder. This is usually '<' for required parameters and '[' for optional parameters.

void WriteOpenParameterTemplate(StringBuilder stringBuilder, bool optional)

Parameters

stringBuilder StringBuilder

optional bool

WriteParameter(StringBuilder, ICommandParameterDescriptor, string?, bool, bool)

Write a parameter (with an optional overrideParameterName which should be used as the name instead of the actual name) to the StringBuilder.

void WriteParameter(StringBuilder stringBuilder, ICommandParameterDescriptor parameter, string? overrideParameterName, bool isRequiredLookAtTarget, bool isOptionalLookAtTarget)

Parameters

stringBuilder StringBuilder

parameter ICommandParameterDescriptor

overrideParameterName string

isRequiredLookAtTarget bool

isOptionalLookAtTarget bool

WriteParameterSeparator(StringBuilder)

Write the characters that separate parameter template sets to the StringBuilder. This is usually just a space.

void WriteParameterSeparator(StringBuilder stringBuilder)

Parameters

stringBuilder StringBuilder

WriteParameterTemplateChainSeparator(StringBuilder)

Write the characters that separate chained parameters to the StringBuilder. This is usually just a space.

void WriteParameterTemplateChainSeparator(StringBuilder stringBuilder)

Parameters

stringBuilder StringBuilder

WriteParameterTemplateRemainder(StringBuilder)

Write the characters that indicate a parameter which doesn't care about the spaces after it to the StringBuilder. This is usually '... '.

void WriteParameterTemplateRemainder(StringBuilder stringBuilder)

Parameters

stringBuilder StringBuilder

WriteParameterTemplateSeparator(StringBuilder)

Write the characters that separate two parameter names in a parameter template set to the StringBuilder. This is usually ' | '

void WriteParameterTemplateSeparator(StringBuilder stringBuilder)

Parameters

stringBuilder StringBuilder

WritePrefixCharacter(StringBuilder, string)

Write the slash character (or whatever) to the StringBuilder.

void WritePrefixCharacter(StringBuilder stringBuilder, string prefixCharacter)

Parameters

stringBuilder StringBuilder

prefixCharacter string