org.spongepowered.api.data.property.item

Class HarvestingProperty

java.lang.Object

org.spongepowered.api.data.property.AbstractProperty<String,Set<BlockType>>

org.spongepowered.api.data.property.item.HarvestingProperty

All Implemented Interfaces:

Comparable<Property<?,?>>, Property<String,Set<BlockType>>

public class HarvestingProperty
extends AbstractProperty<String,Set<BlockType>>

Represents a property defining the types of blocks the item can harvest.

Harvestable blocks vary, but if an item can not harvest based on this property, the mined block will not be harvested (dropped as an item). This behavior may be changed by events.

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
HarvestingProperty(Set<BlockType> value) Creates a HarvestingProperty with a specific set of BlockTypes.
HarvestingProperty(Set<BlockType> value, Property.Operator op) Creates a HarvestingProperty with a specific set of BlockTypes.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Property<?,?> o)

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

HarvestingProperty

public HarvestingProperty(@Nullable
                          Set<BlockType> value)

Creates a HarvestingProperty with a specific set of BlockTypes.

Parameters:

value - The harvestable block types

HarvestingProperty

public HarvestingProperty(@Nullable
                          Set<BlockType> value,
                          Property.Operator op)

Creates a HarvestingProperty with a specific set of BlockTypes.

Parameters:

value - The harvestable block types

op - The operator to use when comparing against other properties

Method Detail

compareTo

public int compareTo(Property<?,?> o)