bgw-gui/tools.aqua.bgw.core/BoardGameApplication

BoardGameApplication

open class BoardGameApplication( windowTitle: String = DEFAULT_WINDOW_TITLE, aspectRatio: AspectRatio = AspectRatio(), windowMode: WindowMode? = null)

Baseclass for all BGW Applications. Extend from this class in order to create your own game application. You may only instantiate one application.

Scenes get shown by calling showMenuScene and showGameScene. Application starts by calling show.

Parameters

windowTitle

Title for the application window. Gets displayed in the title bar. Default: DEFAULT_WINDOW_TITLE.

aspectRatio

Initial aspect ratio of application window. Default: empty AspectRatio constructor.

windowMode

Initial window mode. Overrides isMaximized and isFullScreen if passed. Refer to WindowMode docs for further information about the effects.

Constructors

BoardGameApplication

fun BoardGameApplication( windowTitle: String = DEFAULT_WINDOW_TITLE, width: Number = DEFAULT_WINDOW_WIDTH, height: Number = DEFAULT_WINDOW_HEIGHT, windowMode: WindowMode? = null)

Creates the BoardGameApplication with optional title and dimension. May only be called once per execution.

BoardGameApplication

fun BoardGameApplication( windowTitle: String = DEFAULT_WINDOW_TITLE, aspectRatio: AspectRatio = AspectRatio(), windowMode: WindowMode? = null)

Creates the BoardGameApplication with optional title and aspect ratio. May only be called once per execution.

Types

Companion

object Companion

Functions

exit

fun exit()

Returns the show function, thus closing the application window.

hideMenuScene

fun hideMenuScene(fadeTime: Number = DEFAULT_FADE_TIME)

Hides currently shown MenuScene. Activates BoardGameScene if present.

repaint

fun repaint()

Manually refreshes currently displayed Scenes.

setHorizontalSceneAlignment

fun setHorizontalSceneAlignment(newHorizontalAlignment: HorizontalAlignment)

Sets HorizontalAlignment of all Scenes in this BoardGameApplication.

setScaleMode

fun setScaleMode(newScaleMode: ScaleMode)

Sets ScaleMode of all Scenes in this BoardGameApplication.

setSceneAlignment

fun setSceneAlignment(newAlignment: Alignment)

Sets Alignment of all Scenes in this BoardGameApplication.

setVerticalSceneAlignment

fun setVerticalSceneAlignment(newVerticalAlignment: VerticalAlignment)

Sets VerticalAlignment of all Scenes in this BoardGameApplication.

show

fun show()

Shows the BoardGameApplication.

showDialog

fun showDialog(dialog: Dialog): Optional<ButtonType>

Shows a dialog and blocks further thread execution.

showDialogNonBlocking

fun showDialogNonBlocking(dialog: Dialog)

Shows a dialog without blocking further thread execution.

showFileDialog

fun showFileDialog(dialog: FileDialog): Optional<List<File>>

Shows the given FileDialog.

showGameScene

fun showGameScene(scene: BoardGameScene)

Shows given BoardGameScene.

showMenuScene

fun showMenuScene(scene: MenuScene, fadeTime: Number = DEFAULT_FADE_TIME)

Shows given MenuScene. If BoardGameScene is currently displayed, it gets deactivated and blurred.

Properties

background

var background: Visual

Background Visual for the BoardGameApplication.

fullscreenExitCombination

var fullscreenExitCombination: KeyEvent?

Specifies the KeyCombination that will allow the user to exit full screen mode. A value of 'null' will not match any KeyEvent and will make it so the user is not able to escape from fullscreen mode.

fullscreenExitCombinationHint

var fullscreenExitCombinationHint: String?

Specifies the KeyCombination hint that will be shown upon entering fullscreen mode. Hint will only be shown if an exit combination other than 'null' has been set.

icon

var icon: ImageVisual?

Window icon displayed in the title and task bar.

isFullScreen

var isFullScreen: Boolean

Sets this BoardGameApplication's fullscreen mode. true for fullscreen mode, false for default window.

isMaximized

var isMaximized: Boolean

Sets this BoardGameApplication's maximized mode.

onWindowClosed