Libraries.Game.GameDisplay Documentation

This class represents the game window. This class is handled automatically by the Game class. Most users will never need to interact with this class directl

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.
Destroy()This action closes the windo
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetClipboard()Not all implementations support a clipboard, but all displays support the operations so that they can be called everywhere.
GetConfiguration()This action returns the ApplicationConfiguration being used by the GameDispla
GetHashCode()This action gets the hash code for an object.
GetHeight()This action returns the height of the GameDispla
GetPixelScaleFactor()This action returns the ratio between screen coordinates and pixel
GetResize()This action returns whether the GameDisplay is resizable or no
GetSecondsBetweenFrames()This action tests how many seconds have passed since the last time that the time was update
GetSecondsSinceStart()This action returns the number of seconds that have passed since the game was started.
GetWidth()This action returns the width of the GameDispla
IsAvailable()The IsAvailable action returns whether or not a display is available to draw on.
RequestRendering()This action tells the GameDisplay to render to the scree
SetClipboard(text value)Not all implementations support a clipboard, but all displays support the operations so that they can be called everywhere.
SetConfiguration(Libraries.Game.ApplicationConfiguration conf)This action sets the ApplicationConfiguration being used by the game, which includes data for the screen.
SetDisplayMode(integer width, integer height, boolean fullscreen)This action sets the width and height of the GameDisplay, and optionally makes the game full screen.
SetVSync(boolean vsync)This action sets vSync on or off for the GameDispla
WasResized()This action returns whether or not the GameDisplay has been resize

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.

Destroy()

This action closes the windo

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.

GetClipboard()

Not all implementations support a clipboard, but all displays support the operations so that they can be called everywhere. If an implementation supports a clipboard, the appopriate system mechanisms are handled automaticall

Return

text:

GetConfiguration()

This action returns the ApplicationConfiguration being used by the GameDispla

Return

Libraries.Game.ApplicationConfiguration:

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.

GetHeight()

This action returns the height of the GameDispla

Return

integer:

GetPixelScaleFactor()

This action returns the ratio between screen coordinates and pixel

Return

number:

GetResize()

This action returns whether the GameDisplay is resizable or no

Return

boolean:

GetSecondsBetweenFrames()

This action tests how many seconds have passed since the last time that the time was update

Return

number:

GetSecondsSinceStart()

This action returns the number of seconds that have passed since the game was started.

Example Code

use Libraries.Game.Game
    use Libraries.Game.GameDisplay
    use Libraries.Game.GameStateManager
    
    class Main is Game

        GameDisplay display = undefined
        integer frameCount = 0

        action Main
            StartGame()
        end

        action CreateGame
            GameStateManager manager
            display = manager:GetGameDisplay()
        end

        action Update(number seconds)
            frameCount = frameCount + 1
            if frameCount = 30
                number time = display:GetSecondsSinceStart()
                output "The game has been running for " + time + " seconds."
            end
        end
    e

Return

number:

GetWidth()

This action returns the width of the GameDispla

Return

integer:

IsAvailable()

The IsAvailable action returns whether or not a display is available to draw on. If no display is available, actions that try to create or draw graphics (such as loading a Drawable) will create an error. This will return false if called before StartGame() is called in the Game class, and will typically return true after the game has been starte

Return

boolean:

RequestRendering()

This action tells the GameDisplay to render to the scree

SetClipboard(text value)

Not all implementations support a clipboard, but all displays support the operations so that they can be called everywhere. If an implementation supports a clipboard, the appropriate system mechanisms are handled automaticall

Parameters

SetConfiguration(Libraries.Game.ApplicationConfiguration conf)

This action sets the ApplicationConfiguration being used by the game, which includes data for the screen. The ApplicationConfiguration must be of the correct type or otherwise an error will be thrown, e.g., if the GameDisplay is a DesktopDisplay, it must receive a DesktopConfiguratio

Parameters

SetDisplayMode(integer width, integer height, boolean fullscreen)

This action sets the width and height of the GameDisplay, and optionally makes the game full screen. Returns a boolean value indicating whether the action was successful - for example, this should typically work on desktops, but on mobile devices it will fail and return fals

Parameters

Return

boolean:

SetVSync(boolean vsync)

This action sets vSync on or off for the GameDispla

Parameters

WasResized()

This action returns whether or not the GameDisplay has been resize

Return

boolean: