A set of NetworkNodes that are not connected via networks, but still share data and need to be clustered together, such as the left and right part of a double chest.

menuContainer

lateinit var menuContainer: MenuContainer

The MenuContainer for this TileEntity's gui. May stay uninitialized if the TileEntity has no gui.

owner

var owner: OfflinePlayer?

The OfflinePlayer that placed this TileEntity, may be null if it wasn't placed by a player.

ownerUuid

var ownerUuid: UUID?

The UUID of the Player that placed this TileEntity, may be null if it wasn't placed by a player.

pos

val pos: BlockPos

uuid

val uuid: UUID

The UUID of this TileEntity.

Functions

dropProvider

fun dropProvider(provider: () -> Collection<ItemStack>)

Registers a new drop provider that will be called during TileEntity.getDrops when this TileEntity is destroyed.

getDrops

open fun getDrops(includeSelf: Boolean): List<ItemStack>

Gets a list of ItemStacks to be dropped when this TileEntity is destroyed.

getExp

open fun getExp(): Int

Gets the amount of exp to be dropped when this TileEntity is destroyed.

getViewers

fun getViewers(): List<Player>

Gets a List of all players that this TileEntity is visible for.

handleBreak

open override fun handleBreak(ctx: Context<DefaultContextIntentions.BlockBreak>)

Called when this TileEntity is destroyed.

handleDisable

open override fun handleDisable()

Called when this TileEntity is disabled.

handleDisableTicking

open fun handleDisableTicking()

Called when this TileEntity stops ticking.

handleEnable

open override fun handleEnable()

Called when this TileEntity is enabled.

handleEnableTicking

open fun handleEnableTicking()

Called when this TileEntity starts ticking.

handleNetworkLoaded

open suspend fun handleNetworkLoaded(state: NetworkState)

Called when a NetworkNode is loaded into the state.

handleNetworkUpdate

open suspend fun handleNetworkUpdate(state: NetworkState)

Called when a NetworkNode in one of the six cartesian directions is added, removed, or updated in a way that affects this node.

handlePlace

open override fun handlePlace(ctx: Context<DefaultContextIntentions.BlockPlace>)

Called when this TileEntity is placed.

handleRightClick

open fun handleRightClick(ctx: Context<DefaultContextIntentions.BlockInteract>): Boolean

Handles right-clicking this TileEntity.

handleTick

open fun handleTick()

Called every tick for every TileEntity that is in a loaded chunk.

hasData

fun hasData(key: String): Boolean

Checks whether there is data stored under the given key, regardless of whether it is persistent or not.

removeData

fun removeData(key: String)

Removes the data stored under the given key, regardless of whether it is persistent or not.

retrieveData

inline fun <T> retrieveData(key: String, defaultValue: () -> T): T

Retrieves data from the data Compound of this TileEntity. If it can't find anything under the given key, the result of the defaultValue lambda is returned.

inline fun <T> retrieveData(type: KType, key: String, defaultValue: () -> T): T

Retrieves data of the specified type or invokes the defaultValue lambda if there is no data stored under the given key.

retrieveDataOrNull

inline fun <T> retrieveDataOrNull(key: String): T?

Retrieves data of type T or returns null if there is no data stored under the given key.

fun <T> retrieveDataOrNull(type: KType, key: String): T?

Retrieves data of the specified type or returns null if there is no data stored under the given key.

saveData

open fun saveData()

Called to save all data using the storeData method.

storeData

inline fun <T> storeData(key: String, value: T?, persistent: Boolean = false)

Stores value as the reified type T under the given key.

fun <T> storeData(type: KType, key: String, value: T?, persistent: Boolean = false)

Stores value as the given type under the given key.

storedEnergyHolder

@JvmName(name = "storedEnergyHolderBlockFace")

fun storedEnergyHolder(maxEnergy: Provider<Long>, allowedConnectionType: NetworkConnectionType, blockedFaces: Set<BlockFace> = emptySet(), defaultConnectionConfig: () -> Map<BlockFace, NetworkConnectionType> = { CUBE_FACES.associateWithTo(enumMap()) { allowedConnectionType } }): DefaultEnergyHolder

@JvmName(name = "storedEnergyHolderBlockSide")

fun storedEnergyHolder(maxEnergy: Provider<Long>, allowedConnectionType: NetworkConnectionType, blockedSides: Set<BlockSide>, defaultConnectionConfig: () -> Map<BlockFace, NetworkConnectionType> = { CUBE_FACES.associateWithTo(enumMap()) { allowedConnectionType } }): DefaultEnergyHolder

Retrieves the EnergyHolder previously stored or creates a new one and registers it in the holders map.

storedFluidContainer

fun storedFluidContainer(name: String, allowedTypes: Set<FluidType>, capacity: Provider<Long>, persistent: Boolean = false, updateHandler: () -> Unit? = null): FluidContainer

Retrieves a FluidContainer stored under name or creates an empty new one. The values allowedTypes and capacity are not serialized and will be applied every time. Then registers the specified updateHandler.

storedFluidHolder

@JvmName(name = "storedFluidHolderBlockFace")

