org.spongepowered.api.data.property.entity

Class DominantHandProperty

java.lang.Object

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

org.spongepowered.api.data.property.entity.DominantHandProperty

All Implemented Interfaces:

Comparable<Property<?,?>>, Property<String,HandPreference>

public class DominantHandProperty
extends AbstractProperty<String,HandPreference>

Represents a Property for the dominant HandPreference of a Player.

Handedness usually determines which hand is used for "main" interactions, such as tool use or block breaking.

NOTE: This only applies to Players, for Living entities see DominantHandData.

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
DominantHandProperty(HandPreference value) Creates a new DominantHandProperty with the provided HandPreference value.
DominantHandProperty(HandPreference value, Property.Operator op) Creates a new DominantHandProperty with the provided HandPreference and Property.Operator value.

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

DominantHandProperty

public DominantHandProperty(@Nullable
                            HandPreference value)

Creates a new DominantHandProperty with the provided HandPreference value.

Parameters:

value - The value

DominantHandProperty

public DominantHandProperty(@Nullable
                            HandPreference value,
                            @Nullable
                            Property.Operator op)

Creates a new DominantHandProperty with the provided HandPreference and Property.Operator value.

Parameters:

value - The value

op - The operator for comparison

Method Detail

compareTo

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