Class EffectText

Namespace

SurvivorsMaker.Presentation

Assembly

SurvivorsMaker.Presentation.dll

Formats content names, tiers, effect descriptions and stat labels for the game UI.

public static class EffectText

Inheritance

object

EffectText

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

Describe(Effect, StatCatalog, UiStrings)

public static string Describe(Effect effect, StatCatalog catalog, UiStrings strings = null)

Parameters

effect Effect

catalog StatCatalog

strings UiStrings

Returns

string

Describe(IReadOnlyList<Effect>, StatCatalog, UiStrings)

public static string Describe(IReadOnlyList<Effect> effects, StatCatalog catalog, UiStrings strings = null)

Parameters

effects IReadOnlyList<Effect>

catalog StatCatalog

strings UiStrings

Returns

string

Description(ContentTextKind, string, UiStrings)

The language's text for "<key>.description", else the authored description, else "".

public static string Description(ContentTextKind kind, string id, UiStrings strings = null)

Parameters

kind ContentTextKind

id string

strings UiStrings

Returns

string

KindOf(UnlockTarget)

The text kind of an unlock target.

public static ContentTextKind KindOf(UnlockTarget target)

Parameters

target UnlockTarget

Returns

ContentTextKind

Name(ContentTextKind, string, UiStrings)

Display name of a content definition: the language's text for "<key>.name" (see ContentTextTable), then the authored display name, then the id in title case.

public static string Name(ContentTextKind kind, string id, UiStrings strings = null)

Parameters

kind ContentTextKind

id string

strings UiStrings

Returns

string

Name(string, UiStrings)

public static string Name(string id, UiStrings strings = null)

Parameters

id string

strings UiStrings

Returns

string

Result(RunResult, UiStrings)

public static string Result(RunResult result, UiStrings strings = null)

Parameters

result RunResult

strings UiStrings

Returns

string

TieredName(ContentTextKind, string, int, UiStrings)

Like Name(ContentTextKind, string, UiStrings) with the tier label; without authored text, the id's tier suffix is removed.

public static string TieredName(ContentTextKind kind, string id, int tier, UiStrings strings = null)

Parameters

kind ContentTextKind

id string

tier int

strings UiStrings

Returns

string

TieredName(string, int, UiStrings)

public static string TieredName(string id, int tier, UiStrings strings = null)

Parameters

id string

tier int

strings UiStrings

Returns

string

UnlockCondition(UnlockDef, UiStrings)

"reach wave 5", "win one run as Ranger" ... (lower case, to follow a prefix such as "To unlock:").

public static string UnlockCondition(UnlockDef unlock, UiStrings strings = null)

Parameters

unlock UnlockDef

strings UiStrings

Returns

string

UnlockConditions(RunContent, UnlockTarget, string, UiStrings)

Conditions for one target, joined (several unlock rules for one target are alternatives).

public static string UnlockConditions(RunContent content, UnlockTarget target, string targetId, UiStrings strings = null)

Parameters

content RunContent

target UnlockTarget

targetId string

strings UiStrings

Returns

string

UnlockKind(UnlockTarget, UiStrings)

public static string UnlockKind(UnlockTarget target, UiStrings strings = null)

Parameters

target UnlockTarget

strings UiStrings

Returns

string

Weapon(WeaponItemDef, SimSettings, UiStrings)

public static string Weapon(WeaponItemDef item, SimSettings settings, UiStrings strings = null)

Parameters

item WeaponItemDef

settings SimSettings

strings UiStrings

Returns

string

WithDescription(string, string)

The description above the generated detail lines (effects, weapon summary). Both descriptions are optional.

public static string WithDescription(string description, string details)

Parameters

description string

details string

Returns

string