FloppaClient/floppaclient.ui.hud/HudElement

HudElement

abstract class HudElement

Provides functionality for game overlay elements.

Author

Aton

Constructors

fun HudElement(module: Module, xDefault: Int = 0, yDefault: Int = 0, width: Int = 10, height: Int = 10, defaultScale: Double = 1.0)

Sets up a hud Element. This constructor takes care of creating the NumberSettings required to save the position and scale of the hud element to the config.

HudElement

fun HudElement(xHud: NumberSetting, yHud: NumberSetting, width: Int = 10, height: Int = 10, scale: NumberSetting)

It is advised to use the other constructor unless this one is required.

Functions

onOverlay

fun onOverlay(event: RenderGameOverlayEvent.Post)

This will initiate the hud render and translate to the correct position and scale.

renderHud

abstract fun renderHud()

Override this method in your implementations.

renderPreview

fun renderPreview()

Used for moving the hud element. Draws a rectangle in place of the actual element

resetElement

open fun resetElement()

Resets the position of this hud element by setting the value of xSett and ySett to their default.

scroll

open fun scroll(amount: Int)

Handles scroll wheel action for this element. Can be overridden in implementation.

Properties

height

var height: Int

scale

val scale: NumberSetting

width

var width: Int

var x: Int

Use these instead of a direct reference to the NumberSetting

var y: Int

Inheritors