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

RebarGhostBlockHolder

interface RebarGhostBlockHolder : RebarEntityHolderBlock(source)

A wrapper over RebarEntityHolderBlock which allows for 'ghost blocks' (like those used to show how to build a multiblock) to be managed. Each ghost block has a relative position and can display vanilla blocks, rebar blocks, or both.

Due to some annoying technicalities, vanilla blocks need to be displayed as a BlockDisplay and Rebar items as an ItemDisplay. So we operate a somewhat cursed system where either a BlockDisplay, ItemDisplay, or both are spawned. In the case where both are spawned, one of the displays is hidden while the other is shown as all the possible states are cycled through.

You can access the individual displays with getVanillaGhostBlockDisplay and getRebarGhostBlockDisplay. Keep in mind that any given position may have none, one, or both displays.

Inheritors

RebarSimpleMultiblock

Types

object Companion : Listener

open class GhostBlock<E : Entity> : RebarEntity<E>

GhostBlockHitbox

class GhostBlockHitbox : RebarEntity<Interaction> , RebarInteractEntity

RebarGhostBlock

class RebarGhostBlock : RebarGhostBlockHolder.GhostBlock<ItemDisplay>

VanillaGhostBlock

class VanillaGhostBlock : RebarGhostBlockHolder.GhostBlock<BlockDisplay>

Properties

abstract val block: Block

@get:ApiStatus.NonExtendable

open val heldEntities: MutableMap<String, UUID>

Functions

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

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

open fun addGhostBlock(position: Vector3i, vanillaBlocks: List<BlockData>, rebarBlocks: List<NamespacedKey>)

areAllHeldEntitiesLoaded

@ApiStatus.NonExtendable

open fun areAllHeldEntitiesLoaded(): Boolean

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

getGhostBlockHitbox

open fun getGhostBlockHitbox(position: Vector3i): RebarGhostBlockHolder.GhostBlockHitbox?

@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 getHeldRebarEntity(name: String): RebarEntity<*>?

@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

getRebarGhostBlockDisplay

open fun getRebarGhostBlockDisplay(position: Vector3i): RebarGhostBlockHolder.RebarGhostBlock?

getVanillaGhostBlockDisplay

open fun getVanillaGhostBlockDisplay(position: Vector3i): RebarGhostBlockHolder.VanillaGhostBlock?

hasGhostBlockAt

open fun hasGhostBlockAt(position: Vector3i): Boolean

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.

removeGhostBlock

open fun removeGhostBlock(position: Vector3i)

tryRemoveAllEntities

open fun tryRemoveAllEntities()

tryRemoveEntity

open fun tryRemoveEntity(name: String)

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>)