0.18-alpha.14

nova/xyz.xenondevs.nova.util

Package-level declarations

Types

object BlockFaceUtils

Utilities related to BlockFace.

enum BlockSide : Enum<BlockSide>

The side of a block.

object BlockUtils

object EntityUtils

FakeOnlinePlayer

abstract class FakeOnlinePlayer(offlinePlayer: OfflinePlayer, location: Location) : Player, OfflinePlayer

A Player which will throw an UnsupportedOperationException when methods which aren't supported by OfflinePlayer are called.

class FakePlayer(server: MinecraftServer, level: ServerLevel, profile: GameProfile, val hasEvents: Boolean) : ServerPlayer

object LocationUtils

enum MetricPrefix : Enum<MetricPrefix>

object NMSUtils

NumberFormatUtils

object NumberFormatUtils

class PacketTask(packets: List<Packet<*>>, interval: Long, getViewers: () -> Iterable<Player>)

A task that sends the given packets to all players from getViewers every interval ticks.

enum ServerSoftware : Enum<ServerSoftware>

object ServerUtils

object StringUtils

Properties

val Block.above: Block

The block that is one y-level above the current one.

val BlockFace.axis: Axis

The axis of a BlockFace

val Block.below: Block

The block that is one y-level below the current one.

val Direction.blockFace: BlockFace

val Location.blockLocation: Location

val Location.blockPos: BlockPos

bukkitBlockData

val BlockState.bukkitBlockData: BlockData

bukkitEquipmentSlot

val InteractionHand.bukkitEquipmentSlot: EquipmentSlot

val EquipmentSlot.bukkitEquipmentSlot: EquipmentSlot

val Item.bukkitMaterial: Material

val Block.bukkitMaterial: Material

val Pose.bukkitPose: Pose

val BlockPos.center: Vec3

val Block.center: Location

The location at the center of this block.

val BlockPos.chunkSection: LevelChunkSection

val Player.connection: ServerGamePacketListenerImpl

val CUBE_FACES: Set<BlockFace>

val DATA_VERSION: Int

destroyProgress

val Player.destroyProgress: Double?

The current block destroy progress of the player. Between 0 and 1 or null if the player is not breaking a block at the moment.

val Entity.eyeInWater: Boolean

If the Entity's eye is underwater.

val PlayerInteractEvent.handItems: Array<ItemStack>

val PlayerInteractEvent.hands: Array<Pair<EquipmentSlot, ItemStack>>

val Block.hardness: Double

The hardness of this block, also considering the custom hardness of Nova blocks.

hasInventoryOpen

val Player.hasInventoryOpen: Boolean

If the Player has is currently looking into an inventory. Does not detect the player's inventory itself because that is not sent to the server.

HORIZONTAL_FACES

val HORIZONTAL_FACES: Set<BlockFace>

val BlockState.id: Int

val Block.id: Key

The Key of this block, considering blocks from Nova, custom item services and vanilla.

val Chunk.levelChunk: LevelChunk

val Entity.localizedName: String?

The translation key for the name of this BukkitEntity.

MINECRAFT_SERVER

val MINECRAFT_SERVER: DedicatedServer

val ResourceLocation.namespacedKey: NamespacedKey

val Attribute.nmsAttribute: Attribute

val Material.nmsBlock: Block

val BlockData.nmsBlockState: BlockState

val ItemStack?.~~nmsCopy~~: ItemStack

val BlockFace.nmsDirection: Direction

val Entity.nmsEntity: Entity

nmsEquipmentSlot

val InteractionHand.nmsEquipmentSlot: EquipmentSlot

val EquipmentSlot.nmsEquipmentSlot: EquipmentSlot

nmsInteractionHand

val EquipmentSlot.nmsInteractionHand: InteractionHand

val EquipmentSlot.nmsInteractionHand: InteractionHand

val Material.nmsItem: Item

val AttributeModifier.Operation.nmsOperation: AttributeModifier.Operation

val Pose.nmsPose: Pose

val Block.nmsState: BlockState

var Block.novaBlock: NovaBlock?

The NovaBlock of the NovaBlockState at the position of this Block.

var Block.novaBlockState: NovaBlockState?

The NovaBlockState at the position of this Block.

val Block.novaSoundGroup: SoundGroup?

The sound group of this block, also considering custom sound groups of Nova blocks.

val BlockFace.pitch: Float

The corresponding pitch value.

REGISTRY_ACCESS

val REGISTRY_ACCESS: RegistryAccess

