Libraries.Game.GameStateManager Documentation

The GameStateManager is an internal class, used by the game engine to communicate between Quorum and plugin code. Most users will never have to interface with this class directly.

Inherits from: Libraries.Language.Object

Summary

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.
GetAccessibilityManager()
GetApplication()This action returns the application stored by the plugins.
GetFocus()This action returns the current Item that is focused.
GetFocusManager()This action returns the FocusManager which is being used across the Game.
GetGame()This action returns a reference to the Game class.
GetGameDisplay()This action returns the GameDisplay stored by the plugins.
GetGameGraphics()This action returns the GraphicsManager stored by the plugins.
GetHashCode()This action gets the hash code for an object.
GetInput()This action returns a GameInput object that is stored in the plugins.
GetNativePath()This action returns the path of the native file loaded by the engine.
GetOperatingSystem()This action returns a text flag indicating what operating system the game is running on.
SetAccessibilityManager(Libraries.Interface.AccessibilityManager accessibility)
SetApplication(Libraries.Game.Application app)This action is used by the engine to set the game's application info in the plugins.
SetFocus(Libraries.Interface.Item item)This action sets the focus on the given item.
SetFocusManager(Libraries.Game.FocusManager manager)This action sets the FocusManager to be used across the Game.
SetGame(Libraries.Game.Game game)This action is used by the engine to store a reference to the currently running Game class.
SetGameDisplay(Libraries.Game.GameDisplay disp)This action is used by the engine to set the game's display info in the plugins.
SetGameGraphics(Libraries.Game.Graphics.GraphicsManager gl20)This action is used by the engine to set the game's graphics manager in the plugins.
SetInput(Libraries.Game.GameInput gameInput)This action sets a GameInput object to be stored in the plugins.
SetNativePath(text path)This action sets a path to the native file used to load the engine's C plugins.
SetOperatingSystem(text os)This action sets a flag in the plugins indicating what operating system the game is running on.

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.

GetAccessibilityManager()

Return

Libraries.Interface.AccessibilityManager:

GetApplication()

This action returns the application stored by the plugins.

Return

Libraries.Game.Application:

GetFocus()

This action returns the current Item that is focused.

Return

Libraries.Interface.Item:

GetFocusManager()

This action returns the FocusManager which is being used across the Game.

Return

Libraries.Game.FocusManager:

GetGame()

This action returns a reference to the Game class.

Return

Libraries.Game.Game:

GetGameDisplay()

This action returns the GameDisplay stored by the plugins.

Return

Libraries.Game.GameDisplay:

GetGameGraphics()

This action returns the GraphicsManager stored by the plugins.

Return

Libraries.Game.Graphics.GraphicsManager:

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.

GetInput()

This action returns a GameInput object that is stored in the plugins.

Return

Libraries.Game.GameInput:

GetNativePath()

This action returns the path of the native file loaded by the engine.

Return

text:

GetOperatingSystem()

This action returns a text flag indicating what operating system the game is running on.

Return

text:

SetAccessibilityManager(Libraries.Interface.AccessibilityManager accessibility)

Parameters

SetApplication(Libraries.Game.Application app)

This action is used by the engine to set the game's application info in the plugins.

Parameters

SetFocus(Libraries.Interface.Item item)

This action sets the focus on the given item.

Parameters

SetFocusManager(Libraries.Game.FocusManager manager)

This action sets the FocusManager to be used across the Game.

Parameters

SetGame(Libraries.Game.Game game)

This action is used by the engine to store a reference to the currently running Game class.

Parameters

SetGameDisplay(Libraries.Game.GameDisplay disp)

This action is used by the engine to set the game's display info in the plugins.

Parameters

SetGameGraphics(Libraries.Game.Graphics.GraphicsManager gl20)

This action is used by the engine to set the game's graphics manager in the plugins.

Parameters

SetInput(Libraries.Game.GameInput gameInput)

This action sets a GameInput object to be stored in the plugins.

Parameters

SetNativePath(text path)

This action sets a path to the native file used to load the engine's C plugins. After setting the path, the engine will load the native file.

Parameters

SetOperatingSystem(text os)

This action sets a flag in the plugins indicating what operating system the game is running on.

Parameters