org.spongepowered.api.world.extent

Interface LocationCompositeValueStore

All Known Subinterfaces:

Chunk, Extent, World

public interface LocationCompositeValueStore

A type of Location based value store that can handle proxied data api related queries for specific positions.

Method Summary

Modifier and Type	Method and Description
DataTransactionResult	copyFrom(int xTo, int yTo, int zTo, DataHolder from) Attempts to copy all the relevant data from the provided DataHolder to the block at the provided coordinates.
DataTransactionResult	copyFrom(int xTo, int yTo, int zTo, DataHolder from, MergeFunction function) Attempts to copy all ImmutableValues from the provided block to provided block to the provided block coordinates.
default DataTransactionResult	copyFrom(int xTo, int yTo, int zTo, int xFrom, int yFrom, int zFrom) Attempts to copy all ImmutableValues from the provided block to provided block to the provided block coordinates.
DataTransactionResult	copyFrom(int xTo, int yTo, int zTo, int xFrom, int yFrom, int zFrom, MergeFunction function) Attempts to copy all ImmutableValues from the provided block to provided block to the provided block coordinates.
default DataTransactionResult	copyFrom(com.flowpowered.math.vector.Vector3i to, DataHolder from) Attempts to copy all the relevant data from the provided DataHolder to the block at the provided coordinates.
default DataTransactionResult	copyFrom(com.flowpowered.math.vector.Vector3i to, DataHolder from, MergeFunction function) Attempts to copy all ImmutableValues from the provided block to provided block to the provided block coordinates.
default DataTransactionResult	copyFrom(com.flowpowered.math.vector.Vector3i coordinatesTo, com.flowpowered.math.vector.Vector3i coordinatesFrom) Attempts to copy all the relevant data from the provided DataHolder to the block at the provided coordinates.
default DataTransactionResult	copyFrom(com.flowpowered.math.vector.Vector3i coordinatesTo, com.flowpowered.math.vector.Vector3i coordinatesFrom, MergeFunction function) Attempts to copy all ImmutableValues from the provided block to provided block to the provided block coordinates.
<T extends DataManipulator<?,?>> Optional<T>	get(int x, int y, int z, Class<T> manipulatorClass) Gets an instance of the given data class for given block at the location.
<E> Optional<E>	get(int x, int y, int z, Key<? extends BaseValue<E>> key) Gets the value of data that is keyed to the provided Key at the give block location.
default <T extends DataManipulator<?,?>> Optional<T>	get(com.flowpowered.math.vector.Vector3i coordinates, Class<T> manipulatorClass) Gets an instance of the given data class for given block at the location.
default <E> Optional<E>	get(com.flowpowered.math.vector.Vector3i coordinates, Key<? extends BaseValue<E>> key) Gets the value of data that is keyed to the provided Key at the give block location.
Set<Key<?>>	getKeys(int x, int y, int z) Gets an ImmutableSet of Keys for the block at the given location.
default Set<Key<?>>	getKeys(com.flowpowered.math.vector.Vector3i coordinates) Gets an ImmutableSet of Keys for the block at the given location.
Collection<DataManipulator<?,?>>	getManipulators(int x, int y, int z) Gets an copied collection of all known DataManipulators belonging to the block at the given position.
default Collection<DataManipulator<?,?>>	getManipulators(com.flowpowered.math.vector.Vector3i coordinates) Gets an copied collection of all known DataManipulators belonging to the block at the given position.
<T extends DataManipulator<?,?>> Optional<T>	getOrCreate(int x, int y, int z, Class<T> manipulatorClass) Gets or creates a new DataManipulator that can be accepted by the block at the location.
default <T extends DataManipulator<?,?>> Optional<T>	getOrCreate(com.flowpowered.math.vector.Vector3i coordinates, Class<T> manipulatorClass) Gets or creates a new DataManipulator that can be accepted by the block at the location.
default <E> E	getOrElse(int x, int y, int z, Key<? extends BaseValue<E>> key, E defaultValue) Gets the value of data that is keyed to the provided Key at the give block location.
default <E> E	getOrElse(com.flowpowered.math.vector.Vector3i coordinates, Key<? extends BaseValue<E>> key, E defaultValue) Gets the value of data that is keyed to the provided Key at the give block location.
default <E> E	getOrNull(int x, int y, int z, Key<? extends BaseValue<E>> key) Gets the value of data that is keyed to the provided Key at the give block location.
default <E> E	getOrNull(com.flowpowered.math.vector.Vector3i coordinates, Key<? extends BaseValue<E>> key) Gets the value of data that is keyed to the provided Key at the give block location.
<E,V extends BaseValue<E>> Optional<V>	getValue(int x, int y, int z, Key<V> key) Gets the value of data that is keyed to the provided Key at the give block location.
default <E,V extends BaseValue<E>> Optional<V>	getValue(com.flowpowered.math.vector.Vector3i coordinates, Key<V> key) Gets the value of data that is keyed to the provided Key at the give block location.
Set<ImmutableValue<?>>	getValues(int x, int y, int z) Gets an ImmutableSet of ImmutableValues for the block at the given location.
default Set<ImmutableValue<?>>	getValues(com.flowpowered.math.vector.Vector3i coordinates) Gets an ImmutableSet of ImmutableValues for the block at the given location.
default <E> DataTransactionResult	offer(int x, int y, int z, BaseValue<E> value) Offers the given BaseValue to the block at the given position.
default DataTransactionResult	offer(int x, int y, int z, DataManipulator<?,?> manipulator) Offers the given DataManipulator to the block at the given position.
DataTransactionResult	offer(int x, int y, int z, DataManipulator<?,?> manipulator, MergeFunction function) Offers the given DataManipulator to the block at the given position.
default DataTransactionResult	offer(int x, int y, int z, Iterable<DataManipulator<?,?>> manipulators) Offers the provided DataManipulators to the block at the given position.
<E> DataTransactionResult	offer(int x, int y, int z, Key<? extends BaseValue<E>> key, E value) Offers the given E value that is keyed by the provided Key to the block at the provided location.
default <E> DataTransactionResult	offer(com.flowpowered.math.vector.Vector3i coordinates, BaseValue<E> value) Offers the given BaseValue to the block at the given position.
default DataTransactionResult	offer(com.flowpowered.math.vector.Vector3i coordinates, DataManipulator<?,?> manipulator) Offers the given DataManipulator to the block at the given position.
default DataTransactionResult	offer(com.flowpowered.math.vector.Vector3i coordinates, DataManipulator<?,?> manipulator, MergeFunction function) Offers the given DataManipulator to the block at the given position.
default DataTransactionResult	offer(com.flowpowered.math.vector.Vector3i coordinates, Iterable<DataManipulator<?,?>> manipulators) Offers the provided DataManipulators to the block at the given position.
default DataTransactionResult	offer(com.flowpowered.math.vector.Vector3i blockPosition, Iterable<DataManipulator<?,?>> values, MergeFunction function) Offers the provided DataManipulators to the block at the given position.
default <E> DataTransactionResult	offer(com.flowpowered.math.vector.Vector3i coordinates, Key<? extends BaseValue<E>> key, E value) Offers the given E value that is keyed by the provided Key to the block at the provided location.
DataTransactionResult	remove(int x, int y, int z, Class<? extends DataManipulator<?,?>> manipulatorClass) Attempts to remove the given DataManipulator represented by the block at the given location if possible.
DataTransactionResult	remove(int x, int y, int z, Key<?> key) Attempts to remove the data associated with the provided Key from the block at the provided location.
default DataTransactionResult	remove(com.flowpowered.math.vector.Vector3i coordinates, Class<? extends DataManipulator<?,?>> manipulatorClass) Attempts to remove the given DataManipulator represented by the block at the given location if possible.
default DataTransactionResult	remove(com.flowpowered.math.vector.Vector3i coordinates, Key<?> key) Attempts to remove the data associated with the provided Key from the block at the provided location.
void	setRawData(int x, int y, int z, DataView container) Attempts to set all data of the block at the given position according to the DataContainer's held information.
default void	setRawData(com.flowpowered.math.vector.Vector3i position, DataView container) Attempts to set all data of the block at the given position according to the DataContainer's held information.
default boolean	supports(int x, int y, int z, BaseValue<?> value) Checks if the provided BaseValue is supported by the block at the provided location.
boolean	supports(int x, int y, int z, Class<? extends DataManipulator<?,?>> manipulatorClass) Checks if the given DataManipulator class is able to represent data within the block at the given position.
default boolean	supports(int x, int y, int z, DataManipulator<?,?> manipulator) Checks if the given DataManipulator class is able to represent data within the block at the given position.
boolean	supports(int x, int y, int z, Key<?> key) Checks if the provided Key to the data is supported by the block at the provided location.
default boolean	supports(com.flowpowered.math.vector.Vector3i coordinates, BaseValue<?> value) Checks if the provided BaseValue is supported by the block at the provided location.
default boolean	supports(com.flowpowered.math.vector.Vector3i coordinates, Class<? extends DataManipulator<?,?>> manipulatorClass) Checks if the given DataManipulator class is able to represent data within the block at the given position.
default boolean	supports(com.flowpowered.math.vector.Vector3i coordinates, DataManipulator<?,?> manipulator) Checks if the given DataManipulator class is able to represent data within the block at the given position.
default boolean	supports(com.flowpowered.math.vector.Vector3i coordinates, Key<?> key) Checks if the provided Key to the data is supported by the block at the provided location.
default <E> DataTransactionResult	transform(int x, int y, int z, Key<? extends BaseValue<E>> key, Function<E,E> function) Applies a transformation on the pre-existing value of the data keyed by the provided Key and returns a DataTransactionResult of said transformation.
default <E> DataTransactionResult	transform(com.flowpowered.math.vector.Vector3i coordinates, Key<? extends BaseValue<E>> key, Function<E,E> function) Applies a transformation on the pre-existing value of the data keyed by the provided Key and returns a DataTransactionResult of said transformation.
DataTransactionResult	undo(int x, int y, int z, DataTransactionResult result) Attempts to undo a DataTransactionResult.
default DataTransactionResult	undo(com.flowpowered.math.vector.Vector3i coordinates, DataTransactionResult result) Attempts to undo a DataTransactionResult.
boolean	validateRawData(int x, int y, int z, DataView container) Validates the container with known data required to set the raw data to the block at the given position.
default boolean	validateRawData(com.flowpowered.math.vector.Vector3i position, DataView container) Validates the container with known data required to set the raw data to the block at the given position.

