silk-igui/net.silkmc.silk.igui.observable/GuiProperty

GuiProperty

A property which can be used to represent mutable state in a gui. You can use the net.silkmc.silk.igui.guiIcon function to specify how the value of this property can be rendered to the gui.

Constructors

GuiProperty

constructor(value: T)

Functions

get

suspend fun get(): T

Gets the current value of the property. This function is thread-safe.

guiIcon

fun <E> GuiProperty<E>.guiIcon(iconGenerator: (E) -> ItemStack): GuiIcon.VariableIcon<E>

Creates a gui icon which automatically updates itself if the value of the property changes.

invokeListeners

fun invokeListeners(): Job

Invokes all listeners, causing all open guis using this list to update.

onChange

fun onChange(block: suspend (T) -> Unit)

Registers a new onChange listener, which will be called if the value of this property is updated.

removeOnChangeListener

fun removeOnChangeListener(block: suspend (T) -> Unit)

Unregisters an already registered onChangeListener.

set

suspend fun set(value: T): Job

Sets the value of this property, this will cause all guis which are currently displaying a net.silkmc.silk.igui.GuiIcon using this property to update. This function is thread-safe.