rebar/io.github.pylonmc.rebar.content.fluid/FluidSectionMarker

FluidSectionMarker

class FluidSectionMarker : RebarBlock, RebarBreakHandler, RebarEntityHolderBlock, RebarFacadeBlock(source)

An invisible block (structure block) that exists purely to represent a pipe and prevent blocks from being placed on top of them. TODO: io.github.pylonmc.rebar.block.base.RebarEntityGroupCulledBlock

Constructors

FluidSectionMarker

constructor(block: Block, context: BlockCreateContext)

constructor(block: Block, pdc: PersistentDataContainer)

Types

Companion

object Companion

Properties

block

val block: Block

blockTextureEntity

open val blockTextureEntity: BlockTextureEntity?

A packet based ItemDisplay sent to players who have customBlockTextures enabled.

defaultItem

val defaultItem: <Error class: unknown class>

defaultWailaTranslationKey

val defaultWailaTranslationKey: TranslatableComponent

disableBlockTextureEntity

open override var disableBlockTextureEntity: Boolean

Set this to true if your block should not have a blockTextureEntity for custom models/textures.

facadeDefaultBlockType

open override val facadeDefaultBlockType: Material

heldEntities

@get:ApiStatus.NonExtendable

open val heldEntities: MutableMap<String, UUID>

key

val key: NamespacedKey

loreTranslationKey

val loreTranslationKey: TranslatableComponent

nameTranslationKey

val nameTranslationKey: TranslatableComponent

pipe

val pipe: <Error class: unknown class>?

pipeDisplay

val pipeDisplay: <Error class: unknown class>

schema

val schema: RebarBlockSchema

All the data needed to create or load the block.

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.

getBlockTextureItem

open fun getBlockTextureItem(): <Error class: unknown class>?

Returns the item that should be used to display the block's texture.

getBlockTextureProperties

open fun getBlockTextureProperties(): MutableMap<String, Pair<String, Int>>

Returns a map of custom block state properties to be used for the block texture item. These properties will be merged with the vanilla block state properties of the block.

getDropItem

open override fun getDropItem(context: BlockBreakContext): Nothing?

Returns the item that the block should drop.

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

getPickItem

open override fun getPickItem(): <Error class: unknown class>

Returns the item that should be given when the block is middle clicked.

getSettings

fun getSettings(): Config

Returns settings associated with the block.

getWaila

open override fun getWaila(player: Player): WailaDisplay?

WAILA is the text that shows up when looking at a block to tell you what the block is.

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.

onBreak

open override fun onBreak(drops: MutableList<ItemStack>, context: BlockBreakContext)

In the case of a vanilla BlockBreakEvent this is called during the monitor priority

onInteract

open override fun onInteract(event: PlayerInteractEvent, priority: EventPriority)

This may be called for both hands, so make sure you check which hand is used.

postBreak

open fun postBreak(context: BlockBreakContext)

In the case of a vanilla BlockBreakEvent this is called during the monitor priority

postInitialise

open fun postInitialise()

Called after both the create constructor and the load constructor.

preBreak

open fun preBreak(context: BlockBreakContext): Boolean

Called before the block is broken. Note this is not called for Deletions as those are not cancellable.

refreshBlockTextureItem

fun refreshBlockTextureItem()

Call this method to refresh the block texture entity's item to be the result of getBlockTextureItem, or a barrier if that returns null.

scheduleBlockTextureItemRefresh

fun scheduleBlockTextureItemRefresh()

Schedules the block texture item to be refreshed on the next server tick. See refreshBlockTextureItem.

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

write

open fun write(pdc: PersistentDataContainer)

Called when the block is saved.

writeDebugInfo

open fun writeDebugInfo(pdc: PersistentDataContainer)

Called when debug info is requested for the block by someone using the DebugWaxedWeatheredCutCopperStairs. If there is any transient data that can be useful for debugging, you're encouraged to serialize it here.