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

RebarCargoBlock

interface RebarCargoBlock : RebarLogisticBlock, RebarEntityHolderBlock(source)

Represents a block that can connect to cargo ducts and use them to interface with other cargo RebarCargoBlocks.

Each face can have one logistic group which cargo ducts connected to that face are allowed to interface with

In your place constructor, you will need to call addCargoLogisticGroup for all the block faces you want to be able to connect cargo ducts to, and also setCargoTransferRate to set the maximum number of items that can be transferred out of this block per cargo tick.

Properties

block

abstract val block: Block

Automatically implemented when this interface is implemented by a io.github.pylonmc.rebar.block.RebarBlock

cargoLogisticGroups

@get:ApiStatus.NonExtendable

open val cargoLogisticGroups: Map<BlockFace, String>

cargoTransferRate

@get:ApiStatus.NonExtendable

@set:ApiStatus.NonExtendable

open var cargoTransferRate: Int

heldEntities

@get:ApiStatus.NonExtendable

open val heldEntities: MutableMap<String, UUID>

Functions

addCargoLogisticGroup

@ApiStatus.NonExtendable

open fun addCargoLogisticGroup(face: BlockFace, group: String)

addEntity

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

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

areAllHeldEntitiesLoaded

@ApiStatus.NonExtendable

open fun areAllHeldEntitiesLoaded(): Boolean

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

createLogisticGroup

open fun createLogisticGroup(groupName: String, group: LogisticGroup)

open fun createLogisticGroup(groupName: String, slotType: LogisticGroupType, vararg slots: LogisticSlot)

open fun createLogisticGroup(groupName: String, slotType: LogisticGroupType, slots: List<LogisticSlot>)

open fun createLogisticGroup(groupName: String, slotType: LogisticGroupType, inventory: VirtualInventory)

getCargoLogisticGroup

@ApiStatus.NonExtendable

open fun getCargoLogisticGroup(face: BlockFace): LogisticGroup?

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

getLogisticGroup

open fun getLogisticGroup(groupName: String): LogisticGroup?

getLogisticGroupOrThrow

open fun getLogisticGroupOrThrow(groupName: String): LogisticGroup

getLogisticGroups

open fun getLogisticGroups(): Map<String, LogisticGroup>

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.

onDuctConnected

open fun onDuctConnected(event: RebarCargoConnectEvent, priority: EventPriority)

onDuctDisconnected

open fun onDuctDisconnected(event: RebarCargoDisconnectEvent, priority: EventPriority)

removeCargoLogisticGroup

@ApiStatus.NonExtendable

open fun removeCargoLogisticGroup(face: BlockFace)

tickCargo

open fun tickCargo()

tickCargoFace

open fun tickCargoFace(sourceGroup: LogisticGroup, targetGroup: LogisticGroup)

tryRemoveAllEntities

open fun tryRemoveAllEntities()

tryRemoveEntity

open fun tryRemoveEntity(name: String)

updateDirectlyConnectedFaces

@ApiStatus.NonExtendable

open fun updateDirectlyConnectedFaces()

Checks if the block can connect to any adjacent cargo blocks, and if so, creates a duct display between this block and the adjacent cargo block in question.

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