Package tools.aqua.bgw.core

Types

Link copied to clipboard
enum Alignment : Enum<Alignment>

Used to define a centering behaviour. Encapsulates VerticalAlignment and HorizontalAlignment.

Link copied to clipboard
data class AspectRatio

Class representing an aspect ratio between the window sides.

Link copied to clipboard
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.

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

Baseclass for BGW game scenes.

Link copied to clipboard
enum HexOrientation : Enum<HexOrientation>

Enumeration class representing the orientation options for hexagonal grids and views.

Link copied to clipboard
enum HorizontalAlignment : Enum<HorizontalAlignment>

Used to define horizontal centering behaviour.

Link copied to clipboard
open class MenuScene(    width: Number = DEFAULT_SCENE_WIDTH,     height: Number = DEFAULT_SCENE_HEIGHT,     background: Visual = ColorVisual.WHITE) : Scene<StaticComponentView<out StaticComponentView<*>>>

Baseclass for BGW menu scenes. Extend this class in order to create your own menu scene.

Link copied to clipboard
enum ScaleMode : Enum<ScaleMode>

Used to define the scaling behaviour of a Scene.

Link copied to clipboard
sealed class Scene<T : ComponentView>

Baseclass for BGW scenes.

Link copied to clipboard
enum VerticalAlignment : Enum<VerticalAlignment>

Used to define vertical centering behaviour.

Link copied to clipboard
enum WindowMode : Enum<WindowMode>

Enum for different window modes.

Properties

Link copied to clipboard
const val DEFAULT_ANIMATION_DURATION: Int = 1000

Default Animation duration in milliseconds.

Link copied to clipboard
const val DEFAULT_ANIMATION_SPEED: Int = 50

Default Animation speed in steps.

Link copied to clipboard
const val DEFAULT_AREA_HEIGHT: Double

Default Area height.

Link copied to clipboard
const val DEFAULT_AREA_WIDTH: Double

Default Area width.

Link copied to clipboard
const val DEFAULT_BLUR_RADIUS: Double = 63.0

Default blur radius for menuScene overlay.

Link copied to clipboard
const val DEFAULT_BOARD_HEIGHT: Double = 900.0

Default TableView height.

Link copied to clipboard
const val DEFAULT_BOARD_WIDTH: Double = 1600.0

Default TableView width.

Link copied to clipboard
const val DEFAULT_BUTTON_HEIGHT: Double = 45.0

Default Button height.

Link copied to clipboard
const val DEFAULT_BUTTON_WIDTH: Double = 120.0

Default Button width.

Link copied to clipboard
const val DEFAULT_CARD_HEIGHT: Double = 200.0

Default CardView height.

Link copied to clipboard
const val DEFAULT_CARD_STACK_HEIGHT: Double

Default CardStack height.

Link copied to clipboard
const val DEFAULT_CARD_STACK_WIDTH: Double

Default CardStack width.

Link copied to clipboard
const val DEFAULT_CARD_WIDTH: Double = 130.0

Default CardView width.

Link copied to clipboard
const val DEFAULT_CHECKBOX_HEIGHT: Int = 30

Default CheckBox height.

Link copied to clipboard
const val DEFAULT_CHECKBOX_WIDTH: Int = 120

Default CheckBox width.

Link copied to clipboard
const val DEFAULT_COLOR_PICKER_HEIGHT: Int = 30

Default ColorPicker height.

Link copied to clipboard
const val DEFAULT_COLOR_PICKER_WIDTH: Int = 120

Default ColorPicker width.

Link copied to clipboard
const val DEFAULT_COMBOBOX_HEIGHT: Int = 30

Default ComboBox height.

Link copied to clipboard
const val DEFAULT_COMBOBOX_WIDTH: Int = 120

Default ComboBox width.

Link copied to clipboard
const val DEFAULT_DICE_HEIGHT: Double = 80.0

Default DiceView height.

Link copied to clipboard
const val DEFAULT_DICE_WIDTH: Double = 80.0

Default DiceView width.

Link copied to clipboard
const val DEFAULT_FADE_TIME: Int = 250

The default fade time for MenuScenes in BoardGameApplication.showMenuScene or BoardGameApplication.hideMenuScene in milliseconds.