Method Detail

get

default <E> Optional<E> get(com.flowpowered.math.vector.Vector3i coordinates,
                            Key<? extends BaseValue<E>> key)

Gets the value of data that is keyed to the provided Key at the give block location.

Type Parameters:

E - The type of element of data

Parameters:

coordinates - The position of the block

key - The key to the data

Returns:

The data, if available

get

<E> Optional<E> get(int x,
                    int y,
                    int z,
                    Key<? extends BaseValue<E>> key)

Gets the value of data that is keyed to the provided Key at the give block location.

Type Parameters:

E - The type of element of data

Parameters:

x - The X position

y - The Y position

z - The Z position

key - The key to the data

Returns:

The data, if available

get

default <T extends DataManipulator<?,?>> Optional<T> get(com.flowpowered.math.vector.Vector3i coordinates,
                                                         Class<T> manipulatorClass)

Gets an instance of the given data class for given block at the location.

If there is no pre-existing data that can be represented by the given DataManipulator class, Optional.empty() is returned.

Type Parameters:

T - The type of data

Parameters:

coordinates - The position of the block

manipulatorClass - The data class

Returns:

An instance of the class, if not available

get

<T extends DataManipulator<?,?>> Optional<T> get(int x,
                                                 int y,
                                                 int z,
                                                 Class<T> manipulatorClass)

Gets an instance of the given data class for given block at the location.

If there is no pre-existing data that can be represented by the given DataManipulator class, Optional.empty() is returned.

Type Parameters:

T - The type of data

Parameters:

x - The X position

y - The Y position

z - The Z position

manipulatorClass - The data class

Returns:

An instance of the class, if not available

getOrCreate

default <T extends DataManipulator<?,?>> Optional<T> getOrCreate(com.flowpowered.math.vector.Vector3i coordinates,
                                                                 Class<T> manipulatorClass)

Gets or creates a new DataManipulator that can be accepted by the block at the location. In the event that there is no data that can be represented by the given DataManipulator, a new DataManipulator object is created with default values.

In the event the DataManipulator can not represent any data pertaining to the block at the location, Optional.empty() is returned.

Type Parameters:

T - The type of data

Parameters:

coordinates - The position of the block

manipulatorClass - The data class

Returns:

An instance of the class, if not available

getOrCreate

<T extends DataManipulator<?,?>> Optional<T> getOrCreate(int x,
                                                         int y,
                                                         int z,
                                                         Class<T> manipulatorClass)

Gets or creates a new DataManipulator that can be accepted by the block at the location. In the event that there is no data that can be represented by the given DataManipulator, a new DataManipulator object is created with default values.

In the event the DataManipulator can not represent any data pertaining to the block at the location, Optional.empty() is returned.

Type Parameters:

T - The type of data

Parameters:

x - The X position

y - The Y position

z - The Z position

manipulatorClass - The data class

Returns:

An instance of the class, if not available

getOrNull

@Nullable
default <E> E getOrNull(com.flowpowered.math.vector.Vector3i coordinates,
                                   Key<? extends BaseValue<E>> key)

Gets the value of data that is keyed to the provided Key at the give block location. The data may not exist, or may not be compatible in which case null may be returned.

Type Parameters:

E - The type of element of data

Parameters:

coordinates - The position of the block

key - The key to the data

Returns:

The data or null

getOrNull

@Nullable
default <E> E getOrNull(int x,
                                   int y,
                                   int z,
                                   Key<? extends BaseValue<E>> key)

Gets the value of data that is keyed to the provided Key at the give block location. The data may not exist, or may not be compatible in which case null may be returned.

Type Parameters:

E - The type of element of data

Parameters:

x - The X position

y - The Y position

z - The Z position

key - The key to the data

Returns:

The data or null

getOrElse

default <E> E getOrElse(com.flowpowered.math.vector.Vector3i coordinates,
                        Key<? extends BaseValue<E>> key,
                        E defaultValue)

Gets the value of data that is keyed to the provided Key at the give block location. The data may not exist, or may not be compatible in which case the default value may be returned.

Type Parameters:

E - The type of element of data

Parameters:

coordinates - The position of the block

key - The key to the data

defaultValue - The default value to be provided

Returns:

The data or null

getOrElse

default <E> E getOrElse(int x,
                        int y,
                        int z,
                        Key<? extends BaseValue<E>> key,
                        E defaultValue)

Gets the value of data that is keyed to the provided Key at the give block location. The data may not exist, or may not be compatible in which case the default value may be returned.

Type Parameters:

E - The type of element of data

Parameters:

x - The X position

y - The Y position

z - The Z position

key - The key to the data

defaultValue - The default value to return

Returns:

The data or null

getValue

default <E,V extends BaseValue<E>> Optional<V> getValue(com.flowpowered.math.vector.Vector3i coordinates,
                                                        Key<V> key)

Gets the value of data that is keyed to the provided Key at the give block location. The data may not exist, or may not be compatible in which case null may be returned.

Type Parameters:

E - The type of element of data

V - The type of value

Parameters:

coordinates - The position of the block

key - The key to the data

Returns:

The base value, if available

getValue

<E,V extends BaseValue<E>> Optional<V> getValue(int x,
                                                int y,
                                                int z,
                                                Key<V> key)

Gets the value of data that is keyed to the provided Key at the give block location.

Type Parameters:

E - The type of element of data

V - The type of value

Parameters:

x - The X position

y - The Y position

z - The Z position

key - The key to the data

Returns:

The base value, if available

supports

default boolean supports(com.flowpowered.math.vector.Vector3i coordinates,
                         Key<?> key)

Checks if the provided Key to the data is supported by the block at the provided location.

Parameters:

coordinates - The position of the block

key - The Key to the value of data

Returns:

True if the block supports the data

supports

boolean supports(int x,
                 int y,
                 int z,
                 Key<?> key)

Checks if the provided Key to the data is supported by the block at the provided location.

Parameters:

x - The X coordinate

y - The Y coordinate

z - The Z coordinate

key - The Key to the value of data

Returns:

True if the block supports the data

supports

default boolean supports(com.flowpowered.math.vector.Vector3i coordinates,
                         BaseValue<?> value)

Checks if the provided BaseValue is supported by the block at the provided location.

Parameters:

coordinates - The position of the block

value - The value of data

Returns:

True if the block supports the data

supports

default boolean supports(int x,
                         int y,
                         int z,
                         BaseValue<?> value)

Checks if the provided BaseValue is supported by the block at the provided location.

Parameters:

x - The X coordinate

y - The Y coordinate

z - The Z coordinate

value - The value of data

Returns:

True if the block supports the data

supports

default boolean supports(com.flowpowered.math.vector.Vector3i coordinates,
                         Class<? extends DataManipulator<?,?>> manipulatorClass)

