Libraries.Game.DesktopDisplay

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 class is used specifically on desktop platforms (Windows and Mac OS X).

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)

Used internally by the game engine. This should never be called by users.

This action asks the operating system to give the main application window the focus. This only works on desktop platforms - on other platforms, this call is ignored.

This action will return an array containing all of the screen resolutions available for this machine.

This action returns the DesktopConfiguration being used by the GameDisplay.

This action returns the DesktopConfiguration being used by the GameDisplay.

This action returns a ScreenResolution object that describes the currently set resolution of the computer's desktop (not the resolution being used by the game).

This action returns the screen x coordinate of the DesktopDisplay.

This action returns the screen y coordinate of the DesktopDisplay.

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

This action returns the height of the DesktopDisplay.

This action returns the ratio between screen coordinates and pixels.

This action returns whether the DesktopDisplay is resizable or not.

This action will return the current screen resolution being used by the game engine.

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

This action returns whether or not the DesktopDisplay is the currently active application on the system.

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 determines if the user has tried to close the window by clicking the window's red close button.

This action determines whether or not the main application window has the focus on desktop platforms. On non-desktop platforms, this always returns false.

This action returns true if the display is a maximized window. If the display isn't maximized, or if the display is full screen, this returns false.

This action returns true if the display is minimized, or false otherwise.

This action maximizes the window. It does nothing if the window is already maximized or if the display is fullscreen.

This action minimizes the window.

This action tells the DesktopDisplay to render to the screen.

This action returns a maximized window to a smaller window, or returns a minimized window to the foreground.

This action sets the DesktopConfiguration being used by the game, which includes data for the screen.

This action sets the DesktopConfiguration being used by the game, which includes data for the screen.

This action sets the width and height of the DesktopDisplay, and optionally makes the game full screen.

This action records the time when the action is called, and stores it.

This action sets whether the DesktopDisplay should be resizable or not.

This action will set the game screen to use the given screen resolution. The resolution should be acquired from one of the actions that provides the usable screen resolutions for this machine, such as GetDesktopResolution or GetAvailableResolutions.

This action sets vSync on or off for the DesktopDisplay.

This action will set the icon the application uses in the taskbar on Windows platforms.

This action will set the icon the application uses in the taskbar on Windows platforms.

This action sets the position of the window on the screen. This uses the coordinate system of the native platform, which often will start the y index at the top of the screen and move down as the y value increases.

This action initializes the DesktopDisplay.

This action updates the game screen without polling the input.

This action forces the Game to draw its contents to the DesktopDisplay's internal buffer without drawing them to the screen.

This action updates the game's timekeeping information.

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