Libraries.Game.AndroidDisplay Documentation

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

Summary

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns a CompareResult.
Destroy()This action closes the window.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetConfiguration()This action returns the AndroidConfiguration being used by this AndroidDisplay.
GetHashCode()This action gets the hash code for an object.
GetHeight()This action returns the height of the AndroidDisplay.
GetPixelScaleFactor()This action returns the ratio between screen coordinates and pixels.
GetResize()This action returns whether the AndroidDisplay is resizable or not.
GetSecondsBetweenFrames()This action tests how many seconds have passed since the last time that the time was updated.
GetWidth()This action returns the width of the AndroidDisplay.
RequestRendering()This action tells the AndroidDisplay to render to the screen.
SetConfiguration(Libraries.Game.ApplicationConfiguration conf)This action sets the AndroidConfiguration being used by the game, which includes data for the screen.
SetDisplayMode(integer width, integer height, boolean fullscreen)This action normally sets the width and height of the AndroidDisplay, but games on Android devices always fill the screen, so this does nothing.
SetVSync(boolean vsync)This action sets vSync on or off for the AndroidDisplay.
WasResized()This action returns whether or not the AndroidDisplay has been resized.

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.

Destroy()

This action closes the window.

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.

GetConfiguration()

This action returns the AndroidConfiguration being used by this AndroidDisplay.

Return

Libraries.Game.ApplicationConfiguration:

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.

GetHeight()

This action returns the height of the AndroidDisplay.

Return

integer:

GetPixelScaleFactor()

This action returns the ratio between screen coordinates and pixels.

Return

number:

GetResize()

This action returns whether the AndroidDisplay is resizable or not. This will always return false.

Return

boolean:

GetSecondsBetweenFrames()

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

Return

number:

GetWidth()

This action returns the width of the AndroidDisplay.

Return

integer:

RequestRendering()

This action tells the AndroidDisplay to render to the screen.

SetConfiguration(Libraries.Game.ApplicationConfiguration conf)

This action sets the AndroidConfiguration being used by the game, which includes data for the screen. If the given ApplicationConfiguration is not an AndroidConfiguration, an error will be thrown.

Parameters

SetDisplayMode(integer width, integer height, boolean fullscreen)

This action normally sets the width and height of the AndroidDisplay, but games on Android devices always fill the screen, so this does nothing. The action will return false to indicate that no action was taken.

Parameters

Return

boolean:

SetVSync(boolean vsync)

This action sets vSync on or off for the AndroidDisplay.

Parameters

WasResized()

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

Return

boolean: