Package io.github.xrickastley.sevenelements.element

Class InternalCooldown

java.lang.Object

io.github.xrickastley.sevenelements.element.InternalCooldown

public final class InternalCooldown
extends Object

An InternalCooldown is a class used for holding the various InternalCooldown components together in a single class.

In addition to this, this class is also the handler for the Internal Cooldown system.

When the Internal Cooldown is considered active through isInInternalCooldown(), elements should not be applied or refreshed.

To read more about the InternalCooldown, refer to the InternalCooldownContext class.

Field Summary

Fields

Modifier and Type	Field	Description
private int	cooldown
private final InternalCooldownHolder	holder
private final InternalCooldownTag	tag
private int	totalHits
private final InternalCooldownType	type

Constructor Summary

Constructors

Constructor	Description
InternalCooldown(InternalCooldownHolder holder, InternalCooldownTag tag, InternalCooldownType type)

Method Summary

Modifier and Type	Method	Description
static String	getIdentifier(InternalCooldownTag tag, InternalCooldownType type)
static String	getIdentifier(String tag, InternalCooldownType type)
boolean	handleInternalCooldown()	Handles the Internal Cooldown.
boolean	isInInternalCooldown()	Checks if an element can be applied based on this Internal Cooldown.
(package private) static InternalCooldown	none(InternalCooldownHolder holder)

Methods inherited from class java.lang.Object

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

Field Details

holder

private final InternalCooldownHolder holder

type

private final InternalCooldownType type

tag

private final InternalCooldownTag tag

cooldown

private int cooldown

totalHits

private int totalHits

Constructor Details

InternalCooldown

InternalCooldown(InternalCooldownHolder holder,
 InternalCooldownTag tag,
 InternalCooldownType type)

Method Details

getIdentifier

public static String getIdentifier(InternalCooldownTag tag,
 InternalCooldownType type)

getIdentifier

public static String getIdentifier(String tag,
 InternalCooldownType type)

none

static InternalCooldown none(InternalCooldownHolder holder)

isInInternalCooldown

public boolean isInInternalCooldown()

Checks if an element can be applied based on this Internal Cooldown.

For registering a hit and checking the Internal Cooldown after, use handleInternalCooldown() instead.

See Also:

• handleInternalCooldown()

handleInternalCooldown

public boolean handleInternalCooldown()

Handles the Internal Cooldown.

Upon using this method, a hit is registered, and it returns Whether the element can be applied.

For only checking the Internal Cooldown without registering a hit, use isInInternalCooldown() instead.

See Also:

• isInInternalCooldown()