Class PrimarySpellShape

java.lang.Object

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

at.minecraftschurli.mods.arsmagicalegacy.api.spell.PrimarySpellShape

public abstract non-sealed class PrimarySpellShape
extends SpellPart

Represents a primary spell shape. Primary shapes must be at the start of a SpellShapeGroup.

Constructor Summary

Constructors

Constructor	Description
PrimarySpellShape(SpellStat... stats)

Method Summary

Modifier and Type	Method	Description
abstract SpellCastResult	cast(List<SpellModifier> modifiers, SpellCastContext context)	Casts this part.
Set<SpellStat>	getStats()	If the spell part is a modifier, returns the SpellStats the modifier modifies.
final boolean	isComponent()
boolean	isContinuous()
final boolean	isModifier()
final boolean	isPrimaryShape()
final boolean	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

PrimarySpellShape

public PrimarySpellShape(SpellStat... stats)

Parameters:

stats - A vararg of SpellStats used by the shape.

Method Details

isPrimaryShape

public final boolean isPrimaryShape()

Specified by:

isPrimaryShape in class SpellPart

Returns:

Whether the spell part is a primary shape.

isSecondaryShape

public final boolean isSecondaryShape()

Specified by:

isSecondaryShape in class SpellPart

Returns:

Whether the spell part is a secondary shape.

isComponent

public final boolean isComponent()

Specified by:

isComponent in class SpellPart

Returns:

Whether the spell part is a component.

isModifier

public final boolean isModifier()

Specified by:

isModifier in class SpellPart

Returns:

Whether the spell part is a modifier.

getStats

public Set<SpellStat> getStats()

Description copied from class: SpellPart

If the spell part is a modifier, returns the SpellStats the modifier modifies. Otherwise, returns the SpellStats the spell part uses.

Specified by:

getStats in class SpellPart

Returns:

A Set of SpellStats.

isContinuous

public boolean isContinuous()

Returns:

Whether this part is continuous, i.e., can be cast by holding down the spell.

cast

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

Casts this part. Note that SpellCastContext.directEntity() and SpellCastContext.hitResult() are guaranteed to return null here.

Parameters:

modifiers - The SpellModifiers to consider.

context - The SpellCastContext to use.

Returns:

A SpellCastResult representing the result of the cast.

See Also:

• SpellHelper.castPrimary(SpellCastContext)