Libraries.Game.DesktopConfiguration Documentation

This class represents the configuration of the game. It is referenced when the game is first created to set its initial data.

Inherits from: Libraries.Language.Object, Libraries.Game.ApplicationConfiguration

Summary

Variable Summary Table

VariablesDescription
number multipleClickTimerThe maximum number of seconds allowed between each mouse click before the click is no longer considered related to the previous click. This is used for things such as double-click input.
number multipleKeyPressTimerThe maximum number of seconds allowed between each key press before the press is no longer considered related to the previous key press. This is used for things like capturing double-taps on keys.
integer foregroundFPSTarget framerate when the window is in the foreground. Use 0 to never sleep.
integer widthThe initial width of the application screen.
text titleThe title of the application.
boolean vSyncEnabledIf true, the application will use vSync.
integer backgroundFPSTarget framerate when the window is not in the foreground. Use 0 to never sleep, -1 to not render.
Libraries.Game.Graphics.Color initialBackgroundColorThe starting color of the window while the Game is loading.
integer heightThe initial height of the application screen.
Libraries.Game.ScreenResolution defaultResolutionThe ScreenResolution to use when the game launches. If left undefined, the game will create a window using the configuration's given width and height.
boolean autoResizeTexturesIf true, the textures will automatically be resized when the window is resized.
integer yInitial y coordinate where the window will appear on screen. -1 for center.
boolean resizableIf true, the window will be resizable.
integer xInitial x coordinate where the window will appear on screen. -1 for center.

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns a CompareResult.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetHashCode()This action gets the hash code for an object.

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns a CompareResult. The compare result is either larger if this hash code is larger than the object passed as a parameter, smaller, or equal.

Example Code

use Libraries.Language.Support.CompareResult
        Object o
        Object t
        CompareResult result = o:Compare(t)

Parameters

Return

Libraries.Language.Support.CompareResult: 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.

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.