Libraries.Game.WebConfiguration Documentation

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

Summary

Variable Summary Table

VariablesDescription
boolean capFramesPerSecondWhether or not the Game should be limited to the given number of frames per second. This will not guarantee that the Game will run at the given FPS, only that it will not run at more than the framesPerSecondLimit value. This value is false by default.
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 framesPerSecondLimitThe upper limit for how many frames per second the Game should run at, if capFramesPerSecond is set to true. If capFramesPerSecond is set to false, this will have no effect. The default value for this field is 30.
boolean disableContextMenuIf disableContextMenu is set to true, right-clicking on the game canvas will not open the context menu. If it is set to false, it will open the context menu normally. This value is set to true by default.
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.
text canvasIDThe ID of the canvas to use for rendering the Game.
boolean keepTabFocusThe keepTabFocus flag controls how a game responds to the Tab key. Online games must have the focus to receive input (the user has either clicked on the game window or tabbed to it). If keepTabFocus is false and the user presses the Tab key, the window will lose focus. If it is true, the window will keep the focus even if the user presses Tab.

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

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.