Libraries.Game.Graphics.Glyph Documentation
The Glyph class represents a text character that is drawn as part of a Font. It contains all important information for a character of text. This is used internally by the Font class, and most users will never need to interface with this class directly.
Inherits from: Libraries.Language.Object
Summary
Variable Summary Table
| Variables | Description |
|---|---|
| integer horizontalAdvance | The amount of horizontal distance between this character and the next. |
| integer verticalAdvance | The amount of vertical distance between this character and the next. |
| Libraries.Game.Graphics.TextureRegion texture | A TextureRegion that contains the image of the text character. This can be undefined if the character has no visual appearance, e.g. a space. |
| Libraries.Game.Graphics.Color color | The color of this glyph, or undefined if none is set for this character. |
| integer lengthToGlyph | The amount of white space that precedes the beginning of the drawable. |
| integer heightFromBaseLine | How tall the glyph is, relative to the font's base line. |
Actions Summary Table
| Actions | Description |
|---|---|
| Compare(Libraries.Language.Object object) | This action compares two object hash codes and returns an integer. |
| Equals(Libraries.Language.Object object) | This action determines if two objects are equal based on their hash code values. |
| GetHashCode() | This action gets the hash code for an object. |
Actions Documentation
Compare(Libraries.Language.Object object)
This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.
Example Code
Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)Parameters
- Libraries.Language.Object: The object to compare to.
Return
integer: The Compare result, Smaller, Equal, or Larger.
Equals(Libraries.Language.Object object)
This action determines if two objects are equal based on their hash code values.
Example Code
use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)Parameters
- Libraries.Language.Object: The to be compared.
Return
boolean: True if the hash codes are equal and false if they are not equal.
GetHashCode()
This action gets the hash code for an object.
Example Code
Object o
integer hash = o:GetHashCode()Return
integer: The integer hash code of the object.