1.21.9/llc.redstone.systemsapi.api/Layout

Layout

interface Layout

Represents a saved inventory layout within Housing.

Implementations perform sequential behavior and therefore expose suspend functions for better interaction with Housing.

Inheritors

LayoutImporter

Properties

name

abstract var name: String

The name of this layout. This technically does not need to be unique but having multiple layouts with the same name will mess with the API's ability to act on a specific layout, as the name is our only identifier.

Functions

delete

abstract suspend fun delete()

Deletes this layout.

getBoots

abstract suspend fun getBoots(): ItemStack?

Returns the item stored in the boots slot for this layout, or null if empty.

getChestplate

abstract suspend fun getChestplate(): ItemStack?

Returns the item stored in the chestplate slot for this layout, or null if empty.

getHelmet

abstract suspend fun getHelmet(): ItemStack?

Returns the item stored in the helmet slot for this layout, or null if empty.

getHotbar

abstract suspend fun getHotbar(): Array<ItemStack>

Returns the hotbar contents as an array of items.

getInventory

abstract suspend fun getInventory(): Array<ItemStack>

Returns the full inventory contents as an array of items.

getLeggings

abstract suspend fun getLeggings(): ItemStack?

Returns the item stored in the leggings slot for this layout, or null if empty.

getName

open suspend fun getName(): String

Returns the current name of this layout.

setBoots

abstract suspend fun setBoots(stack: ItemStack): Layout

Sets the boots item for this layout.

setChestplate

abstract suspend fun setChestplate(stack: ItemStack): Layout

Sets the chestplate item for this layout.

setHelmet

abstract suspend fun setHelmet(stack: ItemStack): Layout

Sets the helmet item for this layout.

setHotbar

abstract suspend fun setHotbar(stacks: Array<ItemStack>): Layout

Sets the hotbar contents for this layout.

setInventory

abstract suspend fun setInventory(stacks: Array<ItemStack>): Layout

Sets the full inventory contents for this layout.

setLeggings

abstract suspend fun setLeggings(stack: ItemStack): Layout

Sets the leggings item for this layout.