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

BoardGameScene

open class BoardGameScene( width: Number = DEFAULT_SCENE_WIDTH, height: Number = DEFAULT_SCENE_HEIGHT, background: Visual = ColorVisual.WHITE) : Scene<ComponentView>

Baseclass for BGW game scenes.

Extend this class in order to create your own game scene.

Parameters

width

Scene in virtual coordinates. Default: DEFAULT_SCENE_WIDTH.

height

Scene in virtual coordinates. Default: DEFAULT_SCENE_HEIGHT.

background

BoardGameSceneVisual. Default: ColorVisual.WHITE.

Constructors

BoardGameScene

fun BoardGameScene( width: Number = DEFAULT_SCENE_WIDTH, height: Number = DEFAULT_SCENE_HEIGHT, background: Visual = ColorVisual.WHITE)

Functions

addComponents

fun addComponents(vararg components: ComponentView)

Adds all given ComponentViews to the root node and rootComponents list.

clearComponents

fun clearComponents()

Removes all ComponentViews from the root node and rootComponents list.

findPathToChild

fun findPathToChild(node: ComponentView): List<ComponentView>

Searches node recursively through the visual tree and logs path where the node appears as first component and the rootNode as last.

lock

fun lock()

Locks Scene from any user input.

playAnimation

fun playAnimation(animation: Animation)

Plays given Animation.

removeComponents

fun removeComponents(vararg components: ComponentView)

Removes all given ComponentViews from the root node and rootComponents list.

unlock

fun unlock()

Unlocks Scene for user input.

Properties

background

var background: Visual

The background Visual of this Scene.

components

val components: List<ComponentView>

Returns all root components that are currently contained in this Scene.

draggedComponent

val draggedComponent: DynamicComponentView?

Currently dragged ComponentView encapsulated in a DragDataObject or null if no DynamicComponentView is currently dragged.

height

val height: Double

The height of this Scene in virtual coordinates.

lockedProperty

val lockedProperty: BooleanProperty

Property that indicates if this BoardGameScene is locked from user input.

onKeyPressed

var onKeyPressed: (KeyEvent) -> Unit?

Gets invoked with a KeyEvent whenever a key is pressed.

onKeyReleased

var onKeyReleased: (KeyEvent) -> Unit?

Gets invoked with a KeyEvent whenever a key is released.

onKeyTyped

var onKeyTyped: (KeyEvent) -> Unit?

Gets invoked with a KeyEvent whenever a Character is typed. Gets invoked after onKeyPressed .

onSceneHid

var onSceneHid: () -> Unit?

Gets invoked with no event whenever a scene is hid.

onSceneShown

var onSceneShown: () -> Unit?

Gets invoked with no event whenever a scene is shown.

opacity

var opacity: Double

Opacity of the background of this Scene.

rootNode

val rootNode: RootComponent<ComponentView>

The root node of this Scene.

width

val width: Double

The width of this Scene in virtual coordinates.