Package at.petrak.hexcasting.api.casting.eval.env

Class CircleCastEnv

java.lang.Object

at.petrak.hexcasting.api.casting.eval.CastingEnvironment

at.petrak.hexcasting.api.casting.eval.env.CircleCastEnv

public class CircleCastEnv
extends CastingEnvironment

Nested Class Summary

Nested classes/interfaces inherited from class at.petrak.hexcasting.api.casting.eval.CastingEnvironment

CastingEnvironment.HeldItemInfo, CastingEnvironment.StackDiscoveryMode

Field Summary

Fields

Modifier and Type	Field	Description
protected final CircleExecutionState	execState

Fields inherited from class at.petrak.hexcasting.api.casting.eval.CastingEnvironment

componentMap, world

Constructor Summary

Constructors

Constructor	Description
CircleCastEnv(net.minecraft.server.level.ServerLevel world, CircleExecutionState execState)

Method Summary

Modifier and Type	Method	Description
CircleExecutionState	circleState()
long	extractMediaEnvironment(long cost, boolean simulate)	Attempt to extract the given amount of media.
@Nullable net.minecraft.server.level.ServerPlayer	getCaster()	Get the caster.
@Nullable net.minecraft.world.entity.LivingEntity	getCastingEntity()	Gets the caster.
net.minecraft.world.InteractionHand	getCastingHand()
@Nullable BlockEntityAbstractImpetus	getImpetus()
MishapEnvironment	getMishapEnvironment()	Get an interface used to do mishaps
FrozenPigment	getPigment()
protected List<CastingEnvironment.HeldItemInfo>	getPrimaryStacks()	Get the primary/secondary item stacks this env can use (i.e.
protected List<net.minecraft.world.item.ItemStack>	getUsableStacks(CastingEnvironment.StackDiscoveryMode mode)	Get all the item stacks this env can use.
boolean	hasEditPermissionsAtEnvironment(net.minecraft.core.BlockPos pos)	Return whether the caster can edit blocks at the given permission (i.e.
boolean	isEnlightened()	Return whether this env can cast great spells.
boolean	isVecInRangeEnvironment(net.minecraft.world.phys.Vec3 vec)	Get if the vec is close enough, to the player or sentinel ...
net.minecraft.world.phys.Vec3	mishapSprayPos()
void	postExecution(at.petrak.hexcasting.api.casting.eval.CastResult result)	Do whatever you like after a pattern is executed.
void	precheckAction(PatternShapeMatch match)	If something about this ARE itself is invalid, mishap.
void	printMessage(net.minecraft.network.chat.Component message)
void	produceParticles(at.petrak.hexcasting.api.casting.ParticleSpray particles, FrozenPigment pigment)
boolean	replaceItem(Predicate<net.minecraft.world.item.ItemStack> stackOk, net.minecraft.world.item.ItemStack replaceWith, @Nullable net.minecraft.world.InteractionHand hand)	Attempt to replace the first stack found which matches the predicate with the stack to replace with.
@Nullable FrozenPigment	setPigment(@Nullable FrozenPigment pigment)

Methods inherited from class at.petrak.hexcasting.api.casting.eval.CastingEnvironment

actionKey, addCreateEventListener, addCreateEventListener, addExtension, assertEntityInRange, assertPosInRange, assertPosInRangeForEditing, assertVecInRange, assertVecInWorld, canEditBlockAt, extractMedia, getExtension, getHeldItemToOperateOn, getOtherHand, getPrimaryStacksForPlayer, getUsableStacksForPlayer, getWorld, hasEditPermissionsAt, isCreativeMode, isEntityInRange, isEntityInRange, isVecInAmbit, isVecInRange, isVecInWorld, maxOpCount, postCast, queryForMatchingStack, removeExtension, replaceItemForPlayer, triggerCreateEvent, withdrawItem

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

execState

protected final CircleExecutionState execState

Constructor Details

CircleCastEnv

public CircleCastEnv(net.minecraft.server.level.ServerLevel world,
 CircleExecutionState execState)

Method Details

getCastingEntity

@Nullable
public @Nullable net.minecraft.world.entity.LivingEntity getCastingEntity()

Description copied from class: CastingEnvironment

Gets the caster. Can be null if CastingEnvironment.getCaster() is also null

Specified by:

getCastingEntity in class CastingEnvironment

Returns:

the entity casting

getCaster

@Nullable
public @Nullable net.minecraft.server.level.ServerPlayer getCaster()

Description copied from class: CastingEnvironment

Get the caster. Might be null!

Implementations should NOT rely on this in general, use the methods on this class instead. This is mostly for spells (flight, etc)

Overrides:

getCaster in class CastingEnvironment

getImpetus

@Nullable
public @Nullable BlockEntityAbstractImpetus getImpetus()

circleState

public CircleExecutionState circleState()

getMishapEnvironment

public MishapEnvironment getMishapEnvironment()

Description copied from class: CastingEnvironment

Get an interface used to do mishaps

Specified by:

getMishapEnvironment in class CastingEnvironment

precheckAction

public void precheckAction(PatternShapeMatch match)
                    throws at.petrak.hexcasting.api.casting.mishaps.Mishap

Description copied from class: CastingEnvironment

If something about this ARE itself is invalid, mishap.

This is used for stuff like requiring enlightenment and pattern denylists

Overrides:

precheckAction in class CastingEnvironment

Throws:

at.petrak.hexcasting.api.casting.mishaps.Mishap

postExecution

public void postExecution(at.petrak.hexcasting.api.casting.eval.CastResult result)

Description copied from class: CastingEnvironment

Do whatever you like after a pattern is executed.

Overrides:

postExecution in class CastingEnvironment

mishapSprayPos

public net.minecraft.world.phys.Vec3 mishapSprayPos()

Specified by:

mishapSprayPos in class CastingEnvironment

extractMediaEnvironment

public long extractMediaEnvironment(long cost,
 boolean simulate)

Description copied from class: CastingEnvironment

Attempt to extract the given amount of media. Returns the amount of media left in the cost.

If there was enough media found, it will return less or equal to zero; if there wasn't, it will be positive.

Specified by:

extractMediaEnvironment in class CastingEnvironment

isVecInRangeEnvironment

public boolean isVecInRangeEnvironment(net.minecraft.world.phys.Vec3 vec)

Description copied from class: CastingEnvironment

Get if the vec is close enough, to the player or sentinel ...

Doesn't take into account being out of the world.

Specified by:

isVecInRangeEnvironment in class CastingEnvironment

isEnlightened

public boolean isEnlightened()

Description copied from class: CastingEnvironment

Return whether this env can cast great spells.

Overrides:

isEnlightened in class CastingEnvironment

hasEditPermissionsAtEnvironment

public boolean hasEditPermissionsAtEnvironment(net.minecraft.core.BlockPos pos)

Description copied from class: CastingEnvironment

Return whether the caster can edit blocks at the given permission (i.e. not adventure mode, etc.)

Specified by:

hasEditPermissionsAtEnvironment in class CastingEnvironment

getCastingHand

public net.minecraft.world.InteractionHand getCastingHand()

Specified by:

getCastingHand in class CastingEnvironment

getUsableStacks

protected List<net.minecraft.world.item.ItemStack> getUsableStacks(CastingEnvironment.StackDiscoveryMode mode)

Description copied from class: CastingEnvironment

Get all the item stacks this env can use.

Specified by:

getUsableStacks in class CastingEnvironment

getPrimaryStacks

protected List<CastingEnvironment.HeldItemInfo> getPrimaryStacks()

Description copied from class: CastingEnvironment

Get the primary/secondary item stacks this env can use (i.e. main hand and offhand for the player).

Specified by:

getPrimaryStacks in class CastingEnvironment

replaceItem

public boolean replaceItem(Predicate<net.minecraft.world.item.ItemStack> stackOk,
 net.minecraft.world.item.ItemStack replaceWith,
 @Nullable
 @Nullable net.minecraft.world.InteractionHand hand)

Description copied from class: CastingEnvironment

Attempt to replace the first stack found which matches the predicate with the stack to replace with.

Specified by:

replaceItem in class CastingEnvironment

Returns:

whether it was successful.

getPigment

public FrozenPigment getPigment()

Specified by:

getPigment in class CastingEnvironment

setPigment

@Nullable
public @Nullable FrozenPigment setPigment(@Nullable
 @Nullable FrozenPigment pigment)

Specified by:

setPigment in class CastingEnvironment

produceParticles

public void produceParticles(at.petrak.hexcasting.api.casting.ParticleSpray particles,
 FrozenPigment pigment)

Specified by:

produceParticles in class CastingEnvironment

printMessage

public void printMessage(net.minecraft.network.chat.Component message)

Specified by:

printMessage in class CastingEnvironment