org.spongepowered.api.event.cause.entity.damage.source

Interface DamageSource

All Known Subinterfaces:

BlockDamageSource, EntityDamageSource, FallingBlockDamageSource, IndirectEntityDamageSource

All Known Implementing Classes:

AbstractDamageSource, AbstractEntityDamageSource, AbstractIndirectEntityDamageSource

public interface DamageSource

Represents a Cause for damage on the Entity being damaged. Usually the DamageSource will have different properties based on the source of damage, such as EntityDamageSources, BlockDamageSources, and FallingBlockDamageSources.

Almost always, the DamageSource will be the first element in the Cause of the event. Any additional modifiers that "aid" the Cause of the event will be listed subsequently.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DamageSource.Builder
static interface	DamageSource.DamageSourceBuilder<T extends DamageSource,B extends DamageSource.DamageSourceBuilder<T,B>>

Method Summary

Modifier and Type	Method and Description
static DamageSource.Builder	builder() Creates a new builder to build a DamageSource.
boolean	doesAffectCreative() Gets whether this DamageSource is considered to damage creative, or otherwise "normally unharmable" players.
double	getExhaustion() Gets the amount of exhaustion this DamageSource will add to the entity, generally only to players.
DamageType	getType() Gets the DamageType of this source.
boolean	isAbsolute() Gets whether this DamageSource's damage is absolute and will ignore potion effects and enchantments.
boolean	isBypassingArmor() Gets whether this DamageSource will deal damage that bypasses any armor.
boolean	isExplosive() Gets whether this DamageSource is an explosion.
boolean	isMagic() Gets whether this DamageSource is considered to be magical damage, such as potions, or other sources.
boolean	isScaledByDifficulty() Gets whether this DamageSource's damage is scaled by Difficulty.

Method Detail

builder

static DamageSource.Builder builder()

Creates a new builder to build a DamageSource.

Returns:

A new builder

getType

DamageType getType()

Gets the DamageType of this source.

Returns:

The damage type

isAbsolute

boolean isAbsolute()

Gets whether this DamageSource's damage is absolute and will ignore potion effects and enchantments.

Returns:

If this damage source deals absolute damage

isBypassingArmor

boolean isBypassingArmor()

Gets whether this DamageSource will deal damage that bypasses any armor.

Returns:

True if this damage source bypasses armor

isScaledByDifficulty

boolean isScaledByDifficulty()

Gets whether this DamageSource's damage is scaled by Difficulty.

Returns:

True if the damage from this source is scaled

isExplosive

boolean isExplosive()

Gets whether this DamageSource is an explosion.

Returns:

True if this damage source is an explosion

isMagic

boolean isMagic()

Gets whether this DamageSource is considered to be magical damage, such as potions, or other sources.

Returns:

If this damage is magic based

doesAffectCreative

boolean doesAffectCreative()

Gets whether this DamageSource is considered to damage creative, or otherwise "normally unharmable" players. Usually associated with DamageTypes.VOID.

Returns:

If this damage should affect creative players

getExhaustion

double getExhaustion()

Gets the amount of exhaustion this DamageSource will add to the entity, generally only to players.

In vanilla gameplay this is set to 0.1 by default and overridden to 0 if the source is set to be absolute or as overriding armor.

Returns:

The increase in exhaustion