Class AbilityCharges

java.lang.Object

com.hypixel.hytale.builtin.abilities.trigger.AbilityCharges

All Implemented Interfaces:

Component<EntityStore>, Cloneable

public class AbilityCharges
extends Object
implements Component<EntityStore>

The buffs granted by ability casts that run an authored interaction each time their trigger fires (see AbilityChargeTrigger; today both triggers are weapon attacks) until their charges or the buff run out. One carrier holds one AbilityCharges.Entry per buff effect, so buffs from different abilities (a poison imbue and a wind strike) coexist and each spends its own charges. Recasting an ability replaces its own entry only. The interaction runs server-simulated on the carrier with the cast's ImpactModifiers snapshot in context, so its nodes resolve the rune values the cast did, whatever was cast since.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AbilityCharges.Entry	One granted buff: its effect, what spends a charge, and the interaction each charge runs.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	UNLIMITED	Remaining value of a buff with no charge limit: it lasts as long as its effect.

Fields inherited from interface Component

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor	Description
AbilityCharges()
AbilityCharges(AbilityCharges.Entry entry)

Method Summary

Modifier and Type	Method	Description
Component<EntityStore>	clone()
AbilityCharges.Entry	get(int effectIndex)
static ComponentType<EntityStore, AbilityCharges>	getComponentType()
List<AbilityCharges.Entry>	getEntries()
boolean	isEmpty()
void	put(AbilityCharges.Entry entry)	Arms a buff.
void	remove(int effectIndex)

Methods inherited from class Object

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

Methods inherited from interface Component

cloneSerializable

Field Details

UNLIMITED

public static final int UNLIMITED

Remaining value of a buff with no charge limit: it lasts as long as its effect.

See Also:

• Constant Field Values

Constructor Details

AbilityCharges

public AbilityCharges()

AbilityCharges

public AbilityCharges(@Nonnull
 AbilityCharges.Entry entry)

Method Details

getComponentType

public static ComponentType<EntityStore, AbilityCharges> getComponentType()

put

public void put(@Nonnull
 AbilityCharges.Entry entry)

Arms a buff. An entry for the same effect is replaced, so a recast starts its charges over.

get

@Nullable
public AbilityCharges.Entry get(int effectIndex)

remove

public void remove(int effectIndex)

isEmpty

public boolean isEmpty()

getEntries

@Nonnull
public List<AbilityCharges.Entry> getEntries()

Returns:

a snapshot of the armed entries, safe to iterate while entries are removed.

clone

@Nonnull
public Component<EntityStore> clone()

Specified by:

clone in interface Component<EntityStore>

Returns:

a clone instance of the original component instance.