Constructor
new Application(optionsopt)
Creates a new application instance.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
options |
Object |
<optional> |
null | Application settings. |
- Source:
Members
(static, readonly) instance :rune.system.Application
Reference to the current application executed by the engine. This is mainly
for internal use.
Type:
- Source:
(static, constant) RID :rune.system.Application
RID (short for Rune-ID) is a version number that represents the most
recent compilation of the source code. A change to the RID does not
necessarily mean a change to the codebase, merely that the code has been
compiled into a new distribution version. Note that this constant only
returns a RID number when a compiled version of the code base is executed,
when executing from source code, "%RID%" is returned.
Type:
- Source:
(readonly) hash :string
A hash string that uniquely identifies the current version of the
application.
Type:
- string
- Source:
(readonly) height :number
This refers to the native height of the application, measured in pixels.
Type:
- number
- Source:
(readonly) highscores :rune.data.Highscores
Used to save local highscores.
Type:
- Source:
(readonly) id :string
A string (according to the reverse domain name system) that uniquely
identifies the application project. Example: "com.vectorpanic.demo".
Type:
- string
- Source:
(readonly) inputs :rune.input.Inputs
The subsystem that handles input devices, such as keyboards, gamepads, etc..
Type:
- Source:
(readonly) resources :rune.resource.Resources
The application's resource library, ie. the location where all loaded
resource files are stored and made available for use within the application.
Type:
- Source:
(readonly) scenens :rune.scene.Scenes
Reference to the subsystem that handles scenes within the application.
Type:
- Source:
(readonly) screen :rune.display.Screen
Represents the application screen, ie. the rectangular surface where
graphics are drawn.
Type:
- Source:
(readonly) sounds :rune.media.Sounds
Sounds is a reference to the application's sound system. Use this reference
to handle sounds within the current application.
Type:
- Source:
(readonly) time :rune.system.Time
Reference to the subsystem that calculates time within the current
application.
Type:
- Source:
(readonly) width :number
This refers to the native width of the application, measured in pixels.
Type:
- number
- Source:
Methods
start(callbackopt) → {undefined}
Starts the current application.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
callback |
function |
<optional> |
null | Refers to a function object that is executed as soon as the start process is completed. The function is thus executed when the application is fully functional. |
- Source:
Returns:
- Type
- undefined
stop(callbackopt) → {undefined}
Stops the current application.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
callback |
function |
<optional> |
null | Refers to a function object that is executed after the application is terminated. |
- Source:
Returns:
- Type
- undefined