Package io.github.xrickastley.sevenelements.element

Class Element.ElementSettings

java.lang.Object

io.github.xrickastley.sevenelements.element.Element.ElementSettings

Enclosing class:

Element

private static class Element.ElementSettings
extends Object

A class used in creating data for Elements, instead of multiple overloaded constructors.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	bypassesCooldown
private boolean	canBeAura
private Color	damageColor
private boolean	decayInheritance
private @Nullable Function<ElementalApplication,Number>	decayRate
private boolean	hasAuraTax
private Predicate<ElementalApplication>	linkDecayOnlyIf
private @Nullable Element	linkedElement
private @Nullable Element.ParticleRenderer	particleRenderer
private int	priority
private boolean	reverseLinkedElement
private Identifier	texture

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ElementSettings()

Method Summary

Modifier and Type	Method	Description
Element.ElementSettings	bypassesCooldown(boolean bypassesCooldown)	Sets if the Elemental Application tied to this element is tied to can bypass Internal Cooldown.
Element.ElementSettings	canBeAura(boolean aura)	Sets if the element can be an Aura Element.
static Element.ElementSettings	create()	Creates a new, empty instance of ElementSettings.
Element.ElementSettings	decayInheritance(boolean decayInheritance)	Sets if the element has decay rate inheritance.
Element.ElementSettings	hasAuraTax(boolean auraTax)	Sets if the element, when applied as an Aura Element, would have its Gauge Units deducted by the Aura Tax.
Element.ElementSettings	linkElement(Element element)	Links the provided element to this element.
Element.ElementSettings	linkGaugeDecay(boolean link)	Sets whether the gauge decay is linked to the gauge of this element, or the gauge of the corresponding element, if reverse was true for ElementSettings#linkedElement.
Element.ElementSettings	linkGaugeDecayIf(Predicate<ElementalApplication> predicate)	Sets whether, at this instance in time, the gauge decay is linked to the gauge of this element, or the gauge of the corresponding element, if reverse was true for ElementSettings#linkedElement.
Element.ElementSettings	linkToElement(Element element)	Links this element to the provided element.
Element.ElementSettings	particleRenderer(Element.ParticleRenderer particleRenderer)	Sets the particle renderer for this Element.
Element.ElementSettings	setDamageColor(Color damageColor)	Sets the damage color of the element.
Element.ElementSettings	setDecayRate(@NotNull Function<ElementalApplication,Number> decayRate)	Sets the function controlling the decay rate of this element.
Element.ElementSettings	setPriority(int priority)	Controls the priority of this element over the others.
Element.ElementSettings	setTexture(Identifier texture)	Sets the texture of the element.

Methods inherited from class java.lang.Object

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

Field Details

texture

private Identifier texture

damageColor

private Color damageColor

priority

private int priority

decayRate

@Nullable
private @Nullable Function<ElementalApplication,Number> decayRate

canBeAura

private boolean canBeAura

decayInheritance

private boolean decayInheritance

bypassesCooldown

private boolean bypassesCooldown

hasAuraTax

private boolean hasAuraTax

linkedElement

@Nullable
private @Nullable Element linkedElement

reverseLinkedElement

private boolean reverseLinkedElement

linkDecayOnlyIf

private Predicate<ElementalApplication> linkDecayOnlyIf

particleRenderer

@Nullable
private @Nullable Element.ParticleRenderer particleRenderer

Constructor Details

ElementSettings

private ElementSettings()

Method Details

create

public static Element.ElementSettings create()

Creates a new, empty instance of ElementSettings.

setTexture

public Element.ElementSettings setTexture(Identifier texture)

Sets the texture of the element.

Parameters:

texture - The texture of the element.

setDamageColor

public Element.ElementSettings setDamageColor(Color damageColor)

Sets the damage color of the element.

Parameters:

damageColor - The damage color of the element.

setPriority

public Element.ElementSettings setPriority(int priority)

Controls the priority of this element over the others.

An element's priority dictates when it can be applied, reapplied, reacted with or when it is rendered on top of the entity. Element priority uses natural ordering, also known as ascending order or "least to greatest".

For more information, you may refer to the methods that use Element priority.

Parameters:

priority - The priority of this element.

See Also:

• ElementComponent#getPrioritizedElements
• ElementComponentImpl#triggerReactions
• ElementComponentImpl#attemptReapply

setDecayRate

public Element.ElementSettings setDecayRate(@NotNull
 @NotNull Function<ElementalApplication,Number> decayRate)

Sets the function controlling the decay rate of this element.

This function must output a number x such that x is the amount of Gauge Units deducted per tick.

Parameters:

decayRate - The damage color of the element.

canBeAura

public Element.ElementSettings canBeAura(boolean aura)

Sets if the element can be an Aura Element.

Parameters:

aura - If the element can be an Aura Element.

hasAuraTax

public Element.ElementSettings hasAuraTax(boolean auraTax)

Sets if the element, when applied as an Aura Element, would have its Gauge Units deducted by the Aura Tax.

Parameters:

auraTax - If the element's Gauge Units should be deducted by the Aura Tax.

bypassesCooldown

public Element.ElementSettings bypassesCooldown(boolean bypassesCooldown)

Sets if the Elemental Application tied to this element is tied to can bypass Internal Cooldown.

Parameters:

bypassesCooldown - If the Elemental Application tied to this element can bypass Internal Cooldown.

decayInheritance

public Element.ElementSettings decayInheritance(boolean decayInheritance)

Sets if the element has decay rate inheritance.

Parameters:

decayInheritance - If the element has decay rate inheritance.

particleRenderer

public Element.ElementSettings particleRenderer(Element.ParticleRenderer particleRenderer)

Sets the particle renderer for this Element.

This renders particles on the entity per tick while the element is applied.

Parameters:

particleRenderer - The particle renderer to use.

linkToElement

public Element.ElementSettings linkToElement(Element element)

Links this element to the provided element.

Upon linking, gauge reduction not originating from the gauge decay will be "synced" to the gauge units of this element, if it exists.

Do note that linking isn't a "recursive" operation, i.e. Element A linked to Element B, Element B linked to Element C, reduction on Element A, B and C.

You may also choose to sync the gauge decay permanently or with a Predicate.

Parameters:

element - The Element to link this element to.

See Also:

• ElementSettings#linkElement — For linking the specified element to this element.
• ElementSettings#linkGaugeDecay — For permanent gauge decay linking.
• ElementSettings#linkGaugeDecayIf — For conditional gauge decay linking.

linkElement

public Element.ElementSettings linkElement(Element element)

Links the provided element to this element.

Upon linking, gauge reduction not originating from the gauge decay will be "synced" to the gauge units of the provided element, if it exists.

Do note that linking isn't a "recursive" operation, i.e. Element A linked to Element B, Element B linked to Element C, reduction on Element A, B and C.

You may also choose to sync the gauge decay permanently or with a Predicate.

Parameters:

element - The Element to link to this element.

See Also:

• ElementSettings#linkToElement — For linking this element to the specified element.
• ElementSettings#linkGaugeDecay — For permanent gauge decay linking.
• ElementSettings#linkGaugeDecayIf — For conditional gauge decay linking.

linkGaugeDecay

public Element.ElementSettings linkGaugeDecay(boolean link)

Sets whether the gauge decay is linked to the gauge of this element, or the gauge of the corresponding element, if reverse was true for ElementSettings#linkedElement.

Parameters:

link - Whether the gauge decay is also linked.

linkGaugeDecayIf

public Element.ElementSettings linkGaugeDecayIf(Predicate<ElementalApplication> predicate)

Sets whether, at this instance in time, the gauge decay is linked to the gauge of this element, or the gauge of the corresponding element, if reverse was true for ElementSettings#linkedElement.

Parameters:

predicate - A Predicate indicating whether the gauge decay is also linked at this instance in time. The passed ElementalApplication is the one belonging to the linked element, or more formally, the element this element is linked to.