nova/xyz.xenondevs.nova.world.block/NovaBlock

NovaBlock

@Serializable(with = NovaBlockSerializer::class)

open class NovaBlock

Represents a custom Nova block type.

Inheritors

NovaTileEntityBlock

Types

Companion

object Companion

Properties

behaviors

val behaviors: List<BlockBehavior>

A list of all BlockBehaviors of this NovaBlock.

blockStates

val blockStates: List<NovaBlockState>

A list of all possible NovaBLockStates of this NovaBlock

config

val config: Provider<CommentedConfigurationNode>

The configuration for this NovaBlock. May be an empty node if the config file does not exist.

defaultBlockState

val defaultBlockState: NovaBlockState

The default block state of this NovaBlock.

val id: Key

item

var item: NovaItem?

The NovaItem associated with this NovaBlock.

name

val name: Component

stateProperties

val stateProperties: List<ScopedBlockStateProperty<*>>

style

val style: Style

Functions

canPlace

suspend fun canPlace(pos: BlockPos, state: NovaBlockState, ctx: Context<BlockPlace>): Boolean

Checks whether a block of state can be placed at pos using the given ctx.

chooseBlockState

fun chooseBlockState(ctx: Context<BlockPlace>): NovaBlockState

Chooses the appropriate NovaBlockState for placement given the ctx.

getBehavior

inline fun <T : Any> getBehavior(): T

Gets the first BlockBehavior that is an instance of T, or throws an IllegalStateException if there is none.

fun <T : Any> getBehavior(type: Class<T>): T

fun <T : Any> getBehavior(type: KClass<T>): T

Gets the first BlockBehavior that is an instance of type, or throws an IllegalStateException if there is none.

getBehaviorOrNull

inline fun <T : Any> getBehaviorOrNull(): T?

Gets the first BlockBehavior that is an instance of T, or null if there is none.

fun <T : Any> getBehaviorOrNull(type: Class<T>): T?

fun <T : Any> getBehaviorOrNull(type: KClass<T>): T?

Gets the first BlockBehavior that is an instance of type or a subclass, or null if there is none.

getDrops

fun getDrops(pos: BlockPos, state: NovaBlockState, ctx: Context<BlockBreak>): List<ItemStack>

Retrieves the items that would be dropped when breaking a block of state at pos with the given ctx.

getExp

fun getExp(pos: BlockPos, state: NovaBlockState, ctx: Context<BlockBreak>): Int

Retrieves the amount of experience that would be dropped when breaking a block of state at pos with the given ctx.

handleAttack

fun handleAttack(pos: BlockPos, state: NovaBlockState, ctx: Context<BlockBreak>)

Handles attack (left-click) on a block of state at pos with the given ctx.

handleBreak

open fun handleBreak(pos: BlockPos, state: NovaBlockState, ctx: Context<BlockBreak>)

Handles the destruction of a block of state at pos with the given ctx.

handleEntityInside

fun handleEntityInside(pos: BlockPos, state: NovaBlockState, entity: Entity)

Called when an entity is inside a block of state at pos.

handleNeighborChanged

fun handleNeighborChanged(pos: BlockPos, state: NovaBlockState)

Called when a redstone update happened that may affect this state at pos.

handlePlace

open fun handlePlace(pos: BlockPos, state: NovaBlockState, ctx: Context<BlockPlace>)

Handles the placement of a block of state at pos with the given ctx.

handleRandomTick

fun handleRandomTick(pos: BlockPos, state: NovaBlockState)

Handles a random tick for a block of state at pos.

handleScheduledTick

fun handleScheduledTick(pos: BlockPos, state: NovaBlockState)

Handles a scheduled tick for a block of state at pos.

hasBehavior

inline fun <T : Any> hasBehavior(): Boolean

Checks whether this NovaBlock has a BlockBehavior of the reified type T, or a subclass of it.

fun <T : Any> hasBehavior(type: Class<T>): Boolean

fun <T : Any> hasBehavior(type: KClass<T>): Boolean

Checks whether this NovaBlock has a BlockBehavior of the specified class type, or a subclass of it.

pickBlockCreative

fun pickBlockCreative(pos: BlockPos, state: NovaBlockState, ctx: Context<BlockInteract>): ItemStack?

Chooses the ItemStack that should be given to the player when mid-clicking a block of state at pos with the given ctx in creative mode.

toString

open override fun toString(): String

updateShape

fun updateShape(pos: BlockPos, state: NovaBlockState, neighborPos: BlockPos): NovaBlockState

Called when a block at neighborPos changed to update the NovaBlockState of this state at pos.

use

fun use(pos: BlockPos, state: NovaBlockState, ctx: Context<BlockInteract>): InteractionResult

Uses the block of state at pos by itself, without using an item.

useItemOn

fun useItemOn(pos: BlockPos, state: NovaBlockState, ctx: Context<BlockInteract>): InteractionResult

Uses an item on the block of state at pos.