AppConfigBuilder

data class AppConfigBuilder(config: AppConfig) : Builder<AppConfig>

This builder class can be used to build AppConfig instances. This builder has sensible default values so

See also

Constructors

AppConfigBuilder
Link copied to clipboard
common
fun AppConfigBuilder(config: AppConfig = AppConfig.defaultConfiguration())

Types

Companion
Link copied to clipboard
common
object Companion

Functions

borderless
Link copied to clipboard
common
fun borderless(): AppConfigBuilder
build
Link copied to clipboard
common
open override fun build(): AppConfig
Builds an object of type T.
copy
Link copied to clipboard
common
fun copy(config: AppConfig = AppConfig.defaultConfiguration()): AppConfigBuilder
createCopy
Link copied to clipboard
common
open override fun createCopy(): AppConfigBuilder
Creates a deep copy of this object.
disableBetaFeatures
Link copied to clipboard
common
fun disableBetaFeatures(): AppConfigBuilder
enableBetaFeatures
Link copied to clipboard
common
fun enableBetaFeatures(): AppConfigBuilder
equals
Link copied to clipboard
common
open operator override fun equals(other: Any?): Boolean
fullScreen
Link copied to clipboard
common
fun fullScreen(): AppConfigBuilder
fun fullScreen(screenWidth: Int, screenHeight: Int): AppConfigBuilder
hashCode
Link copied to clipboard
common
open override fun hashCode(): Int
toString
Link copied to clipboard
common
open override fun toString(): String
withBlinkLengthInMilliSeconds
Link copied to clipboard
common
fun withBlinkLengthInMilliSeconds(blinkLengthInMilliSeconds: Long): AppConfigBuilder
Sets the length of a blink.
withBorderless
Link copied to clipboard
common
fun withBorderless(borderless: Boolean = true): AppConfigBuilder
Toggles whether the resulting application will be borderless or not.
withClipboardAvailable
Link copied to clipboard
common
fun withClipboardAvailable(isClipboardAvailable: Boolean): AppConfigBuilder
Enables or disables clipboard.
withCloseBehavior
Link copied to clipboard
common
fun withCloseBehavior(closeBehavior: CloseBehavior): AppConfigBuilder
Sets the close behavior to be used.
withCursorBlinking
Link copied to clipboard
common
fun withCursorBlinking(isCursorBlinking: Boolean): AppConfigBuilder
Sets whether the cursor blinks or not.
withCursorColor
Link copied to clipboard
common
fun withCursorColor(cursorColor: TileColor): AppConfigBuilder
Sets the color of the cursor.
withCursorStyle
Link copied to clipboard
common
fun withCursorStyle(cursorStyle: CursorStyle): AppConfigBuilder
Sets the CursorStyle to be used when there is a cursor displayed.
withDebugConfig
Link copied to clipboard
common
fun withDebugConfig(debugConfig: DebugConfig): AppConfigBuilder
Sets the debugConfig to be used when debugMode is true.
withDebugMode
Link copied to clipboard
common
fun withDebugMode(debugMode: Boolean): AppConfigBuilder
Toggles debug mode on or off.
withDefaultGraphicalTileset
Link copied to clipboard
common
fun withDefaultGraphicalTileset(defaultGraphicalTileset: TilesetResource): AppConfigBuilder
Sets the default graphical tileset to be used.
withDefaultTileset
Link copied to clipboard
common
fun withDefaultTileset(defaultTileset: TilesetResource): AppConfigBuilder
Sets the default tileset to be used.
withFpsLimit
Link copied to clipboard
common
fun withFpsLimit(fpsLimit: Int): AppConfigBuilder
Sets the fps limit for continuous rendering.
withFullScreen
Link copied to clipboard
common
fun withFullScreen(fullScreen: Boolean = true): AppConfigBuilder
Toggles whether the resulting application is full screen or not.
fun withFullScreen(screenWidth: Int, screenHeight: Int): AppConfigBuilder
withIcon
Link copied to clipboard
common
fun withIcon(iconData: ByteArray): AppConfigBuilder
Sets the image that should be used as an application icon as a ByteArray.
fun withIcon(iconPath: String): AppConfigBuilder
Sets the image's resource path that should be used as an application icon.
withShortcutsConfig
Link copied to clipboard
common
fun withShortcutsConfig(shortcutsConfig: ShortcutsConfig): AppConfigBuilder
Sets the shortcutsConfig to use.
withSize
Link copied to clipboard
common
fun withSize(size: Size): AppConfigBuilder
Sets the size the Application.tileGrid will have.
fun withSize(width: Int, height: Int): AppConfigBuilder
Sets the size the Application.tileGrid will have.
withTitle
Link copied to clipboard
common
fun withTitle(title: String): AppConfigBuilder
Sets the application window's title.

Sources

(source)
Link copied to clipboard