Class: Config

rune.system.Config(optionsopt)

The Config class contains global settings for an application. The settings are used primarily during start-up to give the application the right conditions; resolution, image refresh rate, etc.

Constructor

new Config(optionsopt)

Creates a new configuration object. The options argument is used to override default settings.
Parameters:
Name Type Attributes Default Description
options Object <optional>
null Application settings.
Source:

Members

app :string

The bundle name of the application. The name must correspond to the root object of the application.
Type:
  • string
Source:

build :string

The build ID is used to identify a particular version, build or state of the application. Suggestedly, semantic versioning is used to design a build ID.
Type:
  • string
Default Value:
  • 0.0.0
Source:

debug :boolean

Whether to execute the application in debug mode (true), or not (false).
Type:
  • boolean
Default Value:
  • false
Source:

developer :string

The Developer ID is used to uniquely identify the developer/origin of the application. The ID is designed according to the Reverse Domain Name System (R-DNS), as follows: extension.name. Example: "com.vectorpanic".
Type:
  • string
Source:

framerate :number

Requested frame rate for the application.
Type:
  • number
Default Value:
  • 60
Source:

loader :function

Refers to the Scene to be used to load the application's resources.
Type:
  • function
Default Value:
  • null
Source:

numHighscores :number

The number of places on the highscore list.
Type:
  • number
Default Value:
  • 5
Source:

numHighscoreTables :number

The number of highscore lists that the application should allocate.
Type:
  • number
Default Value:
  • 1
Source:

resources :function

A Requests object containing a list of the resources to be included in the application.
Type:
  • function
Source:

scene :function

Reference to the scene class to be used after the start-up process is completed. This class thus constitutes the starting point for the current application.
Type:
  • function
Default Value:
  • rune.scene.Scene
Source:

screenResolutionX :number

The native pixel width of the application.
Type:
  • number
Default Value:
  • 384
Source:

screenResolutionY :number

The native pixel height of the application.
Type:
  • number
Default Value:
  • 216
Source:

useGamepads :boolean

If the application is to be started with support for gamepad devices.
Type:
  • boolean
Default Value:
  • false
Source:

useKeyboard :boolean

If the application is to be started with keyboard input support.
Type:
  • boolean
Default Value:
  • false
Source: