C# Class FFACETools.FFACE.WindowerTools.TextObject

Text object to display in FFXi
Show file Open project: golfandsurf/Campah

Private Properties

Property Type Description
GetExceptionMessage string

Public Methods

Method Description
DeleteTextObject ( ) : void

Will remove the text object
RenderTextObject ( ) : void

Will render the Text Object
SetBGColor ( byte transparent, byte red, byte green, byte blue ) : void

Set the background color of the text
SetFont ( string type, short height ) : void

Sets the font type and height
SetFontColor ( byte transparent, byte red, byte green, byte blue ) : void

Sets the Color of the font
SetFontColor ( byte transparent, byte red, byte green, byte blue, bool visible, bool bold, bool italic, bool rightJustified ) : void

Sets the Color of the font
SetLocation ( float horizontal, float vertical ) : void

Set the location of the text
TextObject ( int instanceID ) : System

Constructor
UpdateTextObject ( ) : void

Will update the text object after changes
UpdateTextObject ( string sText ) : void

Will update the text of the object

Private Methods

Method Description
GetExceptionMessage ( Colors color ) : string

Generates a parameter error message based on color

Method Details

DeleteTextObject() public method

Will remove the text object
public DeleteTextObject ( ) : void
return void

RenderTextObject() public method

Will render the Text Object
public RenderTextObject ( ) : void
return void

SetBGColor() public method

Set the background color of the text
public SetBGColor ( byte transparent, byte red, byte green, byte blue ) : void
transparent byte Transparency level (0-255)
red byte Red depth (0-255)
green byte Green depth (0-255)
blue byte Blue depth (0-255)
return void

SetFont() public method

Sets the font type and height
public SetFont ( string type, short height ) : void
type string Type of font
height short Height of font
return void

SetFontColor() public method

Sets the Color of the font
public SetFontColor ( byte transparent, byte red, byte green, byte blue ) : void
transparent byte Transparency level (0-255)
red byte Red depth (0-255)
green byte Green depth (0-255)
blue byte Blue depth (0-255)
return void

SetFontColor() public method

Sets the Color of the font
public SetFontColor ( byte transparent, byte red, byte green, byte blue, bool visible, bool bold, bool italic, bool rightJustified ) : void
transparent byte Transparency level (0-255)
red byte Red depth (0-255)
green byte Green depth (0-255)
blue byte Blue depth (0-255)
visible bool If the font is visible or not
bold bool If the font should be in bold
italic bool If the font should be in italic
rightJustified bool If the font should be right justified
return void

SetLocation() public method

Set the location of the text
public SetLocation ( float horizontal, float vertical ) : void
horizontal float
vertical float
return void

TextObject() public method

Constructor
public TextObject ( int instanceID ) : System
instanceID int Instance ID generated by FFACE
return System

UpdateTextObject() public method

Will update the text object after changes
public UpdateTextObject ( ) : void
return void

UpdateTextObject() public method

Will update the text of the object
public UpdateTextObject ( string sText ) : void
sText string
return void