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
end

Inherits from: Libraries.Language.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.

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Example

Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Parameters

Return

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

Example

use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)

GetFontUnit()

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

Return

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

Example

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
end

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

SetFontUnit(integer fullWord)

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

Parameters

  • integer fullWord: The signed 16-bit font unit to set.

Example

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
end

ToText()

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

Return

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

Example

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
end