Libraries.Game.IOSDisplay 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 ApplicationConfiguration being used by the IOSDisplay.
GetHashCode()This action gets the hash code for an object.
GetHeight()This action returns the height of the GameDisplay.
GetPixelScaleFactor()This action returns the ratio between screen coordinates and pixels.
GetResize()This action returns whether the GameDisplay 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 GameDisplay.
RequestRendering()This action tells the GameDisplay to render to the screen.
SetConfiguration(Libraries.Game.ApplicationConfiguration conf)This action sets the ApplicationConfiguration being used by the game, which includes data for the screen.
SetDisplayMode(integer width, integer height, boolean fullscreen)This action does nothing on iOS platforms due to limitations of the platform.
SetVSync(boolean vsync)This action sets vSync on or off for the GameDisplay.
WasResized()This action returns whether or not the GameDisplay 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 ApplicationConfiguration being used by the IOSDisplay.

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

Return

integer:

GetPixelScaleFactor()

This action returns the ratio between screen coordinates and pixels.

Return

number:

GetResize()

This action returns whether the GameDisplay is resizable or not. On iOS, this always returns 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 GameDisplay.

Return

integer:

RequestRendering()

This action tells the GameDisplay to render to the screen.

SetConfiguration(Libraries.Game.ApplicationConfiguration conf)

This action sets the ApplicationConfiguration being used by the game, which includes data for the screen. The given parameter must be an IOSConfiguration, or otherwise an error will be thrown.

Parameters

SetDisplayMode(integer width, integer height, boolean fullscreen)

This action does nothing on iOS platforms due to limitations of the platform. Because of this, the action always returns false to indicate that the action was unsuccessful for this platform.

Parameters

Return

boolean:

SetVSync(boolean vsync)

This action sets vSync on or off for the GameDisplay. Due to the nature of the iOS platform, this action does nothing.

Parameters

WasResized()

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

Return

boolean: