Class TextProvider

Implementation of a text provider. Inherit from this class and override as needed.

Inheritance

Object

TextProvider

DefaultTextProvider

Implements

ITextProvider

Namespace: DaggerfallWorkshop.Utility

Assembly: Assembly-CSharp.dll

Syntax

public abstract class TextProvider : ITextProvider

Constructors

| Improve this Doc View Source

TextProvider()

Declaration

public TextProvider()

Fields

| Improve this Doc View Source

localizedStringDebug

Declaration

public bool localizedStringDebug

Field Value

Type	Description
Boolean

Methods

| Improve this Doc View Source

CreateTokens(TextFile.Formatting, String[])

Declaration

public virtual TextFile.Token[] CreateTokens(TextFile.Formatting formatting, params string[] lines)

Parameters

Type	Name	Description
TextFile.Formatting	formatting
String[]	lines

Returns

Type	Description
TextFile.Token[]

| Improve this Doc View Source

EnableLocalizedStringDebug(Boolean)

Enable or disable verbose localized string debug in player log.

Declaration

public void EnableLocalizedStringDebug(bool enable)

Parameters

Type	Name	Description
Boolean	enable	True to enable, false to disable.

| Improve this Doc View Source

GetAbbreviatedStatName(DFCareer.Stats)

Declaration

public string GetAbbreviatedStatName(DFCareer.Stats stat)

Parameters

Type	Name	Description
DFCareer.Stats	stat

Returns

Type	Description
String

| Improve this Doc View Source

GetArmorMaterialName(ArmorMaterialTypes)

Declaration

public string GetArmorMaterialName(ArmorMaterialTypes material)

Parameters

Type	Name	Description
ArmorMaterialTypes	material

Returns

Type	Description
String

| Improve this Doc View Source

GetCustomEnemyName(Int32)

Declaration

public string GetCustomEnemyName(int enemyId)

Parameters

Type	Name	Description
Int32	enemyId

Returns

Type	Description
String

| Improve this Doc View Source

GetLocalizedString(String, String, out String)

Attempts to read a localized string from a named table collection.

Declaration

public virtual bool GetLocalizedString(string collection, string id, out string result)

Parameters

Type	Name	Description
String	collection	Name of table collection.
String	id	ID of string to get.
String	result	Localized string result or null/empty.

Returns

Type	Description
Boolean	True if string found, otherwise false.

| Improve this Doc View Source

GetRandomText(Int32)

Declaration

public virtual string GetRandomText(int id)

Parameters

Type	Name	Description
Int32	id

Returns

Type	Description
String

| Improve this Doc View Source

GetRandomTokens(Int32, Boolean)

Declaration

public virtual TextFile.Token[] GetRandomTokens(int id, bool dfRand = false)

Parameters

Type	Name	Description
Int32	id
Boolean	dfRand

Returns

Type	Description
TextFile.Token[]

| Improve this Doc View Source

GetRSCTokens(Int32)

Declaration

public virtual TextFile.Token[] GetRSCTokens(int id)

Parameters

Type	Name	Description
Int32	id

Returns

Type	Description
TextFile.Token[]

| Improve this Doc View Source

GetRSCTokens(String)

Declaration

public virtual TextFile.Token[] GetRSCTokens(string id)

Parameters

Type	Name	Description
String	id

Returns

Type	Description
TextFile.Token[]

| Improve this Doc View Source

GetSkillName(DFCareer.Skills)

Declaration

public string GetSkillName(DFCareer.Skills skill)

Parameters

Type	Name	Description
DFCareer.Skills	skill

Returns

Type	Description
String

| Improve this Doc View Source

GetSkillSummary(DFCareer.Skills, Int32)

Declaration

public TextFile.Token[] GetSkillSummary(DFCareer.Skills skill, int startPosition)

Parameters

Type	Name	Description
DFCareer.Skills	skill
Int32	startPosition

Returns

Type	Description
TextFile.Token[]

| Improve this Doc View Source

GetStatDescriptionTextID(DFCareer.Stats)

Declaration

public int GetStatDescriptionTextID(DFCareer.Stats stat)

Parameters

Type	Name	Description
DFCareer.Stats	stat

Returns

Type	Description
Int32

| Improve this Doc View Source

GetStatName(DFCareer.Stats)

Declaration

public string GetStatName(DFCareer.Stats stat)

Parameters

Type	Name	Description
DFCareer.Stats	stat

Returns

Type	Description
String

| Improve this Doc View Source

GetText(Int32)

Gets string from token array.

Declaration

public virtual string GetText(int id)

Parameters

Type	Name	Description
Int32	id	Text resource ID.

Returns

Type	Description
String	String from single text resource.

| Improve this Doc View Source

GetWeaponMaterialName(WeaponMaterialTypes)

Declaration

public string GetWeaponMaterialName(WeaponMaterialTypes material)

Parameters

Type	Name	Description
WeaponMaterialTypes	material

Returns

Type	Description
String

| Improve this Doc View Source

OpenTextRSCFile()

Declaration

protected void OpenTextRSCFile()

Implements

ITextProvider