resourceLocation

val NamespacedKey.resourceLocation: ResourceLocation

val World.serverLevel: ServerLevel

val Player.serverPlayer: ServerPlayer

val serverTick: Int

val IntRange.size: Int

val BlockPos.vec3: Vec3

val Location.vec3: Vec3

val Vector.vec3: Vec3

val VERTICAL_FACES: Set<BlockFace>

val BlockFace.yaw: Float

The corresponding yaw value.

Functions

fun Location.add(vec: Vector3d): Location

fun Location.add(vec: Vector3f): Location

fun Rotations.add(x: Float, y: Float, z: Float): Rotations

fun VirtualInventory.addAll(reason: UpdateReason?, items: List<ItemStack>)

Adds a List of ItemStacks to a VirtualInventory.

addItemCorrectly

fun Inventory.addItemCorrectly(itemStack: ItemStack): Int

Adds an ItemStack to an Inventory while respecting both the max stack size of the inventory and the max stack size of the item type.

fun String.addNamespace(namespace: String): String

fun String.addPrefix(prefix: String): String

fun Inventory.addPrioritized(prioritizedSlot: Int, itemStack: ItemStack): Int

Puts an ItemStack on the prioritizedSlot or adds it to the Inventory if the given slot is occupied.

fun PlayerInventory.addPrioritized(prioritizedSlot: EquipmentSlot, itemStack: ItemStack): Int

Puts an ItemStack on the prioritizedSlot or adds it to the Inventory if the given slot is occupied.

fun String.addSuffix(suffix: String): String

addToInventoryOrDrop

fun Player.addToInventoryOrDrop(vararg items: ItemStack)

Adds items to the Player's inventory or drops them on the ground if there is not enough space

fun Player.addToInventoryOrDrop(items: List<ItemStack>)

Adds items to the Player's inventory or drops them on the ground if there is not enough space.

addToInventoryPrioritizedOrDrop

fun Player.addToInventoryPrioritizedOrDrop(prioritizedSlot: Int, itemStack: ItemStack)

Puts an ItemStack on the prioritizedSlot or adds it to the Inventory if the given slot is occupied or drops it on the ground if there is not enough space.

fun Player.addToInventoryPrioritizedOrDrop(prioritizedSlot: EquipmentSlot, itemStack: ItemStack)

Puts an ItemStack on the prioritizedSlot or adds it to the Inventory if the given slot is occupied or drops it on the ground if there is not enough space.

fun Location.advance(axis: Axis, stepSize: Double = 1.0): @NotNull Location

fun Location.advance(blockFace: BlockFace, stepSize: Double = 1.0): @NotNull Location

fun PlayerList.broadcast(location: Location, maxDistance: Double, packet: Packet<*>)

fun PlayerList.broadcast(block: Block, maxDistance: Double, packet: Packet<*>)

fun PlayerList.broadcast(exclude: Player?, location: Location, maxDistance: Double, packet: Packet<*>)

fun PlayerList.broadcast(exclude: Player?, block: Block, maxDistance: Double, packet: Packet<*>)

fun PlayerList.broadcast(exclude: Player?, location: Location, maxDistance: Double, packet: Packet<*>)

fun PlayerList.broadcast(exclude: Player?, block: Block, maxDistance: Double, packet: Packet<*>)

broadcastBreakEvent

fun Block.broadcastBreakEvent()

Sends the ClientboundLevelEventPacket to all players in a 1-chunk-range, causing break particles and sounds to be played. Only works with vanilla blocks.

broadcastDestructionStage

fun Block.broadcastDestructionStage(entityId: Int, stage: Int)

Sends the ClientboundBlockDestructionPacket to all players in a 1-chunk-range with the given entityId and breaking stage. Only works with vanilla blocks.

fun Block.broadcastDestructionStage(player: Player, stage: Int)

Sends the ClientboundBlockDestructionPacket to all players in a 1-chunk-range with the entity id of the given player and breaking stage. Only works with vanilla blocks.

fun Vector.calculateYaw(): Float

calculateYawPitch

fun Vector.calculateYawPitch(): FloatArray

fun callEvent(event: Event)

Shortcut for PluginManager.callEvent.

fun String.capitalize(): String

fun String.capitalizeAll(): String

inline fun Level.captureDrops(run: () -> Unit): List<ItemEntity>

inline fun Location.castRay(stepSize: Double, maxDistance: Double, run: (Location) -> Boolean)

