rebar/io.github.pylonmc.rebar.util.gui/ProgressItem

ProgressItem

open class ProgressItem @JvmOverloads constructor(item: Item, countDown: Boolean = true) : AbstractItem(source)

An item that counts down (or up if countDown is true) from a maximum durability, symbolising progress.

For example, this might be used in a custom furnace to show how much burn time is left on the current fuel. In this case, you'd want override setTotalTimeTicks and set it to the the total burn time of the fuel (eg: 80 seconds for coal), and then gradually increase progress as the remaining burn time decreased.

Using any set methods on here will automatically update the item in any windows that contain it.

Parameters

item

The item to be displayed

countDown

If true, the progress bar will be inverted, meaning that 0.0 is full and 1.0 is empty.

Constructors

constructor(item: Item, countDown: Boolean = true)

constructor(builder: ItemStackBuilder, inverse: Boolean = true)

constructor(material: Material, inverse: Boolean = true)

constructor(stack: ItemStack, inverse: Boolean = true)

Types

object Companion

Properties

The item to be displayed

lastDisplayedItem

var lastDisplayedItem: ItemStack

var progress: Double

How far through the totalTime we are, between 0.0 and 1.0

var totalTime: Duration?

The total time of whatever process this item is representing

Functions

open fun addObserver(who: Observer?, what: Int, how: Int)

getItemProvider

open override fun getItemProvider(viewer: Player): ItemProvider

getUpdatePeriod

open fun getUpdatePeriod(what: Int): Int

handleBundleSelect

open fun handleBundleSelect(player: Player?, bundleSlot: Int)

open override fun handleClick(clickType: ClickType, player: Player, click: Click)

open fun notifyWindows()

open fun removeObserver(who: Observer?, what: Int, how: Int)

fun setItem(builder: ItemStackBuilder)

fun setItem(stack: ItemStack)

fun setItem(item: Item)

setRemainingTime

fun setRemainingTime(time: Duration)

Sets how far through the totalTime we are

setRemainingTimeSeconds

fun setRemainingTimeSeconds(seconds: Int)

Sets how far through the totalTime we are

setRemainingTimeTicks

fun setRemainingTimeTicks(ticks: Int)

Sets how far through the totalTime we are

setTotalTimeSeconds

fun setTotalTimeSeconds(seconds: Int?)

setTotalTimeTicks

fun setTotalTimeTicks(ticks: Int?)