C# Class FFACETools.FFACE.WindowerTools.TextObject

Text object to display in FFXi
Afficher le fichier Open project: golfandsurf/Campah

Private Properties

Свойство Type Description
GetExceptionMessage string

Méthodes publiques

Méthode 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

Méthode Description
GetExceptionMessage ( Colors color ) : string

Generates a parameter error message based on color

Method Details

DeleteTextObject() public méthode

Will remove the text object
public DeleteTextObject ( ) : void
Résultat void

RenderTextObject() public méthode

Will render the Text Object
public RenderTextObject ( ) : void
Résultat void

SetBGColor() public méthode

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)
Résultat void

SetFont() public méthode

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

SetFontColor() public méthode

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)
Résultat void

SetFontColor() public méthode

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
Résultat void

SetLocation() public méthode

Set the location of the text
public SetLocation ( float horizontal, float vertical ) : void
horizontal float
vertical float
Résultat void

TextObject() public méthode

Constructor
public TextObject ( int instanceID ) : System
instanceID int Instance ID generated by FFACE
Résultat System

UpdateTextObject() public méthode

Will update the text object after changes
public UpdateTextObject ( ) : void
Résultat void

UpdateTextObject() public méthode

Will update the text of the object
public UpdateTextObject ( string sText ) : void
sText string
Résultat void