fun Location.center(): Location

operator fun Location.component1(): World

operator fun Location.component2(): Double

operator fun Location.component3(): Double

operator fun Location.component4(): Double

operator fun Location.component5(): Float

operator fun Location.component6(): Float

operator fun Registry<*>.contains(key: String): Boolean

operator fun Registry<*>.contains(key: Key): Boolean

fun Rotations.copy(x: Float? = null, y: Float? = null, z: Float? = null): Rotations

createColoredParticle

fun Location.createColoredParticle(color: Color): ClientboundLevelParticlesPacket

damageItemInHand

fun LivingEntity.damageItemInHand(hand: EquipmentSlot, damage: Int = 1)

Damages the item in the specified hand by damage amount.

damageItemInMainHand

fun LivingEntity.damageItemInMainHand(damage: Int = 1)

Damages the item in the entity's main hand by damage amount.

damageItemInOffHand

fun LivingEntity.damageItemInOffHand(damage: Int = 1)

Damages the item in the entity's offhand by damage amount.

damageToolAttackEntity

fun LivingEntity.damageToolAttackEntity()

Damages the tool in the entity's main hand as if they've attack an entity.

damageToolBreakBlock

fun LivingEntity.damageToolBreakBlock()

Damages the tool in the entity's main hand as if they've broken a block.

fun Location.dropItem(item: ItemStack)

fun Location.dropItems(items: Iterable<ItemStack>)

dropItemsNaturally

fun World.dropItemsNaturally(location: Location, items: Iterable<ItemStack>)

fun String.equalsAny(vararg strings: String, ignoreCase: Boolean = false): Boolean

fun Iterable<Player>.filterInRange(location: Location, maxDistance: Double): List<Player>

forcePacketBroadcast

fun forcePacketBroadcast(run: () -> Unit)

fun String.Companion.formatSafely(format: String, vararg args: Any?): String

inline fun Location.fullCuboidTo(to: Location, run: (Location) -> Boolean)

operator fun <T> Registry<T>.get(key: String): Optional<Holder.Reference<T>>

fun <T> Registry<T>.get(id: ResourceLocation): Holder<T>?

operator fun <T> ResourceKey<Registry<T>>.get(id: String): Holder.Reference<T>?

operator fun <T> ResourceKey<Registry<T>>.get(key: ResourceKey<T>): Holder.Reference<T>?

operator fun <T> ResourceKey<Registry<T>>.get(id: ResourceLocation): Holder.Reference<T>?

fun BlockPos.getBlockState(): BlockState

fun LevelChunkSection.getBlockState(pos: BlockPos): BlockState

fun Location.getBoxOutline(other: Location, correct: Boolean, stepSize: Double = 0.5): List<Location>

fun Location.getCoordinate(axis: Axis): Double

fun Location.getFullCuboid(other: Location): List<Location>

getNextBlockBelow

fun Location.getNextBlockBelow(countSelf: Boolean, requiresSolid: Boolean): Location?

getOrCreateHolder

fun <T> Registry<T>.getOrCreateHolder(id: ResourceLocation): Holder<T>

fun <T> Registry<T>.getOrNull(key: String): Holder.Reference<T>?

fun <T> Registry<T>.getOrNull(key: Key): Holder.Reference<T>?

fun <T> Registry<T>.getOrNull(id: ResourceLocation): Holder.Reference<T>?

fun <T : Any> RegistryAccess.getOrThrow(key: ResourceKey<T>): Holder.Reference<T>

fun <T> Registry<T>.getOrThrow(key: String): Holder<T>

fun <T> Registry<T>.getOrThrow(key: Key): Holder<T>

fun <T> Registry<T>.getOrThrow(id: ResourceLocation): Holder<T>

fun <T> ResourceKey<Registry<T>>.getOrThrow(key: String): Holder.Reference<T>

fun <T> ResourceKey<Registry<T>>.getOrThrow(id: Key): Holder.Reference<T>

fun <T> ResourceKey<Registry<T>>.getOrThrow(key: ResourceKey<T>): Holder.Reference<T>

fun <T> ResourceKey<Registry<T>>.getOrThrow(id: ResourceLocation): Holder.Reference<T>

getPlayersNearby

fun Location.getPlayersNearby(maxDistance: Double, vararg excluded: Player): Sequence<Player>

fun Location.getRectangle(to: Location, omitCorners: Boolean): Map<Axis, List<Location>>

getStraightLine

fun Location.getStraightLine(axis: Axis, to: Int): List<Location>

