org.spongepowered.api.data.manipulator.immutable.entity

Interface ImmutableExperienceHolderData

All Superinterfaces:

DataSerializable, ImmutableDataManipulator<ImmutableExperienceHolderData,ExperienceHolderData>, ValueContainer<ImmutableExperienceHolderData>

public interface ImmutableExperienceHolderData
extends ImmutableDataManipulator<ImmutableExperienceHolderData,ExperienceHolderData>

An ImmutableDataManipulator handling the "experience" held by a DataHolder. Usually the mechanics of "experience" is that it is accumulated by a Humanoid and can be spent on creating Enchantments or renaming ItemStacks.

Method Summary

Modifier and Type	Method and Description
ImmutableBoundedValue<Integer>	experienceBetweenLevels() Gets the ImmutableBoundedValue for the amount of experience required between the current level() and the next level.
ImmutableBoundedValue<Integer>	experienceSinceLevel() Gets the ImmutableBoundedValue for the amount of experience gained since the beginning of the current level().
ImmutableBoundedValue<Integer>	level() Gets the ImmutableBoundedValue for the current "level" of experience deserved according to the totalExperience() and a function from implementation defining how much experience required per level.
ImmutableBoundedValue<Integer>	totalExperience() Gets the total amount of experience stored.

Methods inherited from interface org.spongepowered.api.data.manipulator.ImmutableDataManipulator

asMutable, copy, with, with

Methods inherited from interface org.spongepowered.api.data.DataSerializable

getContentVersion, toContainer

Methods inherited from interface org.spongepowered.api.data.value.ValueContainer

get, getKeys, getOrElse, getOrNull, getValue, getValues, require, supports, supports

Method Detail

experienceSinceLevel

ImmutableBoundedValue<Integer> experienceSinceLevel()

Gets the ImmutableBoundedValue for the amount of experience gained since the beginning of the current level(). Normally, the higher the level, the more "experience" required to gain another level.

Returns:

The bounded value of experience since the beginning of the current level

experienceBetweenLevels

ImmutableBoundedValue<Integer> experienceBetweenLevels()

Gets the ImmutableBoundedValue for the amount of experience required between the current level() and the next level. This can be presumed to be the supposed "maximum" for the experienceSinceLevel() amount.

Returns:

The immutable bounded required experience between levels

level

ImmutableBoundedValue<Integer> level()

Gets the ImmutableBoundedValue for the current "level" of experience deserved according to the totalExperience() and a function from implementation defining how much experience required per level.

Returns:

The current level according to the amount of total experience

totalExperience

ImmutableBoundedValue<Integer> totalExperience()

Gets the total amount of experience stored.

Returns:

The immutable value of total amount of experience