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

Internal class for managing characters in RichText. More...

Public Member Functions

 RichTextCharacter (char character, int charOffset=0)
 Creates a new RichTextCharacter. More...
 
void Update ()
 Update the character. More...
 

Public Attributes

Color Color = Color.White
 The Color of the character. More...
 
Color Color0 = Color.White
 The Color of the top left corner. More...
 
Color Color1 = Color.White
 The Color of the top left corner. More...
 
Color Color2 = Color.White
 The Color of the top left corner. More...
 
Color Color3 = 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...
 
char Character
 The character. More...
 
float Timer
 Timer used for animation. More...
 
float SineAmpX
 The horizontal sine wave amplitude. More...
 
float SineAmpY
 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
 The horizontal sine wave offset. More...
 
float SineOffsetY
 The vertical sine wave offset. More...
 
float CharOffset
 The sine wave offset for this specific character. 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 OffsetAmount = 10
 The offset amount for each character. More...
 
float ShadowX
 The X position of the shadow. More...
 
float ShadowY
 The Y position of the shadow. More...
 
float OutlineThickness
 The outline thickness. More...
 
float ShakeX
 The amount of horizontal shake. More...
 
float ShakeY
 The amount of vertical shake. More...
 
bool Bold = false
 Determines if the character is bold. Not supported yet. More...
 
float ScaleX = 1
 The X scale of the character. More...
 
float ScaleY = 1
 The Y scale of the character. More...
 
float Angle
 The angle of the character. More...
 
float X
 The X position offset of the character. More...
 
float Y
 The Y position offset of the character. More...
 

Properties

float OffsetX [get]
 The final horizontal offset position of the character when rendered. More...
 
float OffsetY [get]
 The final vertical offset position of the character when rendered. More...
 

Detailed Description

Internal class for managing characters in RichText.

Constructor & Destructor Documentation

Otter.RichTextCharacter.RichTextCharacter ( char  character,
int  charOffset = 0 
)

Creates a new RichTextCharacter.

Parameters
characterThe character.
charOffsetThe character offset for animation.

Member Function Documentation

void Otter.RichTextCharacter.Update ( )

Update the character.

Member Data Documentation

float Otter.RichTextCharacter.Angle

The angle of the character.

bool Otter.RichTextCharacter.Bold = false

Determines if the character is bold. Not supported yet.

char Otter.RichTextCharacter.Character

The character.

float Otter.RichTextCharacter.CharOffset

The sine wave offset for this specific character.

int Otter.RichTextCharacter.CharOffsetX = 0

The X offset of the character. BitmapFont only.

int Otter.RichTextCharacter.CharOffsetY = 0

The Y offset of the character. BitmapFont only.

Color Otter.RichTextCharacter.Color = Color.White

The Color of the character.

Color Otter.RichTextCharacter.Color0 = Color.White

The Color of the top left corner.

Color Otter.RichTextCharacter.Color1 = Color.White

The Color of the top left corner.

Color Otter.RichTextCharacter.Color2 = Color.White

The Color of the top left corner.

Color Otter.RichTextCharacter.Color3 = Color.White

The Color of the top left corner.

float Otter.RichTextCharacter.OffsetAmount = 10

The offset amount for each character.

Color Otter.RichTextCharacter.OutlineColor = Color.White

The Color of the outline.

float Otter.RichTextCharacter.OutlineThickness

The outline thickness.

float Otter.RichTextCharacter.ScaleX = 1

The X scale of the character.

float Otter.RichTextCharacter.ScaleY = 1

The Y scale of the character.

Color Otter.RichTextCharacter.ShadowColor = Color.Black

The Color of the shadow.

float Otter.RichTextCharacter.ShadowX

The X position of the shadow.

float Otter.RichTextCharacter.ShadowY

The Y position of the shadow.

float Otter.RichTextCharacter.ShakeX

The amount of horizontal shake.

float Otter.RichTextCharacter.ShakeY

The amount of vertical shake.

float Otter.RichTextCharacter.SineAmpX

The horizontal sine wave amplitude.

float Otter.RichTextCharacter.SineAmpY

The vertical sine wave amplitude.

float Otter.RichTextCharacter.SineOffsetX

The horizontal sine wave offset.

float Otter.RichTextCharacter.SineOffsetY

The vertical sine wave offset.

float Otter.RichTextCharacter.SineRateX = 1

The horizontal sine wave rate.

float Otter.RichTextCharacter.SineRateY = 1

The vertical sine wave rate.

float Otter.RichTextCharacter.Timer

Timer used for animation.

float Otter.RichTextCharacter.X

The X position offset of the character.

float Otter.RichTextCharacter.Y

The Y position offset of the character.

Property Documentation

float Otter.RichTextCharacter.OffsetX
get

The final horizontal offset position of the character when rendered.

float Otter.RichTextCharacter.OffsetY
get

The final vertical offset position of the character when rendered.


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