getSurroundingChunks

fun Chunk.getSurroundingChunks(range: Int, includeCurrent: Boolean, ignoreUnloaded: Boolean = false): List<Chunk>

getTargetLocation

fun Location.getTargetLocation(stepSize: Double, maxDistance: Double): Location

fun <T> DefaultedRegistry<T>.getValue(key: String?): T

fun <T> DefaultedRegistry<T>.getValue(key: Key?): T

fun <T : Any> RegistryAccess.getValue(key: ResourceKey<T>): T?

fun <T> Registry<T>.getValue(key: String?): T?

fun <T> Registry<T>.getValue(key: Key?): T?

fun <T> ResourceKey<Registry<T>>.getValue(key: String): T?

fun <T> ResourceKey<Registry<T>>.getValue(id: ResourceLocation): T?

getValueOrThrow

fun <T : Any> RegistryAccess.getValueOrThrow(key: ResourceKey<T>): T

fun <T> Registry<T>.getValueOrThrow(key: String): T

fun <T> Registry<T>.getValueOrThrow(id: ResourceLocation): T

fun <T : Comparable<T>> BlockState.hasProperty(property: Property<T>, value: T): Boolean

fun String.insert(offset: Int, charSequence: CharSequence): String

fun String.insertAfter(char: Char, charSequence: CharSequence, ignoreCase: Boolean = false): String

insertAfterLast

fun String.insertAfterLast(char: Char, charSequence: CharSequence, ignoreCase: Boolean = false): String

fun Location.isBetween(min: Location, max: Location): Boolean

fun Location.isBetweenXZ(min: Location, max: Location): Boolean

isBlockLocation

fun Location.isBlockLocation(): Boolean

fun Action.isClickAir(): Boolean

fun Action.isClickBlock(): Boolean

isCompletelyDenied

fun PlayerInteractEvent.isCompletelyDenied(): Boolean

fun Inventory.isFull(): Boolean

Checks if an Inventory is full.

isInsideWorldRestrictions

fun Location.isInsideWorldRestrictions(): Boolean

Checks if a location is inside the world borders and in the allowed building height.

fun InventoryView.isPlayerView(): Boolean

Checks if an InventoryView is the player inventory

fun Key(plugin: Plugin, value: String): Key

Creates a new Key using the plugin's lowercase name as the namespace and value.

fun Key(addon: Addon, value: String): Key

Creates a new Key using the addon's id as the namespace and value.

fun Location(world: World?, x: Number, y: Number, z: Number, yaw: Number = 0, pitch: Number = 0): Location

lookupGetterOrThrow

fun <T> RegistryOps.RegistryInfoLookup.lookupGetterOrThrow(key: ResourceKey<Registry<T>>): HolderGetter<T>

fun NamespacedKey(addon: Addon, key: String): NamespacedKey

Creates a new NamespacedKey using the addon's id as the namespace and key.

fun <E : Any> NonNullList(list: List<E>, default: E? = null): NonNullList<E>

fun Player.playClickSound()

playItemPickupSound

fun Player.playItemPickupSound()

playSoundNearby

fun Location.playSoundNearby(sound: Sound, volume: Float, pitch: Float, vararg excluded: Player)

fun Location.playSoundNearby(sound: Sound, category: SoundCategory, volume: Float, pitch: Float, vararg excluded: Player)

operator fun Any.plus(other: String): String

fun Location.positionEquals(other: Location): Boolean

inline fun preventEvents(run: () -> Unit)

Prevents all synchronous events attempted to be fired during run from being fired.

preventPacketBroadcast

fun preventPacketBroadcast(run: () -> Unit)

fun <T : Any> WritableRegistry<T>.register(id: Key, value: T): Holder.Reference<T>

fun <T : Any> WritableRegistry<T>.register(id: ResourceLocation, value: T): Holder.Reference<T>

fun Listener.registerEvents()

Shortcut for PluginManager.registerEvents, registered under the Nova plugin.

RegistryFriendlyByteBuf

fun RegistryFriendlyByteBuf(): RegistryFriendlyByteBuf

removeMinecraftFormatting

fun String.removeMinecraftFormatting(): String

removeNamespace

fun String.removeNamespace(namespace: String): String

removeOrientation

fun Location.removeOrientation()

replaceBroadcastExclusion

fun replaceBroadcastExclusion(exclude: ServerPlayer, run: () -> Unit)

ResourceLocation

