API Docs for:
Show:

GS.GAME Class

GS.GAME contains a few functions to get info about certain game settings like resolution for use in scripts or formula.

Methods

previewResolution

() Object

Returns the game's resolution used to resize disposition view to match game screen size. The resolution is scaled down by 50% if "Original Size Preview" is not set in project preferences. Otherwise it returns the original game screen size.

Returns:

Object:

The game' resolution as { width, height } object.

previewScale

() Number

Returns the scale-factor used by disposition views and other graphical editors to scale down the graphics. The scale-factor is 1.0 if "Original Size Preview" is set in project preferences. Otherwise it is 0.5 so all graphics are scaled down by 50% to make placement easier for large game resolutions.

Returns:

Number:

The scale factor depending on settings.

resolution

() Object

Returns the game's screen size.

Returns:

Object:

The game' screen size as { width, height } object.