org.spongepowered.api.event.data

Interface ChangeDataHolderEvent.ValueChange

All Superinterfaces:

Cancellable, ChangeDataHolderEvent, Event

All Known Implementing Classes:

AbstractValueChangeEvent

Enclosing interface:

ChangeDataHolderEvent

public static interface ChangeDataHolderEvent.ValueChange
extends ChangeDataHolderEvent

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.event.data.ChangeDataHolderEvent

ChangeDataHolderEvent.ValueChange

Method Summary

Modifier and Type	Method and Description
DataTransactionResult	getEndResult() Gets the ending resulting DataTransactionResult that will be offered to the DataHolder.
DataTransactionResult	getOriginalChanges() Gets the original DataTransactionResult of the Values that have changed in this event.
ChangeDataHolderEvent.ValueChange	proposeChanges(DataTransactionResult result) Submits a new DataTransactionResult as a proposal of various Values to be successfully offered/changed on the original DataHolder.

Methods inherited from interface org.spongepowered.api.event.data.ChangeDataHolderEvent

getTargetHolder

Methods inherited from interface org.spongepowered.api.event.Event

getCause, getContext, getSource

Methods inherited from interface org.spongepowered.api.event.Cancellable

isCancelled, setCancelled

Method Detail

getOriginalChanges

DataTransactionResult getOriginalChanges()

Gets the original DataTransactionResult of the Values that have changed in this event.

Returns:

The original changes of values

proposeChanges

ChangeDataHolderEvent.ValueChange proposeChanges(DataTransactionResult result)

Submits a new DataTransactionResult as a proposal of various Values to be successfully offered/changed on the original DataHolder.

If the proposed DataTransactionResult provides additional values that were not changed in the getOriginalChanges(), the provided changes suggested to be successfully offered will be re-offered

Parameters:

result - The resulting offer

Returns:

This event, for chaining

getEndResult

DataTransactionResult getEndResult()

Gets the ending resulting DataTransactionResult that will be offered to the DataHolder.

Returns:

The final transaction details to be submitted