Checks if the given DataManipulator class is able to represent data within the block at the given position.

Parameters:

coordinates - The position of the block

manipulatorClass - The data class

Returns:

True if the block at the given position can accept the DataManipulator object

supports

boolean supports(int x,
                 int y,
                 int z,
                 Class<? extends DataManipulator<?,?>> manipulatorClass)

Checks if the given DataManipulator class is able to represent data within the block at the given position.

Parameters:

x - The X position

y - The Y position

z - The Z position

manipulatorClass - The data class

Returns:

True if the block at the given position can accept the DataManipulator object

supports

default boolean supports(com.flowpowered.math.vector.Vector3i coordinates,
                         DataManipulator<?,?> manipulator)

Checks if the given DataManipulator class is able to represent data within the block at the given position.

Parameters:

coordinates - The position of the block

manipulator - The manipulator

Returns:

True if the block at the given position can accept the DataManipulator object

supports

default boolean supports(int x,
                         int y,
                         int z,
                         DataManipulator<?,?> manipulator)

Checks if the given DataManipulator class is able to represent data within the block at the given position.

Parameters:

x - The X position

y - The Y position

z - The Z position

manipulator - The manipulator

Returns:

True if the block at the given position can accept the DataManipulator object

getKeys

default Set<Key<?>> getKeys(com.flowpowered.math.vector.Vector3i coordinates)

Gets an ImmutableSet of Keys for the block at the given location.

Parameters:

coordinates - The position of the block

Returns:

The immutable set of values for the block

getKeys

Set<Key<?>> getKeys(int x,
                    int y,
                    int z)

Gets an ImmutableSet of Keys for the block at the given location.

Parameters:

x - The X position

y - The Y position

z - The Z position

Returns:

The immutable set of values for the block

getValues

default Set<ImmutableValue<?>> getValues(com.flowpowered.math.vector.Vector3i coordinates)

Gets an ImmutableSet of ImmutableValues for the block at the given location.

Parameters:

coordinates - The position of the block

Returns:

The immutable set of values for the block

getValues

Set<ImmutableValue<?>> getValues(int x,
                                 int y,
                                 int z)

Gets an ImmutableSet of ImmutableValues for the block at the given location.

Parameters:

x - The X position

y - The Y position

z - The Z position

Returns:

The immutable set of values for the block

transform

default <E> DataTransactionResult transform(com.flowpowered.math.vector.Vector3i coordinates,
                                            Key<? extends BaseValue<E>> key,
                                            Function<E,E> function)

Applies a transformation on the pre-existing value of the data keyed by the provided Key and returns a DataTransactionResult of said transformation.

Type Parameters:

E - The type of data

Parameters:

coordinates - The position of the block

key - The key to the data

function - The function applying the transformation

Returns:

The transaction result

transform

default <E> DataTransactionResult transform(int x,
                                            int y,
                                            int z,
                                            Key<? extends BaseValue<E>> key,
                                            Function<E,E> function)

Applies a transformation on the pre-existing value of the data keyed by the provided Key and returns a DataTransactionResult of said transformation.

Type Parameters:

E - The type of data

Parameters:

x - The X position

y - The Y position

z - The Z position

key - The key to the data

function - The function applying the transformation

Returns:

The transaction result

offer

default <E> DataTransactionResult offer(com.flowpowered.math.vector.Vector3i coordinates,
                                        Key<? extends BaseValue<E>> key,
                                        E value)

Offers the given E value that is keyed by the provided Key to the block at the provided location.

If any data is rejected or existing data is replaced, the DataTransactionResult will retain the rejected and replaced data.

Type Parameters:

E - The type of data being offered

Parameters:

coordinates - The position of the block

key - The key for the data

value - The value to offer

Returns:

The transaction result

offer

<E> DataTransactionResult offer(int x,
                                int y,
                                int z,
                                Key<? extends BaseValue<E>> key,
                                E value)

Offers the given E value that is keyed by the provided Key to the block at the provided location.

If any data is rejected or existing data is replaced, the DataTransactionResult will retain the rejected and replaced data.

Type Parameters:

E - The type of data being offered

Parameters:

x - The X position

y - The Y position

z - The Z position

key - The key for the data

value - The value to offer

Returns:

The transaction result

offer

default <E> DataTransactionResult offer(com.flowpowered.math.vector.Vector3i coordinates,
                                        BaseValue<E> value)

Offers the given BaseValue to the block at the given position.

If any data is rejected or existing data is replaced, the DataTransactionResult will retain the rejected and replaced data.

Type Parameters:

E - The type of the element wrapped by the value

Parameters:

coordinates - The position of the block

value - The value to offer

Returns:

The transaction result

offer

default <E> DataTransactionResult offer(int x,
                                        int y,
                                        int z,
                                        BaseValue<E> value)

Offers the given BaseValue to the block at the given position.

If any data is rejected or existing data is replaced, the DataTransactionResult will retain the rejected and replaced data.

Type Parameters:

E - The type of the element wrapped by the value

Parameters:

x - The X position

y - The Y position

z - The Z position

value - The value to offer

Returns:

The transaction result

offer

default DataTransactionResult offer(com.flowpowered.math.vector.Vector3i coordinates,
                                    DataManipulator<?,?> manipulator)

Offers the given DataManipulator to the block at the given position.

If any data is rejected or existing data is replaced, the DataTransactionResult will retain the rejected and replaced data.

Parameters:

coordinates - The position of the block

manipulator - The manipulator data to offer

Returns:

The transaction result

offer

default DataTransactionResult offer(int x,
                                    int y,
                                    int z,
                                    DataManipulator<?,?> manipulator)

Offers the given DataManipulator to the block at the given position.

If any data is rejected or existing data is replaced, the DataTransactionResult will retain the rejected and replaced data.

Parameters:

x - The X position

y - The Y position

z - The Z position

manipulator - The manipulator data to offer

Returns:

The transaction result

offer

default DataTransactionResult offer(com.flowpowered.math.vector.Vector3i coordinates,
                                    DataManipulator<?,?> manipulator,
                                    MergeFunction function)

Offers the given DataManipulator to the block at the given position.

If any data is rejected or existing data is replaced, the DataTransactionResult will retain the rejected and replaced data.

Parameters:

coordinates - The position of the block

manipulator - The manipulator data to offer

function - The merge function to resolve conflicts

Returns:

The transaction result

offer

DataTransactionResult offer(int x,
                            int y,
                            int z,
                            DataManipulator<?,?> manipulator,
                            MergeFunction function)

Offers the given DataManipulator to the block at the given position.

If any data is rejected or existing data is replaced, the DataTransactionResult will retain the rejected and replaced data.

Parameters:

x - The X position

y - The Y position

z - The Z position

manipulator - The manipulator data to offer

function - The merge function to resolve conflicts

Returns:

The transaction result

offer

default DataTransactionResult offer(com.flowpowered.math.vector.Vector3i coordinates,
                                    Iterable<DataManipulator<?,?>> manipulators)

Offers the provided DataManipulators to the block at the given position.

If any data is rejected or existing data is replaced, the DataTransactionResult will retain the rejected, replaced, and successfully offered data.

Parameters:

coordinates - The position of the block

manipulators - The values to offer

Returns:

The transaction result

offer

default DataTransactionResult offer(int x,
                                    int y,
                                    int z,
                                    Iterable<DataManipulator<?,?>> manipulators)

Offers the provided DataManipulators to the block at the given position.

If any data is rejected or existing data is replaced, the DataTransactionResult will retain the rejected, replaced, and successfully offered data.

Parameters:

x - The X position

y - The Y position

z - The Z position

manipulators - The values to offer

Returns:

The transaction result

offer

default DataTransactionResult offer(com.flowpowered.math.vector.Vector3i blockPosition,
                                    Iterable<DataManipulator<?,?>> values,
                                    MergeFunction function)

Offers the provided DataManipulators to the block at the given position. If there's any overlaps of data, the provided MergeFunction is used to delegate the merges. It is possible to recycle MergeFunctions provided that the MergeFunction is aware of being usable in multiple environments.

If any data is rejected or existing data is replaced, the DataTransactionResult will retain the rejected, replaced, and successfully offered data.

Parameters:

blockPosition - The block position

values - The values to offer

function - The merge function to resolve conflicts

Returns:

The transaction result

remove

default DataTransactionResult remove(com.flowpowered.math.vector.Vector3i coordinates,
                                     Class<? extends DataManipulator<?,?>> manipulatorClass)

Attempts to remove the given DataManipulator represented by the block at the given location if possible.

Certain DataManipulators can not be removed due to certain dependencies relying on the particular data to function.

Parameters:

coordinates - The position of the block

manipulatorClass - The data class

Returns:

If the manipulator was removed

remove

DataTransactionResult remove(int x,
                             int y,
                             int z,
                             Class<? extends DataManipulator<?,?>> manipulatorClass)

Attempts to remove the given DataManipulator represented by the block at the given location if possible.

Certain DataManipulators can not be removed due to certain dependencies relying on the particular data to function.

Parameters:

x - The X position

y - The Y position

z - The Z position

manipulatorClass - The data class

Returns:

If the manipulator was removed

remove

default DataTransactionResult remove(com.flowpowered.math.vector.Vector3i coordinates,
                                     Key<?> key)

Attempts to remove the data associated with the provided Key from the block at the provided location.

Parameters:

coordinates - The position of the block

key - The key to the data to remove

Returns:

The transaction result

remove

DataTransactionResult remove(int x,
                             int y,
                             int z,
                             Key<?> key)

Attempts to remove the data associated with the provided Key from the block at the provided location.

Parameters:

x - The X position

y - The Y position

z - The Z position

key - The key of the data to remove

Returns:

The transaction result

undo

default DataTransactionResult undo(com.flowpowered.math.vector.Vector3i coordinates,
                                   DataTransactionResult result)

Attempts to undo a DataTransactionResult. Specifically, all ImmutableValues that were successfully added are removed, and all replaced ImmutableValues are offered.

Parameters:

coordinates - The position of the block

result - The transaction result to undo

Returns:

The transaction result

undo

DataTransactionResult undo(int x,
                           int y,
                           int z,
                           DataTransactionResult result)

Attempts to undo a DataTransactionResult. Specifically, all ImmutableValues that were successfully added are removed, and all replaced ImmutableValues are offered.

Parameters:

x - The X position

y - The Y position

z - The Z position

result - The transaction result to undo

Returns:

The transaction result

copyFrom

default DataTransactionResult copyFrom(com.flowpowered.math.vector.Vector3i to,
                                       DataHolder from)

Attempts to copy all the relevant data from the provided DataHolder to the block at the provided coordinates.

Parameters:

to - The coordinates of the block

from - The data holder to copy data from

Returns:

The transaction result

copyFrom

DataTransactionResult copyFrom(int xTo,
                               int yTo,
                               int zTo,
                               DataHolder from)

Attempts to copy all the relevant data from the provided DataHolder to the block at the provided coordinates.

Parameters:

xTo - The X pos

yTo - The Y pos

zTo - The Z pos

from - The data holder to copy data from

Returns:

The transaction result

copyFrom

default DataTransactionResult copyFrom(com.flowpowered.math.vector.Vector3i coordinatesTo,
                                       com.flowpowered.math.vector.Vector3i coordinatesFrom)

Attempts to copy all the relevant data from the provided DataHolder to the block at the provided coordinates.

Parameters:

coordinatesTo - The coordinates of the block

coordinatesFrom - The coordinates of the block to copy data from

Returns:

The transaction result

copyFrom

default DataTransactionResult copyFrom(int xTo,
                                       int yTo,
                                       int zTo,
                                       int xFrom,
                                       int yFrom,
                                       int zFrom)

Attempts to copy all ImmutableValues from the provided block to provided block to the provided block coordinates.

Parameters:

xTo - The X position of the block to copy data to

yTo - The Y position of the block to copy data to

zTo - The Z position of the block to copy data to

xFrom - The X position of the block to copy data from

yFrom - The Y position of the block to copy data from

zFrom - The Z position of the block to copy data from

Returns:

The transaction result

copyFrom

default DataTransactionResult copyFrom(com.flowpowered.math.vector.Vector3i to,
                                       DataHolder from,
                                       MergeFunction function)

Attempts to copy all ImmutableValues from the provided block to provided block to the provided block coordinates. Any conflicting data is handled through the provided MergeFunction.

Parameters:

to - The block coordinates to copy to

from - the data holder to copy data from

function - The merge function to resolve conflicts

Returns:

The transaction result

copyFrom

DataTransactionResult copyFrom(int xTo,
                               int yTo,
                               int zTo,
                               DataHolder from,
                               MergeFunction function)

Attempts to copy all ImmutableValues from the provided block to provided block to the provided block coordinates. Any conflicting data is handled through the provided MergeFunction.

