rebar/io.github.pylonmc.rebar.block.base/RebarSimpleMultiblock

RebarSimpleMultiblock

interface RebarSimpleMultiblock : RebarMultiblock, RebarEntityHolderBlock, RebarEntityCulledBlock(source)

A multiblock that is made of a predefined set of components.

Automatically creates ghost blocks to show how to build your multiblock.

Automatically handles different possible rotations of your multiblock.

If you need something more flexible (eg: a fluid tank that can have up to 10 fluid casings added to increase the capacity), see RebarMultiblock.

Types

MixedMultiblockComponent

class MixedMultiblockComponent : RebarSimpleMultiblock.MultiblockComponent, RebarSimpleMultiblock.MultipleGhostBlocks

Displays all kind of MultiblockComponents that implement MultiblockComponentBlockDisplay, together with special item handling for RebarMultiblockComponent

MultiblockComponent

interface MultiblockComponent

Represents a single block of a multiblock.

MultiblockComponentBlockDisplay

interface MultiblockComponentBlockDisplay

MultiblockGhostBlock

class MultiblockGhostBlock(entity: Display, val displayName: Component) : RebarEntity<Display>

A block display that represents this block, showing the player what block needs to be placed in a specific location.

MultipleGhostBlocks

interface MultipleGhostBlocks

Implement this together with MultiblockComponent, it is used to spawn multiple entities to display the needs of a single multiblock requirement, you are going to need this only when you can't display a block requirement with only a single ItemDisplay or BlockDisplay

RebarMultiblockComponent

@JvmRecord

data class RebarMultiblockComponent(val key: NamespacedKey) : Record, RebarSimpleMultiblock.SingleGhostBlock, RebarSimpleMultiblock.MultiblockComponent

Represents a Rebar block component of a multiblock.

SingleGhostBlock

interface SingleGhostBlock

Implement this together with MultiblockComponent, it is used to spawn a single entity to display the needs of a single multiblock requirement

VanillaBlockdataMultiblockComponent

@JvmRecord

data class VanillaBlockdataMultiblockComponent(val blockDatas: List<BlockData>) : Record, RebarSimpleMultiblock.SingleGhostBlock, RebarSimpleMultiblock.MultiblockComponent, RebarSimpleMultiblock.MultiblockComponentBlockDisplay

Represents a vanilla component of a multiblock, which can have one or more blockdatas.

VanillaMultiblockComponent

@JvmRecord

data class VanillaMultiblockComponent(val materials: List<Material>) : Record, RebarSimpleMultiblock.SingleGhostBlock, RebarSimpleMultiblock.MultiblockComponent, RebarSimpleMultiblock.MultiblockComponentBlockDisplay

Represents a vanilla component of a multiblock, which can have one or more materials.

Properties

block

abstract val block: Block

chunksOccupied

open override val chunksOccupied: Set<ChunkPosition>

All chunks containing at least one component of the multiblock

components

abstract val components: Map<Vector3i, RebarSimpleMultiblock.MultiblockComponent>

The positions and corresponding components of the multiblock.

culledEntityIds

open override val culledEntityIds: Iterable<UUID>

Any entity id's that should be culled when the block is considered culled by the BlockTextureEngine. The default implementation of onVisible and onCulled assumes that these are real entities When using real entities you cannot include entities in this list that are invisible by default, if you do they will not be culled properly.

heldEntities

@get:ApiStatus.NonExtendable

open val heldEntities: MutableMap<String, UUID>

horizontalRadius

open val horizontalRadius: <Error class: unknown class>

Imagine the smallest square containing the multiblock; this is the radius of that square.

isCulledAsync

open override val isCulledAsync: Boolean

If the entities should be shown/hidden asynchronously instead of scheduled to be shown/hidden on the main thread. By default, this is false and the entities will be shown/hidden on the main thread because they are real entities.

maxCorner

open val maxCorner: Vector3i

Imagine the smallest cuboid (with equal width and length) containing the multiblock; this is the corner with the highest X, Y, and Z coordinates.

minCorner

open val minCorner: Vector3i

Imagine the smallest cuboid (with equal width and length) containing the multiblock; this is the corner with the lowest X, Y, and Z coordinates.

Functions

addEntity

open fun addEntity(name: String, entity: RebarEntity<*>)

open fun addEntity(name: String, entity: Entity)

areAllHeldEntitiesLoaded

@ApiStatus.NonExtendable

open fun areAllHeldEntitiesLoaded(): <Error class: unknown class>

Returns false if any entity is unloaded or does not exist.

checkFormed

open override fun checkFormed(): Boolean

Warning: You should not call this yourself. If you want to know if the multiblock is formed, use isFormedAndFullyLoaded(), which will read from a cache, so is much faster.

getHeldEntity

@ApiStatus.NonExtendable

open fun getHeldEntity(name: String): Entity?

