Class TextLabel

A simple single-line text label using a pixel font.

Inheritance
Object
BaseScreenComponent
TextLabel
Inherited Members
Namespace: DaggerfallWorkshop.Game.UserInterface
Assembly: Assembly-CSharp.dll
Syntax
public class TextLabel : BaseScreenComponent, IDisposable

Constructors

| Improve this Doc View Source

TextLabel(DaggerfallFont)

Declaration
public TextLabel(DaggerfallFont font = null)
Parameters
Type Name Description
DaggerfallFont font

Fields

| Improve this Doc View Source

limitMinTextureDim

Declaration
public const int limitMinTextureDim = 8
Field Value
Type Description
Int32

Properties

| Improve this Doc View Source

Font

Declaration
public DaggerfallFont Font { get; set; }
Property Value
Type Description
DaggerfallFont
| Improve this Doc View Source

HorizontalTextAlignment

Declaration
public TextLabel.HorizontalTextAlignmentSetting HorizontalTextAlignment { get; set; }
Property Value
Type Description
TextLabel.HorizontalTextAlignmentSetting
| Improve this Doc View Source

HorzPixelScrollOffset

Declaration
public float HorzPixelScrollOffset { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

MaxCharacters

Maximum length of label string. Setting to -1 allows for any length.

Declaration
public int MaxCharacters { get; set; }
Property Value
Type Description
Int32
| Improve this Doc View Source

MaxWidth

Set the maximum allowed width of the textlabel in pixels

Declaration
public int MaxWidth { get; set; }
Property Value
Type Description
Int32
| Improve this Doc View Source

MinTextureDim

used to set min texture dims of textlabel to higher values if there would be aspect or scaling issues with small texts otherwise (e.g. some single-lined textlabels in inventory infopanel)

Declaration
public int MinTextureDim { get; set; }
Property Value
Type Description
Int32
| Improve this Doc View Source

NumTextLines

Declaration
public int NumTextLines { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

ShadowColor

Declaration
public Color ShadowColor { get; set; }
Property Value
Type Description
Color
| Improve this Doc View Source

ShadowPosition

Declaration
public Vector2 ShadowPosition { get; set; }
Property Value
Type Description
Vector2
| Improve this Doc View Source

StartCharacterIndex

specify character index inside textlabel's text as new starting index

Declaration
public int StartCharacterIndex { get; set; }
Property Value
Type Description
Int32
| Improve this Doc View Source

Text

Declaration
public string Text { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

TextColor

Declaration
public Color TextColor { get; set; }
Property Value
Type Description
Color
| Improve this Doc View Source

TextHeight

Declaration
public int TextHeight { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

TextScale

Set text scale factor - 1.0f is default value, 0.5f is half sized text, 2.0f double sized text and so on

Declaration
public float TextScale { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

TextWidth

Declaration
public int TextWidth { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

WrapText

Enable text wrapping - use MaxWidth property to set maximum allowed width of the textlabel

Declaration
public bool WrapText { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

WrapWords

Enable word wrapping - words will no longer get tear apart if possible - make sure to enable property WrapText to make this property to have an effect

Declaration
public bool WrapWords { get; set; }
Property Value
Type Description
Boolean

Methods

| Improve this Doc View Source

Draw()

Declaration
public override void Draw()
Overrides
| Improve this Doc View Source

GetRestrictedRenderScissorRect()

Declaration
protected Vector4 GetRestrictedRenderScissorRect()
Returns
Type Description
Vector4
| Improve this Doc View Source

RefreshLayout()

Declaration
public virtual void RefreshLayout()
| Improve this Doc View Source

SetText(String)

Declaration
protected virtual void SetText(string value)
Parameters
Type Name Description
String value
| Improve this Doc View Source

Update()

Declaration
public override void Update()
Overrides