Libraries.Game.Graphics.Fonts.TrueTypeCollectionRecords Documentation

The TrueTypeCollectionRecords maintains TrueTypeCollection (.ttc) font file information. TrueTypeCollection font files have several sets of fonts contained in a single file and this class saves the indecies used to access each font within the collection.

Example Code

use Libraries.Game.Game
    use Libraries.Game.Graphics.Fonts.all
    use Libraries.Containers.Array

    class Main is Game
        action Main
            StartGame()
        end

        action CreateGame
            TrueTypeCollectionData data
            TrueTypeCollectionRecords records
            Array<TrueTypeCollectionData> dataList
            dataList:Add(data)
            records:SetCollectionTables(dataList)
        end
    end

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.
GetCollectionTables()This action returns the array containing all the font table information for the font file.
GetHashCode()This action gets the hash code for an object.
GetNumberOfFontsInCollection()This action returns the number of fonts in the font file.
GetOffsetTable()This action returns the array containing all of the offsets to the different fonts in the font file.
SetCollectionTables(Libraries.Containers.Array<Libraries.Game.Graphics.Fonts.TrueTypeCollectionData> tables)This action sets the array containing all the font table information for the font file.
SetNumberOfFontsInCollection(integer count)This action sets the number of fonts in the font file.
SetOffsetTable(Libraries.Containers.Array<integer> table)This action sets the array containing all of the offsets to the different fonts in the font file.

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

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

Return

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

GetCollectionTables()

This action returns the array containing all the font table information for the font file.

Example Code

use Libraries.Game.Game
        use Libraries.Game.Graphics.Fonts.all
        use Libraries.Containers.Array

        class Main is Game
            action Main
                StartGame()
            end

            action CreateGame
                TrueTypeCollectionRecords records
                Array<TrueTypeCollectionData> dataList = records:GetCollectionTables()
            end
        end

Return

Libraries.Containers.Array: Returns the array containing all the font table information for the font file.

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.

GetNumberOfFontsInCollection()

This action returns the number of fonts in the font file.

Example Code

use Libraries.Game.Game
        use Libraries.Game.Graphics.Fonts.all
        use Libraries.Containers.Array

        class Main is Game
            action Main
                StartGame()
            end

            action CreateGame
                TrueTypeCollectionRecords records
                output records:GetNumberOfFontsInCollection()
            end
        end

Return

integer: Returns the number of fonts in the font file.

GetOffsetTable()

This action returns the array containing all of the offsets to the different fonts in the font file.

Example Code

use Libraries.Game.Game
        use Libraries.Game.Graphics.Fonts.all
        use Libraries.Containers.Array

        class Main is Game
            action Main
                StartGame()
            end

            action CreateGame
                TrueTypeCollectionRecords records
                Array<integer> offsets = records:GetOffsetTable()
            end
        end

Return

Libraries.Containers.Array: Returns the array containing all of the offsets to the different fonts in the font file.

SetCollectionTables(Libraries.Containers.Array<Libraries.Game.Graphics.Fonts.TrueTypeCollectionData> tables)

This action sets the array containing all the font table information for the font file.

Example Code

use Libraries.Game.Game
        use Libraries.Game.Graphics.Fonts.all
        use Libraries.Containers.Array

        class Main is Game
            action Main
                StartGame()
            end

            action CreateGame
                TrueTypeCollectionData data
                TrueTypeCollectionRecords records
                Array<TrueTypeCollectionData> dataList
                dataList:Add(data)
                records:SetCollectionTables(dataList)
            end
        end

Parameters

SetNumberOfFontsInCollection(integer count)

This action sets the number of fonts in the font file.

Example Code

use Libraries.Game.Game
        use Libraries.Game.Graphics.Fonts.all
        use Libraries.Containers.Array

        class Main is Game
            action Main
                StartGame()
            end

            action CreateGame
                TrueTypeCollectionRecords records
                records:SetNumberOfFontsInCollection(10)
            end
        end

Parameters

SetOffsetTable(Libraries.Containers.Array<integer> table)

This action sets the array containing all of the offsets to the different fonts in the font file.

Example Code

use Libraries.Game.Game
        use Libraries.Game.Graphics.Fonts.all
        use Libraries.Containers.Array

        class Main is Game
            action Main
                StartGame()
            end

            action CreateGame
                TrueTypeCollectionRecords records
                Array<integer> offsets
                offsets:Add(50)
                offsets:Add(100)
                offsets:Add(150)
                records:SetOffsetTable(offsets)
            end
        end

Parameters