@ApiStatus.NonExtendable

open fun <T : Entity> getHeldEntity(clazz: Class<T>, name: String): T?

getHeldEntityOrThrow

@ApiStatus.NonExtendable

open fun getHeldEntityOrThrow(name: String): Entity

@ApiStatus.NonExtendable

open fun <T : Entity> getHeldEntityOrThrow(clazz: Class<T>, name: String): T

getHeldEntityUuid

@ApiStatus.NonExtendable

open fun getHeldEntityUuid(name: String): UUID?

getHeldEntityUuidOrThrow

@ApiStatus.NonExtendable

open fun getHeldEntityUuidOrThrow(name: String): UUID

getHeldRebarEntity

@ApiStatus.NonExtendable

open fun <T : RebarEntity<*>> getHeldRebarEntity(clazz: Class<T>, name: String): T?

getHeldRebarEntityOrThrow

@ApiStatus.NonExtendable

open fun <T : RebarEntity<*>> getHeldRebarEntityOrThrow(clazz: Class<T>, name: String): T

getMultiblockBlock

open fun getMultiblockBlock(position: Vector3i): Block

getMultiblockComponent

open fun getMultiblockComponent(position: Vector3i): RebarBlock?

open fun <T> getMultiblockComponent(clazz: Class<T>, position: Vector3i): T?

getMultiblockComponentOrThrow

open fun getMultiblockComponentOrThrow(position: Vector3i): RebarBlock

open fun <T> getMultiblockComponentOrThrow(clazz: Class<T>, position: Vector3i): T

getMultiblockDirection

open fun getMultiblockDirection(): BlockFace?

The 'direction' we expect the multiblock to be built in. This is not the actual direction that the multiblock has been built in.

getWaila

abstract fun getWaila(player: Player): WailaDisplay?

Automatically implemented by RebarBlock

isFormedAndFullyLoaded

open fun isFormedAndFullyLoaded(): Boolean

Returns true if every component of the multiblock is loaded AND the multiblock is formed. Reads from a cache, so call as often as you want.

isHeldEntityPresent

@ApiStatus.NonExtendable

open fun isHeldEntityPresent(name: String): Boolean

Returns false if the block holds no entity with the provided name, the entity is unloaded or does not physically exist.

isPartOfMultiblock

open override fun isPartOfMultiblock(otherBlock: Block): Boolean

Should return true if there is any scenario in which this block's position could be part of a formed multiblock.

isVisible

open override fun isVisible(player: Player): Boolean

If the block is currently visible to the player. By default, this checks that the first entity from culledEntityIds is not toggled invisible for the player If you are using fake/packet entities you must override this method.

onCulled

open override fun onCulled(player: Player)

Hides all entities in culledEntityIds currently visible to the player. By default, this assumes that all entities in culledEntityIds are real entities, if they are not you must override this method.

onMultiblockFormed

@MustBeInvokedByOverriders

open override fun onMultiblockFormed()

Called when the multiblock is formed (i.e., was not formed before, but now is). This includes when the multiblock was previously formed, unloaded, and loaded again.

onMultiblockRefreshed

open fun onMultiblockRefreshed()

Called when the multiblock is refreshed (i.e., was formed before, and still is). This happens when something causes the Multiblock to re-check if it is formed, and it still is.

onMultiblockUnformed

@MustBeInvokedByOverriders

open override fun onMultiblockUnformed(partUnloaded: Boolean)

Called when the multiblock is unformed (i.e., was formed before, but now is not). This includes when a part of the multiblock is unloaded and the multiblock becomes unformed because of it, or when part of the multiblock is broken/changed, and it becomes unformed because of it.

onVisible

open override fun onVisible(player: Player)

Reveals all entities in culledEntityIds not currently visible to the player. By default, this assumes that all entities in culledEntityIds are real entities, if they are not you must override this method.

setMultiblockDirection

open fun setMultiblockDirection(direction: BlockFace?)

Sets the 'direction' we expect the multiblock to be built in. North is considered the default facing direction - ie setFacing(BlockFace.NORTH) will preserve the original multiblock structure without rotating it.

tryRemoveAllEntities

open fun tryRemoveAllEntities()

tryRemoveEntity

open fun tryRemoveEntity(name: String)

validStructures

open fun validStructures(): List<Map<Vector3i, RebarSimpleMultiblock.MultiblockComponent>>

Returns all the valid configurations of the multiblock. If any of these is satisfied, the multiblock will be considered complete.

whenHeldRebarEntityLoads

@ApiStatus.NonExtendable

open fun whenHeldRebarEntityLoads(name: String, consumer: Consumer<RebarEntity<*>>)

@ApiStatus.NonExtendable

open fun <T : RebarEntity<*>> whenHeldRebarEntityLoads(clazz: Class<T>, name: String, consumer: Consumer<T>)