org.spongepowered.api.data.manipulator.mutable.entity

Interface ExperienceHolderData

All Superinterfaces:

DataManipulator<ExperienceHolderData,ImmutableExperienceHolderData>, DataSerializable, ValueContainer<ExperienceHolderData>

public interface ExperienceHolderData
extends DataManipulator<ExperienceHolderData,ImmutableExperienceHolderData>

Represents the "gained" experience information. Usually experience can be used to enchant weapons and items. Usually applicable to Humanoids.

Method Summary

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

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

asImmutable, copy, fill, fill, from, set, set, set, set, transform

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

MutableBoundedValue<Integer> experienceSinceLevel()

Gets the MutableBoundedValue 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

See Also:

Keys.EXPERIENCE_SINCE_LEVEL

getExperienceBetweenLevels

ImmutableBoundedValue<Integer> getExperienceBetweenLevels()

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

See Also:

Keys.EXPERIENCE_FROM_START_OF_LEVEL

level

MutableBoundedValue<Integer> level()

Gets the MutableBoundedValue 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

See Also:

Keys.EXPERIENCE_LEVEL

totalExperience

MutableBoundedValue<Integer> totalExperience()

Gets the total amount of experience stored.

Returns:

The value of total amount of experience

See Also:

Keys.TOTAL_EXPERIENCE