Link copied to clipboard
const val DEFAULT_FONT_SIZE: Double = 14.0

Default Font size.

Link copied to clipboard
const val DEFAULT_GRID_SPACING: Double = 0.0

Default GridPane spacing.

Link copied to clipboard
const val DEFAULT_HEXAGON_SIZE: Double = 100.0

Default DEFAULT_HEXAGON_SIZE size.

Link copied to clipboard
const val DEFAULT_LABEL_HEIGHT: Double = 30.0

Default Label height.

Link copied to clipboard
const val DEFAULT_LABEL_WIDTH: Double = 120.0

Default Label width.

Link copied to clipboard
const val DEFAULT_LINEAR_LAYOUT_HEIGHT: Double

Default LinearLayout height.

Link copied to clipboard
const val DEFAULT_LINEAR_LAYOUT_SPACING: Double = 0.0

Default LinearLayout spacing.

Link copied to clipboard
const val DEFAULT_LINEAR_LAYOUT_WIDTH: Double

Default LinearLayout width.

Link copied to clipboard
const val DEFAULT_LIST_VIEW_HEIGHT: Int = 400

Default ListView width.

Link copied to clipboard
const val DEFAULT_LIST_VIEW_WIDTH: Int = 200

Default ListView width.

Link copied to clipboard
const val DEFAULT_MENU_SCENE_OPACITY: Double = 0.75

Default menu scene opacity.

Link copied to clipboard
const val DEFAULT_PROGRESSBAR_HEIGHT: Int = 20

Default ProgressBar height.

Link copied to clipboard
const val DEFAULT_PROGRESSBAR_WIDTH: Int = 250

Default ProgressBar width.

Link copied to clipboard
const val DEFAULT_RADIO_BUTTON_HEIGHT: Double

Default RadioButton height.

Link copied to clipboard
const val DEFAULT_RADIO_BUTTON_WIDTH: Double

Default RadioButton width.

Link copied to clipboard
const val DEFAULT_SATCHEL_HEIGHT: Double

Default Satchel height.

Link copied to clipboard
const val DEFAULT_SATCHEL_WIDTH: Double

Default Satchel width.

Link copied to clipboard
const val DEFAULT_SCENE_HEIGHT: Double = 1080.0

Default scene height in virtual pixels.

Link copied to clipboard
const val DEFAULT_SCENE_WIDTH: Double = 1920.0

Default scene width in virtual pixels.

Link copied to clipboard
const val DEFAULT_TABLE_VIEW_HEIGHT: Double = 500.0

Default TableView height.

Link copied to clipboard
const val DEFAULT_TABLE_VIEW_WIDTH: Double = 400.0

Default TableView width.

Link copied to clipboard
const val DEFAULT_TEXT_AREA_HEIGHT: Double = 100.0

Default TextArea height.

Link copied to clipboard
const val DEFAULT_TEXT_AREA_WIDTH: Double = 200.0

Default TextArea width.

Link copied to clipboard
const val DEFAULT_TEXT_FIELD_HEIGHT: Double = 30.0

Default TextField height.

Link copied to clipboard
const val DEFAULT_TEXT_FIELD_WIDTH: Double = 140.0

Default TextField width.

Link copied to clipboard
const val DEFAULT_TOGGLE_BUTTON_HEIGHT: Double

Default ToggleButton height.

Link copied to clipboard
const val DEFAULT_TOGGLE_BUTTON_WIDTH: Double

Default ToggleButton width.

Link copied to clipboard
const val DEFAULT_TOKEN_HEIGHT: Double = 50.0

Default TokenView height.

Link copied to clipboard
const val DEFAULT_TOKEN_WIDTH: Double = 50.0

Default TokenView width.

Link copied to clipboard
const val DEFAULT_WINDOW_BORDER: Double = 0.8

Default minimization factor of window.

Link copied to clipboard
const val DEFAULT_WINDOW_HEIGHT: Double = 747.0

Default window height in non-maximized mode.

Link copied to clipboard
const val DEFAULT_WINDOW_TITLE: String

Default window title.

Link copied to clipboard
const val DEFAULT_WINDOW_WIDTH: Double = 1280.0

Default window width in non-maximized mode.