pylon-core/io.github.pylonmc.pylon.core.util

Package-level declarations

Types

Represents the blocks that a tool made of some material is allowed to break.

open class Octree<N>(maxDepth: Int = DEFAULT_MAX_DEPTH, maxEntries: Int = DEFAULT_MAX_ENTRIES, bounds: BoundingBox, depth: Int, entryStrategy: (N) -> BoundingBox)

RandomizedSound

data class RandomizedSound(val keys: Collection<Key>, val source: Sound.Source, val volume: Pair<Double, Double>, val pitch: Pair<Double, Double>)

WeightedSet

class WeightedSet<E> @JvmOverloads constructor(innerSet: MutableSet<WeightedSet.Element<E>> = mutableSetOf()) : AbstractMutableSet<WeightedSet.Element<E>>

A set containing elements with associated weights. You can retrieve either a specified subset or a single element randomly, with the probability of each element being chosen proportional to its weight.

Properties

IMMEDIATE_FACES

@JvmField

val IMMEDIATE_FACES: Array<BlockFace>

BlockFace.UP, BlockFace.DOWN, BlockFace.EAST, BlockFace.WEST, BlockFace.SOUTH, BlockFace.NORTH

IMMEDIATE_FACES_WITH_DIAGONALS

@JvmField

val IMMEDIATE_FACES_WITH_DIAGONALS: Array<BlockFace>

Same as IMMEDIATE_FACES but includes diagonal faces, not including the vertical directions.

plainText

val Component.plainText: String

replaceableOrAir

val Block.replaceableOrAir: Boolean

Functions

editData

inline fun <T : Any> ItemStack.editData(type: DataComponentType.Valued<T>, block: (T) -> T): ItemStack

findPylonItemInInventory

fun findPylonItemInInventory(inventory: Inventory, targetItem: PylonItem): Int?

Finds a Pylon item in an inventory. Use this to find Pylon items instead of traditional find methods, because this will compare Pylon IDs.

fromMiniMessage

fun fromMiniMessage(string: String): Component

Small helper function to convert a minimessage string (eg: 'bruh') into a component

getAddon

fun getAddon(key: NamespacedKey): PylonAddon

isCardinalDirection

fun isCardinalDirection(vector: Vector3f): Boolean

fun isCardinalDirection(vector: Vector3i): Boolean

isFakeEvent

fun isFakeEvent(event: Event): Boolean

(Heuristically) checks whether an event is 'fake' (by checking if it has 'Fake' in its name)

isFromAddon

@JvmName(name = "isKeyFromAddon")

fun NamespacedKey.isFromAddon(addon: PylonAddon): Boolean

Checks whether a NamespacedKey is from addon

isPylonAndIsNot

inline fun <T> ItemStack?.isPylonAndIsNot(): Boolean

isPylonSimilar

fun ItemStack?.isPylonSimilar(item2: ItemStack?): Boolean

Compares two Pylon items to check if they have the same Pylon ID. If neither item is a Pylon item, the material will be compared instead.

persistentData

fun <T> persistentData(key: NamespacedKey, type: PersistentDataType<*, T & Any>, default: T): <Error class: unknown class>

Same as persistentData but with a default value that is constant

inline fun <T> persistentData(key: NamespacedKey, type: PersistentDataType<*, T & Any>, crossinline default: () -> T): ReadWriteProperty<PersistentDataHolder, T>

Acts as a property delegate for stuff contained inside a PersistentDataContainer For example:

rotateToPlayerFacing

fun rotateToPlayerFacing(player: Player, face: BlockFace, allowVertical: Boolean): BlockFace

Rotates a BlockFace to the player's reference frame.

rotateVectorToFace

fun rotateVectorToFace(vector: Vector3i, face: BlockFace): Vector3i

Rotates vector to face a direction

setNullable

fun <P, C> PersistentDataContainer.setNullable(key: NamespacedKey, type: PersistentDataType<P, C>, value: C?)

Wrapper around PersistentDataContainer.set that allows nullable values to be passed

vanillaDisplayName

fun ItemStack.vanillaDisplayName(): Component

vectorToBlockFace

fun vectorToBlockFace(vector: Vector): BlockFace

fun vectorToBlockFace(vector: Vector3f): BlockFace

fun vectorToBlockFace(vector: Vector3i): BlockFace

Converts an orthogonal vector to a BlockFace

withArguments

@JvmName(name = "attachArguments")

fun Component.withArguments(args: List<TranslationArgumentLike>): Component

Attaches arguments to a component and all its children.