pylon-core/io.github.pylonmc.pylon.core.content.fluid/FluidPipe

FluidPipe

open class FluidPipe(val stack: ItemStack) : PylonItem, PylonItemEntityInteractor, PylonInteractor(source)

An item that represents a fluid pipe. All the logic regarding placing the pipe is handled automatically.

Expects the pipe's config to contain a material, a fluid-per-second, and optionally a allowed-temperatures value. If allowed-temperatures is not set, any fluid will be allowed through. To override this behaviour, override canPass.

You should generally not need to extend this class. Instead, simply register an item with class FluidPipe.class to create a new pipe type.

Constructors

FluidPipe

constructor(stack: ItemStack)

Properties

addon

val addon: PylonAddon

allowedTemperatures

val allowedTemperatures: List<FluidTemperature>?

fluidPerSecond

val fluidPerSecond: Double

isDisabled

val isDisabled: Boolean

material

val material: Material

pylonBlock

val pylonBlock: NamespacedKey?

research

val research: Research?

researchBypassPermission

val researchBypassPermission: String

respectCooldown

@get:JvmName(name = "respectCooldown")

open val respectCooldown: Boolean

schema

val schema: PylonItemSchema

Additional data about the item's type.

stack

val stack: ItemStack

Functions

canPass

open fun canPass(fluid: PylonFluid): Boolean

Returns whether the pipe is capable of moving the given fluid through it.

equals

open operator override fun equals(other: Any?): Boolean

getKey

open override fun getKey(): NamespacedKey

getPlaceholders

open override fun getPlaceholders(): List<PylonArgument>

Returns the list of placeholders to be substituted into the item's lore.

getSettings

fun getSettings(): Config

Returns settings associated with the item.

hashCode

open override fun hashCode(): Int

key

open override fun key(): @NotNull Key

onUsedToRightClick

open override fun onUsedToRightClick(event: PlayerInteractEvent)

Called when a player right clicks with the item in either main or off hand.

onUsedToRightClickEntity

open override fun onUsedToRightClickEntity(event: PlayerInteractEntityEvent)

Called when a player right clicks an entity while holding the item.

place

open fun place(context: BlockCreateContext): PylonBlock?

Places the block associated with this item, if it exists.