org.spongepowered.api.item.inventory.property

Class SlotPos

java.lang.Object

org.spongepowered.api.item.inventory.property.AbstractInventoryProperty<String,com.flowpowered.math.vector.Vector2i>

org.spongepowered.api.item.inventory.property.SlotPos

All Implemented Interfaces:

Comparable<Property<?,?>>, Property<String,com.flowpowered.math.vector.Vector2i>, InventoryProperty<String,com.flowpowered.math.vector.Vector2i>

public class SlotPos
extends AbstractInventoryProperty<String,com.flowpowered.math.vector.Vector2i>

An inventory property which represents a position within a grid. Bear in mind that this property should be queried against the relevant parent, since a slot may have multiple parent inventories.

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.item.inventory.property.AbstractInventoryProperty

operator, value

Constructor Summary

Constructors

Constructor and Description
SlotPos(int x, int y) Create a new SlotPos property for matching the specified value.
SlotPos(int x, int y, Property.Operator operator) Create a new SlotPos property for matching the specified value with the specified operator.
SlotPos(Object value, Property.Operator operator) Creates a new SlotPos property for matching the specified value with the specified operator.
SlotPos(com.flowpowered.math.vector.Vector2i value) Create a new SlotPos property for matching the specified value.
SlotPos(com.flowpowered.math.vector.Vector2i value, Property.Operator operator) Create a new SlotPos property for matching the specified value with the specified operator.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Property<?,?> other)
int	getX() Gets the X position of this slot within the queried parent.
int	getY() Gets the Y position of this slot within the queried parent.
static SlotPos	greaterThan(Object value) Create an SlotPos property which matches SlotPos properties with value greater than this value.
static SlotPos	greaterThanOrEqual(Object value) Create an SlotPos property which matches SlotPos properties with value greater than or equal to this value.
static SlotPos	lessThan(Object value) Create an SlotPos property which matches SlotPos properties with value less than this value.
static SlotPos	lessThanOrEqual(Object value) Create an SlotPos property which matches SlotPos properties with value less than or equal to this value.
static SlotPos	not(Object value) Create an SlotPos property which matches SlotPos properties with unequal value.
static SlotPos	of(int x, int y) Create an SlotPos property which matches SlotPos properties with equal value.
static SlotPos	of(Object value) Create an SlotPos property which matches SlotPos properties with equal value.

Methods inherited from class org.spongepowered.api.item.inventory.property.AbstractInventoryProperty

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SlotPos

public SlotPos(com.flowpowered.math.vector.Vector2i value)

Create a new SlotPos property for matching the specified value.

Parameters:

value - the value to match

SlotPos

public SlotPos(int x,
               int y)

Create a new SlotPos property for matching the specified value.

Parameters:

x - slot x position

y - slot y position

SlotPos

public SlotPos(com.flowpowered.math.vector.Vector2i value,
               Property.Operator operator)

Create a new SlotPos property for matching the specified value with the specified operator.

Parameters:

value - the value to match

operator - the operator to use when comparing with other properties

SlotPos

public SlotPos(int x,
               int y,
               Property.Operator operator)

Create a new SlotPos property for matching the specified value with the specified operator.

Parameters:

x - slot x position

y - slot y position

operator - the operator to use when comparing with other properties

SlotPos

public SlotPos(Object value,
               Property.Operator operator)

Creates a new SlotPos property for matching the specified value with the specified operator.

Parameters:

value - the value to match

operator - the operator to use when comparing with other properties

Method Detail

getX

public int getX()

Gets the X position of this slot within the queried parent.

Returns:

slot x coordinate

getY

public int getY()

Gets the Y position of this slot within the queried parent.

Returns:

slot y coordinate

compareTo

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

of

public static SlotPos of(Object value)

Create an SlotPos property which matches SlotPos properties with equal value.

Parameters:

value - the value to match

Returns:

new property

of

public static SlotPos of(int x,
                         int y)

Create an SlotPos property which matches SlotPos properties with equal value.

Parameters:

x - the x position of the slot to match

y - the y position of the slot to match

Returns:

new property

not

public static SlotPos not(Object value)

Create an SlotPos property which matches SlotPos properties with unequal value.

Parameters:

value - the value to match

Returns:

new property

greaterThan

public static SlotPos greaterThan(Object value)

Create an SlotPos property which matches SlotPos properties with value greater than this value.

Parameters:

value - the value to match

Returns:

new property

greaterThanOrEqual

public static SlotPos greaterThanOrEqual(Object value)

Create an SlotPos property which matches SlotPos properties with value greater than or equal to this value.

Parameters:

value - the value to match

Returns:

new property

lessThan

public static SlotPos lessThan(Object value)

Create an SlotPos property which matches SlotPos properties with value less than this value.

Parameters:

value - the value to match

Returns:

new property

lessThanOrEqual

public static SlotPos lessThanOrEqual(Object value)

Create an SlotPos property which matches SlotPos properties with value less than or equal to this value.

Parameters:

value - the value to match

Returns:

new property