nova/xyz.xenondevs.nova.context.intention/HasRequiredBlock

HasRequiredBlock

interface HasRequiredBlock<I : HasRequiredBlock<I>> : ContextIntention<I>

A ContextIntention that has required parameters about a block in a world.

Autofillers

Target	#	Source(s)	Notes
BLOCK	1.	BLOCK_POS
BLOCK_POS	1.	BLOCK
BLOCK_WORLD	1.	BLOCK_POS
BLOCK_TYPE	1.	BLOCK_TYPE_NOVA
	2.	BLOCK_TYPE_VANILLA
BLOCK_TYPE_VANILLA	1.	BLOCK_STATE_VANILLA
	2.	BLOCK_TYPE	Only if vanilla block
BLOCK_STATE_VANILLA	1.	BLOCK_POS	Only if not Nova block
BLOCK_TYPE_NOVA	1.	BLOCK_STATE_NOVA
	2.	BLOCK_TYPE	Only if Nova block
BLOCK_STATE_NOVA	1.	BLOCK_POS	Only if Nova block

Inheritors

BlockBreak

BlockInteract

BlockPlace

HasOptionalTileEntity

Types

Companion

object Companion

Properties

BLOCK

open val BLOCK: RequiredContextParamType<Block, I>

The block at a position in a world.

BLOCK_POS

open val BLOCK_POS: RequiredContextParamType<BlockPos, I>

The position of a block.

BLOCK_STATE_NOVA

open val BLOCK_STATE_NOVA: ContextParamType<NovaBlockState, I>

The custom block state.

BLOCK_STATE_VANILLA

open val BLOCK_STATE_VANILLA: ContextParamType<BlockData, I>

The vanilla block data (block state).

BLOCK_TYPE

open val BLOCK_TYPE: RequiredContextParamType<Key, I>

The block type as id.

BLOCK_TYPE_NOVA

open val BLOCK_TYPE_NOVA: ContextParamType<NovaBlock, I>

The custom block type.

BLOCK_TYPE_VANILLA

open val BLOCK_TYPE_VANILLA: ContextParamType<BlockType, I>

The vanilla block type.

BLOCK_WORLD

open val BLOCK_WORLD: RequiredContextParamType<World, I>

The world of a block.

required

abstract val required: Set<RequiredContextParamType<*, I>>

The parameter types that must be present in a context with this intention.

Functions

addAutofiller

abstract fun <V : Any> addAutofiller(paramType: ContextParamType<V, I>, autofiller: Autofiller<V, I>, at: Int = Int.MAX_VALUE)

Adds an autofiller for paramType to this intention, allowing contexts with this intention to autofill parameters of this type if they are not explicitly specified.

getAutofillers

abstract fun <V : Any> getAutofillers(paramType: ContextParamType<V, I>): List<Autofiller<V, I>>

Gets the autofillers for paramType in this intention in the order they should be queried.

require

abstract fun require(paramType: RequiredContextParamType<*, I>)

Adds paramType as a required context parameter type for this intention, forcing all contexts with this intention to have a parameter of this type, either through explicit specification or through autofilling.