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

Interface HealingSource

All Known Subinterfaces:

BlockHealingSource, EntityHealingSource, IndirectEntityHealingSource

All Known Implementing Classes:

AbstractEntityHealingSource, AbstractHealingSource

public interface HealingSource

Represents a Cause for damage on the Entity being healed. This will help inform what type of healing

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	HealingSource.Builder A builder to build HealingSource specifically.
static interface	HealingSource.HealingSourceBuilder<T extends HealingSource,B extends HealingSource.HealingSourceBuilder<T,B>> An abstract builder to build an extension of HealingSource.

Method Summary

Modifier and Type	Method and Description
static HealingSource.Builder	builder() Creates a new HealingSource.Builder to construct a new HealingSource.
HealingType	getHealingType() Gets the HealingType for this source.
boolean	isDifficultyScaled() Gets whether this HealingSource's healing amount is scaled by Difficulty.
boolean	isMagic() Gets whether this HealingSource is considered to be magical healing, such as potions, or other sources.

Method Detail

builder

static HealingSource.Builder builder()

Creates a new HealingSource.Builder to construct a new HealingSource.

Returns:

A new builder

getHealingType

HealingType getHealingType()

Gets the HealingType for this source.

Returns:

The healing type for this source

isDifficultyScaled

boolean isDifficultyScaled()

Gets whether this HealingSource's healing amount is scaled by Difficulty.

Returns:

True if the damage from this source is scaled

isMagic

boolean isMagic()

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

Returns:

If this healing is magic based