org.spongepowered.api.data.property.item

Class SaturationProperty

java.lang.Object

org.spongepowered.api.data.property.AbstractProperty<String,Double>

org.spongepowered.api.data.property.DoubleProperty

org.spongepowered.api.data.property.item.SaturationProperty

All Implemented Interfaces:

Comparable<Property<?,?>>, Property<String,Double>

public class SaturationProperty
extends DoubleProperty

Represents an item property that replenishes saturation upon use or consumption. Examples of items that have these properties: any food item.

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.data.Property

Property.Operator

Field Summary

Fields inherited from class org.spongepowered.api.data.property.AbstractProperty

operator, value

Constructor Summary

Constructors

Constructor and Description
SaturationProperty(Double value) Creates a new SaturationProperty.
SaturationProperty(Double value, Property.Operator op) Creates a new SaturationProperty.

Method Summary

Methods inherited from class org.spongepowered.api.data.property.DoubleProperty

compareTo

Methods inherited from class org.spongepowered.api.data.property.AbstractProperty

equals, getDefaultKey, getDefaultOperator, getKey, getOperator, getValue, hashCode, hashCodeOf, matches, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SaturationProperty

public SaturationProperty(@Nullable
                          Double value)

Creates a new SaturationProperty.

Parameters:

value - The value of saturation replenished upon use

SaturationProperty

public SaturationProperty(@Nullable
                          Double value,
                          Property.Operator op)

Creates a new SaturationProperty.

Parameters:

value - The value of saturation replenished upon use

op - The operator to use to compare to other properties