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

VariablesDescription
Libraries.Game.Graphics.Drawable drawableA drawable that contains the image of the text character. This can be undefined if the character has no visual appearance, e.g. a space.
integer verticalAdvanceThe amount of vertical distance between this character and the next.
integer lengthToGlyphThe amount of white space that precedes the beginning of the drawable.
integer heightFromBaseLineHow tall the glyph is, relative to the font's base line.
integer horizontalAdvanceThe amount of horizontal distance between this character and the next.

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns a CompareResult.
CopyGlyph()This action takes the current glyph and returns a new glyph that has all of the same integer values and a new Drawable that is identical to the Drawable of the current glyph.
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 a CompareResult. The compare result is either larger if this hash code is larger than the object passed as a parameter, smaller, or equal.

Example Code

use Libraries.Language.Support.CompareResult
        Object o
        Object t
        CompareResult result = o:Compare(t)

Parameters

Return

Libraries.Language.Support.CompareResult: The Compare result, Smaller, Equal, or Larger.

CopyGlyph()

This action takes the current glyph and returns a new glyph that has all of the same integer values and a new Drawable that is identical to the Drawable of the current glyph.

Return

Libraries.Game.Graphics.Glyph:

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

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.