nova/xyz.xenondevs.nova.context.intention/HasOptionalSource

HasOptionalSource

interface HasOptionalSource<I : HasOptionalSource<I>> : ContextIntention<I>

A ContextIntention that has optional parameters about who caused an action.

Autofillers

Target	#	Source(s)	Notes
SOURCE_UUID	1.	SOURCE_ENTITY
	2.	SOURCE_TILE_ENTITY
SOURCE_LOCATION	1.	SOURCE_ENTITY
	2.	SOURCE_TILE_ENTITY
SOURCE_EYE_LOCATION	1.	SOURCE_LIVING_ENTITY
	2.	SOURCE_LOCATION
SOURCE_WORLD	1.	SOURCE_LOCATION
SOURCE_DIRECTION	1.	SOURCE_LOCATION
SOURCE_ENTITY	1.	SOURCE_PLAYER
	2.	SOURCE_LIVING_ENTITY
SOURCE_LIVING_ENTITY	1.	SOURCE_ENTITY	Only if living entity
SOURCE_PLAYER	1.	SOURCE_ENTITY	Only if player
RESPONSIBLE_PLAYER	1.	SOURCE_ENTITY	Only if offline player
	2.	SOURCE_TILE_ENTITY	Only if owner present

Inheritors

HasOptionalBlockInteraction

ItemUse

Types

Companion

object Companion

Properties

required

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

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

RESPONSIBLE_PLAYER

open val RESPONSIBLE_PLAYER: ContextParamType<OfflinePlayer, I>

The player that is either the direct source or responsible for the action.

SOURCE_DIRECTION

open val SOURCE_DIRECTION: ContextParamType<Vector, I>

The direction that the source of an action is facing.

SOURCE_ENTITY

open val SOURCE_ENTITY: ContextParamType<Entity, I>

The entity that is the source of an action.

SOURCE_EYE_LOCATION

open val SOURCE_EYE_LOCATION: ContextParamType<Location, I>

The eye location of the source of an action.

SOURCE_LIVING_ENTITY

open val SOURCE_LIVING_ENTITY: ContextParamType<LivingEntity, I>

The living entity that is the source of an action.

SOURCE_LOCATION

open val SOURCE_LOCATION: ContextParamType<Location, I>

The location of the source of an action.

SOURCE_PLAYER

open val SOURCE_PLAYER: ContextParamType<Player, I>

The player that is the source of an action.

SOURCE_TILE_ENTITY

open val SOURCE_TILE_ENTITY: ContextParamType<TileEntity, I>

The TileEntity that is the source of an action.

SOURCE_UUID

open val SOURCE_UUID: ContextParamType<UUID, I>

The UUID of the source of an action.

SOURCE_WORLD

open val SOURCE_WORLD: ContextParamType<World, I>

The world of the source of an action.

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.