Libraries.Game.GameDisplay

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 directly.

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)

This action closes the window.

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)

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 automatically.

This action returns the ApplicationConfiguration being used by the GameDisplay.

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

This action returns the height of the GameDisplay.

This action returns the ratio between screen coordinates and pixels.

This action returns whether the GameDisplay is resizable or not.

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

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
    end

This action returns the width of the GameDisplay.

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 started.

This action tells the GameDisplay to render to the screen.

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 automatically.

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 DesktopConfiguration.

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 false.

This action sets vSync on or off for the GameDisplay.

This action returns whether or not the GameDisplay has been resized.