Libraries.Game.Graphics.Fonts.Signed16BitFontUnit Documentation

The Signed16BitFontUnit class is used to maintain 16-bit signed integers that are used in the font system.

Example Code

use Libraries.Game.Graphics.Fonts.all
    use Libraries.Game.Game

    class Main is Game
        action Main
            StartGame()
        end
        
        action CreateGame
            Signed16BitFontUnit fontUnit
            fontUnit:SetFontUnit(100)
        end
    e

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
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.
GetFontUnit()This action returns the signed 16-bit font unit for the font.
GetHashCode()This action gets the hash code for an object.
SetFontUnit(integer fullWord)This action sets the signed 16-bit font unit for the font.
ToText()This action returns the signed 16-bit font unit for the font as text.

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 (smalle

Parameters

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(

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

GetFontUnit()

This action returns the signed 16-bit font unit for the font.

Example Code

use Libraries.Game.Graphics.Fonts.all
        use Libraries.Game.Game

        class Main is Game
            action Main
                StartGame()
            end

            action CreateGame
                Signed16BitFontUnit fontUnit
                output fontUnit:GetFontUnit()
            end
        e

Return

integer: Returns the signed 16-bit font unit for the font.

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.

SetFontUnit(integer fullWord)

This action sets the signed 16-bit font unit for the font.

Example Code

use Libraries.Game.Graphics.Fonts.all
        use Libraries.Game.Game

        class Main is Game
            action Main
                StartGame()
            end

            action CreateGame
                Signed16BitFontUnit fontUnit
                fontUnit:SetFontUnit(100)
            end
        e

Parameters

ToText()

This action returns the signed 16-bit font unit for the font as text.

Example Code

use Libraries.Game.Graphics.Fonts.all
        use Libraries.Game.Game

        class Main is Game
            action Main
                StartGame()
            end

            action CreateGame
                Signed16BitFontUnit fontUnit
                output fontUnit:ToText()
            end
        e

Return

text: Returns the signed 16-bit font unit for the font as text.