Package dev.aurelium.auraskills.api.source.type

Interface EntityXpSource

All Superinterfaces:

XpSource

public interface EntityXpSource
extends XpSource

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	EntityXpSource.EntityDamagers
static enum	EntityXpSource.EntityTriggers

Method Summary

Modifier and Type	Method	Description
@Nullable DamageXpSource.DamageCause[]	getCauses()	Gets the valid damage causes of the source.
EntityXpSource.EntityDamagers[]	getDamagers()	Gets an array of damagers of the source.
@NotNull String	getEntity()	Gets the name of the entity of the source.
@Nullable DamageXpSource.DamageCause[]	getExcludedCauses()	Gets the excluded damage causes of the source.
@NotNull EntityXpSource.EntityTriggers[]	getTriggers()	Gets an array of triggers of the source.
boolean	scaleXpWithHealth()	Whether the XP multiplier for sources using the EntityXpSource.EntityTriggers.DAMAGE trigger should be scaled by the damaged mob's max health.

Methods inherited from interface dev.aurelium.auraskills.api.source.XpSource

getDisplayName, getId, getType, getUnitName, getXp, isVersionValid, name

Method Details

getEntity

@NotNull
@NotNull String getEntity()

Gets the name of the entity of the source.

Returns:

The entity name

getTriggers

@NotNull
@NotNull EntityXpSource.EntityTriggers[] getTriggers()

Gets an array of triggers of the source.

Returns:

The triggers. If there is only one trigger, it will return an array with one element.

getDamagers

EntityXpSource.EntityDamagers[] getDamagers()

Gets an array of damagers of the source. Xp will only be given if the damager matches.

Returns:

The damagers. If there is only one damager, it will return an array with one element.

scaleXpWithHealth

boolean scaleXpWithHealth()

Whether the XP multiplier for sources using the EntityXpSource.EntityTriggers.DAMAGE trigger should be scaled by the damaged mob's max health.

Returns:

whether to scale XP by health

getCauses

@Nullable
@Nullable DamageXpSource.DamageCause[] getCauses()

Gets the valid damage causes of the source.

Returns:

The damage causes. If there are no damage causes set (all damage causes valid), it will return null.

getExcludedCauses

@Nullable
@Nullable DamageXpSource.DamageCause[] getExcludedCauses()

Gets the excluded damage causes of the source.

Returns:

The excluded damage causes, or null if there are none set.