Parameters:

xTo - The X pos of the block to copy data to

yTo - The Y pos of the block to copy data to

zTo - The Z pos of the block to copy data to

from - The data holder to copy data from

function - The merge function to resolve conflicts

Returns:

The transaction result

copyFrom

default DataTransactionResult copyFrom(com.flowpowered.math.vector.Vector3i coordinatesTo,
                                       com.flowpowered.math.vector.Vector3i coordinatesFrom,
                                       MergeFunction function)

Attempts to copy all ImmutableValues from the provided block to provided block to the provided block coordinates. Any conflicting data is handled through the provided MergeFunction.

Parameters:

coordinatesTo - The coordinates of the block copying data to

coordinatesFrom - The coordinates of the block to copy data from

function - The merge function to resolve conflicts

Returns:

The transaction result

copyFrom

DataTransactionResult copyFrom(int xTo,
                               int yTo,
                               int zTo,
                               int xFrom,
                               int yFrom,
                               int zFrom,
                               MergeFunction function)

Attempts to copy all ImmutableValues from the provided block to provided block to the provided block coordinates. Any conflicting data is handled through the provided MergeFunction.

Parameters:

xTo - The X position

yTo - The Y position

zTo - The Z position

xFrom - The X position

yFrom - The Y position

zFrom - The Z position

function - The merge resolving function

Returns:

The transaction result

getManipulators

default Collection<DataManipulator<?,?>> getManipulators(com.flowpowered.math.vector.Vector3i coordinates)

Gets an copied collection of all known DataManipulators belonging to the block at the given position. An individual DataManipulator can be used for creating new data to replace on the block at the given position.

Parameters:

coordinates - The position of the block

Returns:

A collection of copied data manipulators belonging to the block at the given position

getManipulators

Collection<DataManipulator<?,?>> getManipulators(int x,
                                                 int y,
                                                 int z)

Gets an copied collection of all known DataManipulators belonging to the block at the given position. An individual DataManipulator can be used for creating new data to replace on the block at the given position.

Parameters:

x - The X position

y - The Y position

z - The Z position

Returns:

A collection of copied data manipulators belonging to the block at the given position

validateRawData

default boolean validateRawData(com.flowpowered.math.vector.Vector3i position,
                                DataView container)

Validates the container with known data required to set the raw data to the block at the given position. If the container is incomplete or contains invalid data, false is returned.

This validation should be checked prior to calling setRawData(Vector3i, DataView) to avoid exceptions.

Parameters:

position - The position of the block

container - The raw data to validate

Returns:

True if the data is valid

validateRawData

boolean validateRawData(int x,
                        int y,
                        int z,
                        DataView container)

Validates the container with known data required to set the raw data to the block at the given position. If the container is incomplete or contains invalid data, false is returned.

This validation should be checked prior to calling setRawData(Vector3i, DataView) to avoid exceptions.

Parameters:

x - The X position

y - The Y position

z - The Z position

container - The raw data to validate

Returns:

True if the data is valid

setRawData

default void setRawData(com.flowpowered.math.vector.Vector3i position,
                        DataView container)
                 throws InvalidDataException

Attempts to set all data of the block at the given position according to the DataContainer's held information. Using this to modify known DataManipulators is unsupported and if the data is invalid, an InvalidDataException is thrown.

This setter is used to provide setting custom data that is not represented by the Data API, including forge mods and other unknown data. Attempts at validating known DataManipulators contained in the data container are made with the assumption that all necessary data exists.

Parameters:

position - The position of the block

container - A container containing all raw data to set on the block at the given position

Throws:

InvalidDataException - If the container is missing or has invalid data that this holder will refuse

setRawData

void setRawData(int x,
                int y,
                int z,
                DataView container)
         throws InvalidDataException

Attempts to set all data of the block at the given position according to the DataContainer's held information. Using this to modify known DataManipulators is unsupported and if the data is invalid, an InvalidDataException is thrown.

This setter is used to provide setting custom data that is not represented by the Data API, including forge mods and other unknown data. Attempts at validating known DataManipulators contained in the data container are made with the assumption that all necessary data exists.

Parameters:

x - The X position

y - The Y position

z - The Z position

container - A container containing all raw data to set on the block at the given position

Throws:

InvalidDataException - If the container is missing or has invalid data that this holder will refuse