fun ResourceLocation(addon: Addon, name: String): ResourceLocation

fun runAsyncTask(run: () -> Unit): BukkitTask

Shortcut for BukkitScheduler.runTaskAsynchronously, registered under the Nova plugin.

runAsyncTaskLater

fun runAsyncTaskLater(delay: Long, run: () -> Unit): BukkitTask

Shortcut for BukkitScheduler.runTaskLaterAsynchronously, registered under the Nova plugin.

runAsyncTaskTimer

fun runAsyncTaskTimer(delay: Long, period: Long, run: () -> Unit): BukkitTask

Shortcut for BukkitScheduler.runTaskTimerAsynchronously, registered under the Nova plugin.

fun runTask(run: () -> Unit): BukkitTask

Shortcut for BukkitScheduler.runTask, registered under the Nova plugin.

fun runTaskLater(delay: Long, run: () -> Unit): BukkitTask

Shortcut for BukkitScheduler.runTaskLater, registered under the Nova plugin.

fun runTaskTimer(delay: Long, period: Long, run: () -> Unit): BukkitTask

Shortcut for BukkitScheduler.runTaskTimer, registered under the Nova plugin.

fun Player.send(vararg packets: Packet<*>)

fun Player.send(packets: Iterable<Packet<*>>)

fun Packet<*>.sendTo(vararg players: Player)

fun Packet<*>.sendTo(players: Iterable<Player>)

operator fun <T : Any> WritableRegistry<T>.set(name: String, value: T)

operator fun <T : Any> WritableRegistry<T>.set(key: Key, value: T)

operator fun <T : Any> WritableRegistry<T>.set(key: ResourceKey<T>, value: T)

operator fun <T : Any> WritableRegistry<T>.set(id: ResourceLocation, value: T)

operator fun <T : Any> WritableRegistry<T>.set(addon: Addon, key: String, value: T)

fun BlockPos.setBlockState(state: BlockState)

setBlockStateNoUpdate

fun BlockPos.setBlockStateNoUpdate(state: BlockState)

setBlockStateSilently

fun BlockPos.setBlockStateSilently(state: BlockState)

fun LevelChunkSection.setBlockStateSilently(pos: BlockPos, state: BlockState)

fun Block.setBreakStage(entityId: Int, stage: Int)

Sets the break stage for this Block. Works with Nova and vanilla blocks.

fun Location.setCoordinate(axis: Axis, coordinate: Double)

fun Block.spawnExpOrb(exp: Int, location: Location = this.location.add(.5, .5, .5)): Int

Spawns an experience orb of exp from this block after calling the BlockExpEvent.

fun String.startsWithAny(vararg prefixes: String): Boolean

fun Location.subtract(vec: Vector3d): Location

fun Location.subtract(vec: Vector3f): Location

fun <T> Either<T, T>.take(): T

fun Entity.teleport(modifyLocation: Location.() -> Unit)

Teleports the BukkitEntity after modifying its location using the modifyLocation lambda.

fun <T> Registry<T>.toHolderMap(): Map<ResourceLocation, Holder<T>>

fun IntRange.toIntArray(): IntArray

fun ResourceLocation.toKey(): Key

fun Vector3d.toLocation(world: World? = null): Location

fun Vector3f.toLocation(world: World? = null): Location

fun <T> Registry<T>.toMap(): Map<ResourceLocation, T>

toNamespacedKey

fun Key.toNamespacedKey(): NamespacedKey

Converts this Key to a NamespacedKey.

fun BlockPos.toNovaPos(world: World): BlockPos

toResourceLocation

fun Key.toResourceLocation(): ResourceLocation

fun <C : ResourceType> ResourceLocation.toResourcePath(type: C): ResourcePath<C>

fun Key.toString(separator: String): String

Converts this Key to a string by concatenating the Key.namespace and Key.value with separator.

fun ResourceLocation.toString(separator: String): String

fun Location.toVec3(): Vec3

fun Vector.toVec3(): Vec3

fun Vector3d.toVec3(): Vec3

fun Vector3f.toVec3(): Vec3

fun Location.toVector3d(): Vector3d

fun Location.toVector3f(): Vector3f

unregisterEvents

fun Listener.unregisterEvents()

Unregisters this Listener from all events.

untilHeightLimit

fun Location.untilHeightLimit(includeThis: Boolean, run: (Location) -> Boolean)

fun ItemStack?.unwrap(): ItemStack

fun Vector(yaw: Float, pitch: Float): Vector