Otter  0.9.8.91
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

char Character
 The character. More...
 
float Timer
 Timer used for animation. More...
 
float CharOffset
 The sine wave offset for this specific character. More...
 
bool Bold = false
 Determines if the character is bold. Not supported yet. More...
 

Properties

Color Color [get, set]
 The Color of the character. More...
 
Color Color0 [get, set]
 The Color of the top left corner. More...
 
Color Color1 [get, set]
 The Color of the top left corner. More...
 
Color Color2 [get, set]
 The Color of the top left corner. More...
 
Color Color3 [get, set]
 The Color of the top left corner. More...
 
Color ShadowColor [get, set]
 The Color of the shadow. More...
 
Color OutlineColor [get, set]
 The Color of the outline. More...
 
float OffsetAmount [get, set]
 The offset amount for each character. More...
 
int TextureOffsetX [get, set]
 The horizontal texture offset of the character. BitmapFont only. More...
 
int TextureOffsetY [get, set]
 The vertical texture offset of the character. BitmapFont only. More...
 
float OutlineThickness [get, set]
 The outline thickness. More...
 
float SineOffsetX [get, set]
 The horizontal sine wave offset. More...
 
float SineOffsetY [get, set]
 The vertical sine wave offset. More...
 
float ShadowX [get, set]
 The X position of the shadow. More...
 
float ShadowY [get, set]
 The Y position of the shadow. More...
 
float SineRateX [get, set]
 The horizontal sine wave rate. More...
 
float SineRateY [get, set]
 The vertical sine wave rate. More...
 
float ShakeX [get, set]
 The amount of horizontal shake. More...
 
float ShakeY [get, set]
 The amount of vertical shake. More...
 
float SineAmpX [get, set]
 The horizontal sine wave amplitude. More...
 
float SineAmpY [get, set]
 The vertical sine wave amplitude. More...
 
float ScaleX [get, set]
 The X scale of the character. More...
 
float ScaleY [get, set]
 The Y scale of the character. More...
 
float Angle [get, set]
 The angle of the character. More...
 
float X [get, set]
 The X position offset of the character. More...
 
float Y [get, set]
 The Y position offset of the character. More...
 
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

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.

float Otter.RichTextCharacter.Timer

Timer used for animation.

Property Documentation

float Otter.RichTextCharacter.Angle
getset

The angle of the character.

Color Otter.RichTextCharacter.Color
getset

The Color of the character.

Color Otter.RichTextCharacter.Color0
getset

The Color of the top left corner.

Color Otter.RichTextCharacter.Color1
getset

The Color of the top left corner.

Color Otter.RichTextCharacter.Color2
getset

The Color of the top left corner.

Color Otter.RichTextCharacter.Color3
getset

The Color of the top left corner.

float Otter.RichTextCharacter.OffsetAmount
getset

The offset amount for each character.

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.

Color Otter.RichTextCharacter.OutlineColor
getset

The Color of the outline.

float Otter.RichTextCharacter.OutlineThickness
getset

The outline thickness.

float Otter.RichTextCharacter.ScaleX
getset

The X scale of the character.

float Otter.RichTextCharacter.ScaleY
getset

The Y scale of the character.

Color Otter.RichTextCharacter.ShadowColor
getset

The Color of the shadow.

float Otter.RichTextCharacter.ShadowX
getset

The X position of the shadow.

float Otter.RichTextCharacter.ShadowY
getset

The Y position of the shadow.

float Otter.RichTextCharacter.ShakeX
getset

The amount of horizontal shake.

float Otter.RichTextCharacter.ShakeY
getset

The amount of vertical shake.

float Otter.RichTextCharacter.SineAmpX
getset

The horizontal sine wave amplitude.

float Otter.RichTextCharacter.SineAmpY
getset

The vertical sine wave amplitude.

float Otter.RichTextCharacter.SineOffsetX
getset

The horizontal sine wave offset.

float Otter.RichTextCharacter.SineOffsetY
getset

The vertical sine wave offset.

float Otter.RichTextCharacter.SineRateX
getset

The horizontal sine wave rate.

float Otter.RichTextCharacter.SineRateY
getset

The vertical sine wave rate.

int Otter.RichTextCharacter.TextureOffsetX
getset

The horizontal texture offset of the character. BitmapFont only.

int Otter.RichTextCharacter.TextureOffsetY
getset

The vertical texture offset of the character. BitmapFont only.

float Otter.RichTextCharacter.X
getset

The X position offset of the character.

float Otter.RichTextCharacter.Y
getset

The Y position offset of the character.


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