Otter  0.9.88
2d Game Development Framework based on SFML.Net
 All Classes Namespaces Functions Variables Enumerations Properties
Otter.RichTextConfig Class Reference

A utility class used for storing default values for a RichText object. Set the values by using "var config = new RichTextConfig() { Font = "MyFont.ttf", FontSize = 16, ... };" More...

Public Attributes

float SineAmpX = 0
 The horizontal sine wave amplitude. More...
 
float SineAmpY = 0
 The vertical sine wave amplitude. More...
 
float SineRateX = 1
 The horizontal sine wave rate. More...
 
float SineRateY = 1
 The vertical sine wave rate. More...
 
float SineOffsetX = 0
 The horizontal sine wave offset. More...
 
float SineOffsetY = 0
 The vertical sine wave offset. More...
 
float OffsetAmount = 10
 The offset amount for each character for sine wave related transformations. More...
 
float ShadowX = 0
 The X position of the shadow. More...
 
float ShadowY = 0
 The Y position of the shadow. More...
 
float OutlineThickness = 0
 The outline thickness. More...
 
float ShakeX = 0
 The amount of horizontal shake. More...
 
float ShakeY = 0
 The amount of vertical shake. More...
 
Color CharColor = Color.White
 The Color of the character. More...
 
Color CharColor0 = Color.White
 The Color of the top left corner. More...
 
Color CharColor1 = Color.White
 The Color of the top left corner. More...
 
Color CharColor2 = Color.White
 The Color of the top left corner. More...
 
Color CharColor3 = Color.White
 The Color of the top left corner. More...
 
Color ShadowColor = Color.Black
 The Color of the shadow. More...
 
Color OutlineColor = Color.White
 The Color of the outline. More...
 
int CharOffsetX = 0
 The X offset of the character. BitmapFont only. More...
 
int CharOffsetY = 0
 The Y offset of the character. BitmapFont only. More...
 
float ScaleX = 1
 The X scale of the character. More...
 
float ScaleY = 1
 The Y scale of the character. More...
 
float Angle = 0
 The angle of the character. More...
 
float LetterSpacing = 1.0f
 The spacing between each character. More...
 
float LineHeight = 1.0f
 The line height between each line. Default is 1. More...
 
int MonospaceWidth = -1
 Controls the spacing between each character. If set above 0 the text will use a monospacing. More...
 
TextAlign TextAlign = TextAlign.Left
 The alignment of the text. Left, Right, or Center. More...
 
BaseFont Font
 The font to use. More...
 
int FontSize = 16
 The font size. More...
 
string String = ""
 The string to display. More...
 
int TextWidth = -1
 The width of the text block. More...
 
int TextHeight = -1
 The height of the text block. More...
 
float OffsetX
 How far to offset the text rendering horizontally from the origin. More...
 
float OffsetY
 How far to offset the text rendering vertically from the origin. More...
 

Detailed Description

A utility class used for storing default values for a RichText object. Set the values by using "var config = new RichTextConfig() { Font = "MyFont.ttf", FontSize = 16, ... };"

Member Data Documentation

float Otter.RichTextConfig.Angle = 0

The angle of the character.

Color Otter.RichTextConfig.CharColor = Color.White

The Color of the character.

Color Otter.RichTextConfig.CharColor0 = Color.White

The Color of the top left corner.

Color Otter.RichTextConfig.CharColor1 = Color.White

The Color of the top left corner.

Color Otter.RichTextConfig.CharColor2 = Color.White

The Color of the top left corner.

Color Otter.RichTextConfig.CharColor3 = Color.White

The Color of the top left corner.

int Otter.RichTextConfig.CharOffsetX = 0

The X offset of the character. BitmapFont only.

int Otter.RichTextConfig.CharOffsetY = 0

The Y offset of the character. BitmapFont only.

BaseFont Otter.RichTextConfig.Font

The font to use.

int Otter.RichTextConfig.FontSize = 16

The font size.

float Otter.RichTextConfig.LetterSpacing = 1.0f

The spacing between each character.

float Otter.RichTextConfig.LineHeight = 1.0f

The line height between each line. Default is 1.

int Otter.RichTextConfig.MonospaceWidth = -1

Controls the spacing between each character. If set above 0 the text will use a monospacing.

float Otter.RichTextConfig.OffsetAmount = 10

The offset amount for each character for sine wave related transformations.

float Otter.RichTextConfig.OffsetX

How far to offset the text rendering horizontally from the origin.

float Otter.RichTextConfig.OffsetY

How far to offset the text rendering vertically from the origin.

Color Otter.RichTextConfig.OutlineColor = Color.White

The Color of the outline.

float Otter.RichTextConfig.OutlineThickness = 0

The outline thickness.

float Otter.RichTextConfig.ScaleX = 1

The X scale of the character.

float Otter.RichTextConfig.ScaleY = 1

The Y scale of the character.

Color Otter.RichTextConfig.ShadowColor = Color.Black

The Color of the shadow.

float Otter.RichTextConfig.ShadowX = 0

The X position of the shadow.

float Otter.RichTextConfig.ShadowY = 0

The Y position of the shadow.

float Otter.RichTextConfig.ShakeX = 0

The amount of horizontal shake.

float Otter.RichTextConfig.ShakeY = 0

The amount of vertical shake.

float Otter.RichTextConfig.SineAmpX = 0

The horizontal sine wave amplitude.

float Otter.RichTextConfig.SineAmpY = 0

The vertical sine wave amplitude.

float Otter.RichTextConfig.SineOffsetX = 0

The horizontal sine wave offset.

float Otter.RichTextConfig.SineOffsetY = 0

The vertical sine wave offset.

float Otter.RichTextConfig.SineRateX = 1

The horizontal sine wave rate.

float Otter.RichTextConfig.SineRateY = 1

The vertical sine wave rate.

string Otter.RichTextConfig.String = ""

The string to display.

TextAlign Otter.RichTextConfig.TextAlign = TextAlign.Left

The alignment of the text. Left, Right, or Center.

int Otter.RichTextConfig.TextHeight = -1

The height of the text block.

int Otter.RichTextConfig.TextWidth = -1

The width of the text block.


The documentation for this class was generated from the following file: