org.spongepowered.api.data.property

Interface LocationBasePropertyHolder

All Known Subinterfaces:

Chunk, Extent, World

public interface LocationBasePropertyHolder

Method Summary

Modifier and Type	Method and Description
Collection<Direction>	getFacesWithProperty(int x, int y, int z, Class<? extends Property<?,?>> propertyClass) Gets all the faces of this block that have the given property.
default Collection<Direction>	getFacesWithProperty(com.flowpowered.math.vector.Vector3i coords, Class<? extends Property<?,?>> propertyClass) Gets all the faces of this block that have the given property.
Collection<Property<?,?>>	getProperties(int x, int y, int z) Gets an immutable collection of all known Propertys pertaining to this PropertyHolder.
default Collection<Property<?,?>>	getProperties(com.flowpowered.math.vector.Vector3i coords) Gets an immutable collection of all known Propertys pertaining to this PropertyHolder.
<T extends Property<?,?>> Optional<T>	getProperty(int x, int y, int z, Class<T> propertyClass) Attempts to retrieve a specific Property type of this PropertyHolder.
<T extends Property<?,?>> Optional<T>	getProperty(int x, int y, int z, Direction direction, Class<T> propertyClass) Attempts to retrieve a specific Property type of the block at the specific location on the given block face.
default <T extends Property<?,?>> Optional<T>	getProperty(com.flowpowered.math.vector.Vector3i coords, Class<T> propertyClass) Attempts to retrieve a specific Property type of the block at the specific location.
default <T extends Property<?,?>> Optional<T>	getProperty(com.flowpowered.math.vector.Vector3i coords, Direction direction, Class<T> propertyClass) Attempts to retrieve a specific Property type of the block at the specific location on the given block face.

Method Detail

getProperty

default <T extends Property<?,?>> Optional<T> getProperty(com.flowpowered.math.vector.Vector3i coords,
                                                          Class<T> propertyClass)

Attempts to retrieve a specific Property type of the block at the specific location. If the property is not applicable, Optional.empty() is returned.

properties can define various immutable information about a PropertyHolder that is dependent on the instance of the holder. As properties cannot be changed, the PropertyHolder can not change the information about its own properties either.

Type Parameters:

T - The type of property

Parameters:

coords - The coordinates

propertyClass - The property class

Returns:

The property, if available

getProperty

<T extends Property<?,?>> Optional<T> getProperty(int x,
                                                  int y,
                                                  int z,
                                                  Class<T> propertyClass)

Attempts to retrieve a specific Property type of this PropertyHolder. If the property is not applicable, Optional.empty() is returned.

properties can define various immutable information about a PropertyHolder that is dependent on the instance of the holder. As properties cannot be changed, the PropertyHolder can not change the information about it's own properties either.

Type Parameters:

T - The type of property

Parameters:

x - The x coordinate

y - The y coordinate

z - The z coordinate

propertyClass - The property class

Returns:

The property, if available

getProperty

default <T extends Property<?,?>> Optional<T> getProperty(com.flowpowered.math.vector.Vector3i coords,
                                                          Direction direction,
                                                          Class<T> propertyClass)

Attempts to retrieve a specific Property type of the block at the specific location on the given block face. If the property is not applicable, Optional.empty() is returned.

properties can define various immutable information about a PropertyHolder that is dependent on the instance of the holder. As properties cannot be changed, the PropertyHolder can not change the information about it's own properties either.

Type Parameters:

T - The type of property

Parameters:

coords - The coordinates

direction - The face of the block

propertyClass - The property class

Returns:

The property, if available

getProperty

<T extends Property<?,?>> Optional<T> getProperty(int x,
                                                  int y,
                                                  int z,
                                                  Direction direction,
                                                  Class<T> propertyClass)

Attempts to retrieve a specific Property type of the block at the specific location on the given block face. If the property is not applicable, Optional.empty() is returned.

properties can define various immutable information about a PropertyHolder that is dependent on the instance of the holder. As properties cannot be changed, the PropertyHolder can not change the information about it's own properties either.

Type Parameters:

T - The type of property

Parameters:

x - The x coordinate

y - The y coordinate

z - The z coordinate

direction - The face of the block

propertyClass - The property class

Returns:

The property, if available

getProperties

default Collection<Property<?,?>> getProperties(com.flowpowered.math.vector.Vector3i coords)

Gets an immutable collection of all known Propertys pertaining to this PropertyHolder.

properties can not be changed such that the property is attached to the instance of the residing PropertyHolder.

Parameters:

coords - The coordinates

Returns:

An immutable collection of all known properties

getProperties

Collection<Property<?,?>> getProperties(int x,
                                        int y,
                                        int z)

Gets an immutable collection of all known Propertys pertaining to this PropertyHolder.

properties can not be changed such that the property is attached to the instance of the residing PropertyHolder.

Parameters:

x - The x coordinate

y - The y coordinate

z - The z coordinate

Returns:

An immutable collection of all known Propertys

getFacesWithProperty

default Collection<Direction> getFacesWithProperty(com.flowpowered.math.vector.Vector3i coords,
                                                   Class<? extends Property<?,?>> propertyClass)

Gets all the faces of this block that have the given property.

Parameters:

coords - The coordinates

propertyClass - The property class

Returns:

All faces with the property

getFacesWithProperty

Collection<Direction> getFacesWithProperty(int x,
                                           int y,
                                           int z,
                                           Class<? extends Property<?,?>> propertyClass)

Gets all the faces of this block that have the given property.

Parameters:

x - The x coordinate

y - The y coordinate

z - The z coordinate

propertyClass - The property class

Returns:

All faces with the property