Class StringParameterTemplate

Namespace

Uncreated.Warfare.Quests.Parameters

Assembly

Uncreated.Warfare.dll

Quest paramater template representing a set of possible values for randomly generated quests, or a set of allowed values for conditions.

[TypeConverter(typeof(StringParameterTemplateTypeConverter))]
public class StringParameterTemplate : QuestParameterTemplate<string>, IFormattable, IEquatable<QuestParameterTemplate<string>>

Inheritance

object

QuestParameterTemplate<string>

StringParameterTemplate

Implements

IFormattable

IEquatable<QuestParameterTemplate<string>>

Derived

KitNameParameterTemplate

Inherited Members

QuestParameterTemplate<string>.Set

QuestParameterTemplate<string>.ValueType

QuestParameterTemplate<string>.SelectionType

QuestParameterTemplate<string>.WriteJson(Utf8JsonWriter)

QuestParameterTemplate<string>.Equals(QuestParameterTemplate<string>)

QuestParameterTemplate<string>.Equals(object)

QuestParameterTemplate<string>.GetHashCode()

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Remarks

For kit names, use KitNameParameterTemplate.

Constructors

StringParameterTemplate()

protected StringParameterTemplate()

StringParameterTemplate(ReadOnlySpan<char>)

Create a template of it's string representation.

public StringParameterTemplate(ReadOnlySpan<char> str)

Parameters

str ReadOnlySpan<char>

StringParameterTemplate(string)

Create a template of a constant value.

public StringParameterTemplate(string constant)

Parameters

constant string

Remarks

Use AsSpan(string) to parse instead of passing as a constant.

StringParameterTemplate(string[], ParameterSelectionType)

Create a template of a set of values.

public StringParameterTemplate(string[] values, ParameterSelectionType selectionType)

Parameters

values string[]

selectionType ParameterSelectionType

StringParameterTemplate(ParameterSelectionType)

Create a template of a wildcard set of values.

public StringParameterTemplate(ParameterSelectionType wildcardType)

Parameters

wildcardType ParameterSelectionType

Remarks

Only Inclusive wildcards are supported.

Exceptions

ArgumentException

Selective wildcard was used.

Properties

WildcardInclusive

A parameter value that matches any integer.

public static QuestParameterValue<string> WildcardInclusive { get; }

Property Value

QuestParameterValue<string>

Methods

CreateValue(IServiceProvider)

Creates a random value from this selective set, or a set of values if this is an inclusive set.

public override UniTask<QuestParameterValue<string>> CreateValue(IServiceProvider serviceProvider)

Parameters

serviceProvider IServiceProvider

Returns

UniTask<QuestParameterValue<string>>

ReadJson(ref Utf8JsonReader)

Read from a JSON reader.

public static StringParameterTemplate? ReadJson(ref Utf8JsonReader reader)

Parameters

reader Utf8JsonReader

Returns

StringParameterTemplate

ReadValueJson(ref Utf8JsonReader)

Read a value from a JSON reader.

public static QuestParameterValue<string>? ReadValueJson(ref Utf8JsonReader reader)

Parameters

reader Utf8JsonReader

Returns

QuestParameterValue<string>

ToString()

Convert a parameter template back to a string.

public override string ToString()

Returns

string

TryParse(ReadOnlySpan<char>, out StringParameterTemplate)

Read a StringParameterTemplate from a string.

public static bool TryParse(ReadOnlySpan<char> str, out StringParameterTemplate template)

Parameters

str ReadOnlySpan<char>

template StringParameterTemplate

Returns

bool

TryParseFrom(ReadOnlySpan<char>)

Read a parameter template from a string.

public override bool TryParseFrom(ReadOnlySpan<char> str)

Parameters

str ReadOnlySpan<char>

Returns

bool

TryParseIntl(ReadOnlySpan<char>, out ParameterSelectionType, out ParameterValueType, out string?, out string[]?, bool)

protected static bool TryParseIntl(ReadOnlySpan<char> str, out ParameterSelectionType selType, out ParameterValueType valType, out string? constant, out string[]? list, bool isBasicStringParameter)

Parameters

str ReadOnlySpan<char>

selType ParameterSelectionType

valType ParameterValueType

constant string

list string[]

isBasicStringParameter bool

Returns

bool

TryParseValue(ReadOnlySpan<char>, out QuestParameterValue<string>)

Read a saved value of this StringParameterTemplate from a string.

public static bool TryParseValue(ReadOnlySpan<char> str, out QuestParameterValue<string> value)

Parameters

str ReadOnlySpan<char>

value QuestParameterValue<string>

Returns

bool