Class SpellComponent.CastEntity

java.lang.Object

at.minecraftschurli.mods.arsmagicalegacy.api.spell.SpellPart

at.minecraftschurli.mods.arsmagicalegacy.api.spell.SpellComponent

at.minecraftschurli.mods.arsmagicalegacy.api.spell.SpellComponent.CastEntity

Enclosing class:

SpellComponent

public abstract static class SpellComponent.CastEntity
extends SpellComponent

Represents a spell component that only affects entities.

Nested Class Summary

Nested classes/interfaces inherited from class SpellComponent

SpellComponent.CastBlock, SpellComponent.CastBoth, SpellComponent.CastEntity

Constructor Summary

Constructors

Constructor	Description
CastEntity(SpellStat... stats)

Method Summary

Modifier and Type	Method	Description
SpellComponentCastResult	cast(List<SpellModifier> modifiers, SpellCastContext context)	Casts the part.
abstract SpellComponentCastResult	castEntity(List<SpellModifier> modifiers, SpellCastContext context, net.minecraft.world.phys.EntityHitResult hitResult)	Casts this part on an entity.
void	spawnParticles(List<SpellModifier> modifiers, SpellCastContext context)	Spawns particles for the part.

Methods inherited from class SpellComponent

getStats, isComponent, isModifier, isPrimaryShape, isSecondaryShape

Methods inherited from class SpellPart

getData, getData, getDataComponentType, isShape

Methods inherited from class Object

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

Constructor Details

CastEntity

public CastEntity(SpellStat... stats)

Parameters:

stats - A vararg of SpellStats used by the component.

Method Details

cast

public SpellComponentCastResult cast(List<SpellModifier> modifiers,
 SpellCastContext context)

Description copied from class: SpellComponent

Casts the part.

Specified by:

cast in class SpellComponent

Parameters:

modifiers - The SpellModifiers to consider.

context - The SpellCastContext to use.

Returns:

A SpellComponentCastResult representing the result of the cast.

spawnParticles

public void spawnParticles(List<SpellModifier> modifiers,
 SpellCastContext context)

Description copied from class: SpellComponent

Spawns particles for the part. May only be called on the client.

Overrides:

spawnParticles in class SpellComponent

Parameters:

modifiers - The SpellModifiers to consider.

context - The SpellCastContext to use.

castEntity

public abstract SpellComponentCastResult castEntity(List<SpellModifier> modifiers,
 SpellCastContext context,
 net.minecraft.world.phys.EntityHitResult hitResult)

Casts this part on an entity.

Parameters:

modifiers - The SpellModifiers to consider.

context - The SpellCastContext to use.

hitResult - The EntityHitResult of the spell cast. This is provided for convenience and will be the cast version of SpellCastContext.hitResult().

Returns:

A SpellComponentCastResult representing the result of the cast.