Table of Contents

Class TextAreaConfig

Namespace
Vintagestory.GameContent
Assembly
VSSurvivalMod.dll

Font settings for signs and other writeable surfaces Open in GitHub

[DocumentAsJson]
public class TextAreaConfig
Inheritance
TextAreaConfig

Examples

"fontConfig": {
    "maxWidth": 208,
    "maxHeight": 96,
    "fontSize": 20,
    "textVoxelOffsetY": -1,
    "textVoxelOffsetZ": 0.25,
    "textVoxelHeight": 6,
    "fontName": "Almendra",
    "verticalAlign": "Middle",
    "boldFont": true
}

Fields

BoldFont (Optional) (Default: false)

Whether to use bold font for the text

[DocumentAsJson("Optional", "false", false)]
public bool BoldFont

Field Value

bool

FontName (Optional) (Default: sans-serif)

Font family name of the text

[DocumentAsJson("Optional", "sans-serif", false)]
public string FontName

Field Value

string

FontSize (Optional) (Default: 20)

Font size of the text

[DocumentAsJson("Optional", "20", false)]
public float FontSize

Field Value

float

MaxHeight (Optional) (Default: 165)

Maximum height of the text area window in pixels

[DocumentAsJson("Optional", "165", false)]
public int MaxHeight

Field Value

int

MaxWidth (Optional) (Default: 160)

Maximum width of the text area window in pixels

[DocumentAsJson("Optional", "160", false)]
public int MaxWidth

Field Value

int

textVoxelHeight (Optional) (Default: 6.5)

Text area height in voxels. Each block is 16x16x16 voxels

[DocumentAsJson("Optional", "6.5", false)]
public float textVoxelHeight

Field Value

float

textVoxelOffsetX (Optional) (Default: 0)

Offset in voxels on the X axis. Each block is 16x16x16 voxels

[DocumentAsJson("Optional", "0", false)]
public float textVoxelOffsetX

Field Value

float

textVoxelOffsetY (Optional) (Default: 0)

Offset in voxels on the Y axis. Each block is 16x16x16 voxels

[DocumentAsJson("Optional", "0", false)]
public float textVoxelOffsetY

Field Value

float

textVoxelOffsetZ (Optional) (Default: 0)

Offset in voxels on the Z axis. Each block is 16x16x16 voxels

[DocumentAsJson("Optional", "0", false)]
public float textVoxelOffsetZ

Field Value

float

textVoxelWidth (Optional) (Default: 14)

Text area width in voxels. Each block is 16x16x16 voxels

[DocumentAsJson("Optional", "14", false)]
public float textVoxelWidth

Field Value

float

VerticalAlign (Optional) (Default: Top)

Aligning of vertical position of the text

[DocumentAsJson("Optional", "Top", false)]
public EnumVerticalAlign VerticalAlign

Field Value

EnumVerticalAlign

WithScrollbar (Optional) (Default: false)

Whether to add scrollbar to the text area window

[DocumentAsJson("Optional", "false", false)]
public bool WithScrollbar

Field Value

bool