Class PlainTextSyntaxWriter

Namespace

Uncreated.Warfare.Interaction.Commands.Syntax

Assembly

Uncreated.Warfare.dll

public class PlainTextSyntaxWriter : ISyntaxWriter

Inheritance

object

PlainTextSyntaxWriter

Implements

ISyntaxWriter

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PlainTextSyntaxWriter(CultureInfo, bool)

public PlainTextSyntaxWriter(CultureInfo culture, bool forInGame = false)

Parameters

culture CultureInfo

forInGame bool

Methods

BeginWrite(StringBuilder, SyntaxStringType)

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

public 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.

public 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.

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

Parameters

bldr 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.

public void WriteCloseParameterTemplate(StringBuilder bldr, bool optional)

Parameters

bldr StringBuilder

optional bool

WriteCommandName(StringBuilder, string, bool)

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

public void WriteCommandName(StringBuilder bldr, string commandName, bool isAlias)

Parameters

bldr StringBuilder

commandName string

isAlias bool

WriteFlag(StringBuilder, ICommandFlagDescriptor)

Write a flag to the StringBuilder.

public void WriteFlag(StringBuilder bldr, ICommandFlagDescriptor flag)

Parameters

bldr 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.

public void WriteOpenParameterTemplate(StringBuilder bldr, bool optional)

Parameters

bldr 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.

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

Parameters

bldr 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.

public void WriteParameterSeparator(StringBuilder bldr)

Parameters

bldr StringBuilder

WriteParameterTemplateChainSeparator(StringBuilder)

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

public void WriteParameterTemplateChainSeparator(StringBuilder bldr)

Parameters

bldr 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 '... '.

public void WriteParameterTemplateRemainder(StringBuilder bldr)

Parameters

bldr StringBuilder

WriteParameterTemplateSeparator(StringBuilder)

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

public void WriteParameterTemplateSeparator(StringBuilder bldr)

Parameters

bldr StringBuilder

WritePrefixCharacter(StringBuilder, string)

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

public void WritePrefixCharacter(StringBuilder bldr, string prefixCharacter)

Parameters

bldr StringBuilder

prefixCharacter string