Class SpellComponent

java.lang.Object

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

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

Direct Known Subclasses:

SpellComponent.CastBlock, SpellComponent.CastBoth, SpellComponent.CastEntity

public abstract non-sealed class SpellComponent
extends SpellPart

Represents a spell component. Components are part of the SpellGrammar.

Extend this class directly for target-independent effects, e.g. time or weather components. Extend one of the inner subclasses for target-dependent effects instead.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SpellComponent.CastBlock	Represents a spell component that only affects blocks.
static class	SpellComponent.CastBoth	Represents a spell component that affects both blocks and entities, with distinct effects on each.
static class	SpellComponent.CastEntity	Represents a spell component that only affects entities.

Constructor Summary

Constructors

Constructor	Description
SpellComponent(SpellStat... stats)

Method Summary

Modifier and Type	Method	Description
abstract SpellComponentCastResult	cast(List<SpellModifier> modifiers, SpellCastContext context)	Casts the part.
Set<SpellStat>	getStats()	If the spell part is a modifier, returns the SpellStats the modifier modifies.
final boolean	isComponent()
final boolean	isModifier()
final boolean	isPrimaryShape()
final boolean	isSecondaryShape()
void	spawnParticles(List<SpellModifier> modifiers, SpellCastContext context)	Spawns particles for the part.

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

SpellComponent

public SpellComponent(SpellStat... stats)

Parameters:

stats - A vararg of SpellStats used by the component.

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.

cast

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

Casts the part.

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)

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

Parameters:

modifiers - The SpellModifiers to consider.

context - The SpellCastContext to use.