fun storedFluidHolder(container: Pair<NetworkedFluidContainer, NetworkConnectionType>, vararg containers: Pair<NetworkedFluidContainer, NetworkConnectionType>, blockedFaces: Set<BlockFace> = emptySet(), defaultContainerConfig: () -> MutableMap<BlockFace, NetworkedFluidContainer> = { CUBE_FACES.associateWithTo(enumMap()) { container.first } }, defaultConnectionConfig: () -> EnumMap<BlockFace, NetworkConnectionType>? = null): DefaultFluidHolder

@JvmName(name = "storedFluidHolderBlockSide")

fun storedFluidHolder(container: Pair<NetworkedFluidContainer, NetworkConnectionType>, vararg containers: Pair<NetworkedFluidContainer, NetworkConnectionType>, blockedSides: Set<BlockSide>, defaultContainerConfig: () -> MutableMap<BlockFace, NetworkedFluidContainer> = { CUBE_FACES.associateWithTo(enumMap()) { container.first } }, defaultConnectionConfig: () -> EnumMap<BlockFace, NetworkConnectionType>? = null): DefaultFluidHolder

Retrieves the FluidHolder previously stored or creates a new one and registers it in the holders map.

storedInventory

fun storedInventory(name: String, size: Int, preUpdateHandler: (ItemPreUpdateEvent) -> Unit? = null, postUpdateHandler: (ItemPostUpdateEvent) -> Unit? = null): VirtualInventory

Retrieves a VirtualInventory stored under name or creates a new one using the specified size. Then registers the specified postUpdateHandler and preUpdateHandler.

fun storedInventory(name: String, size: Int, persistent: Boolean = false, maxStackSizes: IntArray = IntArray(size) { 64 }, preUpdateHandler: (ItemPreUpdateEvent) -> Unit? = null, postUpdateHandler: (ItemPostUpdateEvent) -> Unit? = null): VirtualInventory

Retrieves a VirtualInventory stored under name or creates a new one using the specified size, maxStackSizes and persistent properties. Then registers the specified postUpdateHandler and preUpdateHandler.

storedItemHolder

@JvmName(name = "storedItemHolderBlockFace")

fun storedItemHolder(inventory: Pair<VirtualInventory, NetworkConnectionType>, vararg inventories: Pair<VirtualInventory, NetworkConnectionType>, blockedFaces: Set<BlockFace> = emptySet(), defaultInventoryConfig: () -> Map<BlockFace, VirtualInventory>? = null, defaultConnectionConfig: () -> Map<BlockFace, NetworkConnectionType>? = null): DefaultItemHolder

@JvmName(name = "storedItemHolderBlockSide")

fun storedItemHolder(inventory: Pair<VirtualInventory, NetworkConnectionType>, vararg inventories: Pair<VirtualInventory, NetworkConnectionType>, blockedSides: Set<BlockSide>, defaultInventoryConfig: () -> Map<BlockFace, VirtualInventory>? = null, defaultConnectionConfig: () -> Map<BlockFace, NetworkConnectionType>? = null): DefaultItemHolder

@JvmName(name = "storedItemHolderBlockFace")

fun storedItemHolder(inventory: Pair<NetworkedInventory, NetworkConnectionType>, vararg inventories: Pair<NetworkedInventory, NetworkConnectionType>, mergedInventory: NetworkedInventory? = null, blockedFaces: Set<BlockFace> = emptySet(), defaultInventoryConfig: () -> Map<BlockFace, NetworkedInventory> = { CUBE_FACES.associateWithTo(enumMap()) { inventory.first } }, defaultConnectionConfig: () -> Map<BlockFace, NetworkConnectionType>? = null): DefaultItemHolder

@JvmName(name = "storedItemHolderBlockSide")

fun storedItemHolder(inventory: Pair<NetworkedInventory, NetworkConnectionType>, vararg inventories: Pair<NetworkedInventory, NetworkConnectionType>, mergedInventory: NetworkedInventory? = null, blockedSides: Set<BlockSide>, defaultInventoryConfig: () -> Map<BlockFace, NetworkedInventory> = { CUBE_FACES.associateWithTo(enumMap()) { inventory.first } }, defaultConnectionConfig: () -> Map<BlockFace, NetworkConnectionType>? = null): DefaultItemHolder

Retrieves the ItemHolder previously stored or creates a new one, registers it in the holders map, and adds drop providers for ItemHolder.insertFilters and ItemHolder.extractFilters.

storedRegion

fun storedRegion(name: String, minSize: Provider<Int>, maxSize: Provider<Int>, defaultSize: Int, createRegion: (Int) -> Region): DynamicRegion

Creates a DynamicRegion with the size stored under name or defaultSize if it doesn't exist, using createRegion. The minSize and maxSize properties are not serialized and will be applied every time.

storedValue

inline fun <T : Any> storedValue(key: String, persistent: Boolean = false): MutableProvider<T?>

inline fun <T : Any> storedValue(key: String, noinline defaultValue: () -> T): MutableProvider<T>

inline fun <T : Any> storedValue(key: String, persistent: Boolean, noinline defaultValue: () -> T): MutableProvider<T>

Creates a MutableProvider to which properties can delegate.

toString

open override fun toString(): String

updateBlockState

fun updateBlockState(blockState: NovaBlockState)

Changes the block state of this TileEntity to blockState.