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

Package-level declarations

Observable lists and properties which are used by GUI elements to handle non-static content

Types

abstract class AbstractGuiList<T, out L : List<T>>(collection: L)

Parent class of the immutable GuiList and mutable GuiMutableList.

class GuiList<T>(collection: List<T>) : AbstractGuiList<T, List<T>>

Wraps a normal list into a format which can be used by specific gui components - the most prominent one being net.silkmc.silk.igui.GuiCompound. This gui list is immutable.

GuiMutableList

class GuiMutableList<T>(collection: MutableList<T>) : AbstractGuiList<T, MutableList<T>>

Does the same as GuiList, but is mutatable. If you change the content if this list using the mutate function, the gui will update accordingly.

GuiProperty

class GuiProperty<T>(value: T)

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.

Functions

asGuiList

fun <T> List<T>.asGuiList(): GuiList<T>

Wraps this list in a GuiList. This list is immutable and therefore static in the gui.

asMutableGuiList

fun <T> MutableList<T>.asMutableGuiList(): GuiMutableList<T>

Wraps this list in a GuiMutableList, which informs gui components about any content updates.

toGuiList

fun <T> Iterable<T>.toGuiList(): GuiList<T>

Creates a new GuiList out of the content of this iterable. This list is immutable and therefore static in the gui.

toMutableGuiList

fun <T> Iterable<T>.toMutableGuiList(): GuiMutableList<T>

Creates a new GuiMutableList, which informs gui components about any content updates, out of the content of this iterable.