org.spongepowered.api.event.entity

Interface ChangeEntityExperienceEvent

All Superinterfaces:

Cancellable, Event, TargetEntityEvent

All Known Subinterfaces:

HarvestEntityEvent, HarvestEntityEvent.TargetHumanoid, HarvestEntityEvent.TargetLiving, HarvestEntityEvent.TargetPlayer

public interface ChangeEntityExperienceEvent
extends TargetEntityEvent, Cancellable

An event that is related to experience.

Method Summary

Modifier and Type	Method and Description
static ChangeEntityExperienceEvent	createChangeEntityExperienceEvent(Cause cause, int originalExperience, int experience, Entity targetEntity) Deprecated.
default int	getExperience() Deprecated. Use getFinalData() instead, which provides more information about the experience.
ExperienceHolderData	getFinalData() Gets the experience after an event has been processed.
ImmutableExperienceHolderData	getOriginalData() Gets the original values for the experience unmodified by event changes.
default int	getOriginalExperience() Deprecated. Use getOriginalData() instead, which provides more information about the experience.
default void	setExperience(int experience) Deprecated. Modify the value returned by getFinalData() instead, which provides more information about the experience.

Methods inherited from interface org.spongepowered.api.event.entity.TargetEntityEvent

getTargetEntity

Methods inherited from interface org.spongepowered.api.event.Event

getCause, getContext, getSource

Methods inherited from interface org.spongepowered.api.event.Cancellable

isCancelled, setCancelled

Method Detail

getOriginalExperience

@Deprecated
default int getOriginalExperience()

Deprecated. Use getOriginalData() instead, which provides more information about the experience.

Gets the original total experience unmodified by event changes.

Returns:

The experience

getOriginalData

ImmutableExperienceHolderData getOriginalData()

Gets the original values for the experience unmodified by event changes.

Returns:

The experience data

getExperience

@Deprecated
default int getExperience()

Deprecated. Use getFinalData() instead, which provides more information about the experience.

Gets the total experience after event changes.

Returns:

The experience

setExperience

@Deprecated
default void setExperience(int experience)

Deprecated. Modify the value returned by getFinalData() instead, which provides more information about the experience.

Sets the final total experience after event changes.

Parameters:

experience - The experience

getFinalData

ExperienceHolderData getFinalData()

Gets the experience after an event has been processed. Modify this data manipulator to change the final experience.

Returns:

The experience to receive

createChangeEntityExperienceEvent

@Deprecated
static ChangeEntityExperienceEvent createChangeEntityExperienceEvent(Cause cause,
                                                                                 int originalExperience,
                                                                                 int experience,
                                                                                 Entity targetEntity)

Deprecated.

This method exists solely to provide backwards-compatibility with existing plugins using the old ChangeExperienceEvent. It should not be called directly - instead, plugins should use SpongeEventFactory.createChangeEntityExperienceEvent(Cause, ImmutableExperienceHolderData, ExperienceHolderData, Entity)

Parameters:

cause - The cause to use

originalExperience - The original experience amount

experience - New experience amount

targetEntity - The target entity

Returns:

The event