org.spongepowered.api.world

Interface BlockChangeFlag

@CatalogedBy(value=BlockChangeFlags.class)
public interface BlockChangeFlag

A flag of sorts that determines whether a block change will perform various interactions, such as notifying neighboring blocks, performing block physics on placement, etc.

Method Summary

Modifier and Type	Method and Description
BlockChangeFlag	andFlag(BlockChangeFlag flag) Gets the equivalent BlockChangeFlag of this flag with the trues set for this flag and the provided flag, such that only if both flags have the same true flags set will persist.
BlockChangeFlag	andNotFlag(BlockChangeFlag flag) Gets the equivalent BlockChangeFlag of this flag with the trues set for this flag and the provided flag, such that only if both flags have the same true flags set will persist.
BlockChangeFlag	inverse() Gets the inverted BlockChangeFlag of this flag.
boolean	notifyObservers() Gets whether this flag will update observer blocks, different from notifying neighbors in that neighbor notifications can cause further block notification loops (like redstone), whereas this focuses on BlockTypes.OBSERVER blocks being told of updates.
boolean	performBlockPhysics() Gets whether this flag defines that a block change should perform block physics checks or not.
boolean	updateNeighbors() Gets whether this flag defines that a block change should notify neighboring blocks.
BlockChangeFlag	withNotifyObservers(boolean notifyObservers) Gets the equivalent BlockChangeFlag of this flag with all other flags while having the desired notifyObservers as defined by the parameter.
BlockChangeFlag	withPhysics(boolean performBlockPhysics) Gets the equivalent BlockChangeFlag of this flag with all other flags while having the desired performBlockPhysics as defined by the parameter.
BlockChangeFlag	withUpdateNeighbors(boolean updateNeighbors) Gets the equivalent BlockChangeFlag of this flag with all other flags while having the desired updateNeighbors as defined by the parameter.

Method Detail

updateNeighbors

boolean updateNeighbors()

Gets whether this flag defines that a block change should notify neighboring blocks.

Returns:

True if this is set to notify neighboring blocks

performBlockPhysics

boolean performBlockPhysics()

Gets whether this flag defines that a block change should perform block physics checks or not. If not, no checks are performed.

Returns:

True if this is set to perform block physics on placement

notifyObservers

boolean notifyObservers()

Gets whether this flag will update observer blocks, different from notifying neighbors in that neighbor notifications can cause further block notification loops (like redstone), whereas this focuses on BlockTypes.OBSERVER blocks being told of updates.

Returns:

True if this is set to update observers.

withUpdateNeighbors

BlockChangeFlag withUpdateNeighbors(boolean updateNeighbors)

Gets the equivalent BlockChangeFlag of this flag with all other flags while having the desired updateNeighbors as defined by the parameter.

Parameters:

updateNeighbors - Whether to update neighboring blocks

Returns:

The relative flag with the desired update neighbors

withPhysics

BlockChangeFlag withPhysics(boolean performBlockPhysics)

Gets the equivalent BlockChangeFlag of this flag with all other flags while having the desired performBlockPhysics as defined by the parameter.

Parameters:

performBlockPhysics - Whether to perform block physics

Returns:

The relative flag with the desired block physics

withNotifyObservers

BlockChangeFlag withNotifyObservers(boolean notifyObservers)

Gets the equivalent BlockChangeFlag of this flag with all other flags while having the desired notifyObservers as defined by the parameter.

Parameters:

notifyObservers - Whether to update observer blocks

Returns:

The relative flag with the desired notify observers

inverse

BlockChangeFlag inverse()

Gets the inverted BlockChangeFlag of this flag. Normally, this may cancel out certain interactions, such as physics, neighbor notifications, or even observer notifications. In certain circumstances, some flags may even require clients to rejoin the world or restart their connections to the server.

Returns:

The inverted flag

andFlag

BlockChangeFlag andFlag(BlockChangeFlag flag)

Gets the equivalent BlockChangeFlag of this flag with the trues set for this flag and the provided flag, such that only if both flags have the same true flags set will persist.

For example, if this flag has notifyObservers() and the incoming flag has notifyObservers() returning true, the resulting flag will have notifyObservers() return true as well. The inverse is also true. If either has differing flags for any of the above methods, the resulting flag will have a false value.

Parameters:

flag - The incoming flag to and with this flag

Returns:

The resulting flag with matched values

andNotFlag

BlockChangeFlag andNotFlag(BlockChangeFlag flag)

Gets the equivalent BlockChangeFlag of this flag with the trues set for this flag and the provided flag, such that only if both flags have the same true flags set will persist.

For example, if this flag has notifyObservers() and the incoming flag has notifyObservers() returning true, the resulting flag will have notifyObservers() return true as well. The inverse is also true. If either has differing flags for any of the above methods, the resulting flag will have a false value.

Parameters:

flag - The incoming flag to and with this flag

Returns:

The resulting flag with matched values