Package org.spongepowered.api.world

Class BlockChangeFlags

java.lang.Object

org.spongepowered.api.world.BlockChangeFlags

public final class BlockChangeFlags
extends Object

An enumeration of the possible BlockChangeFlags.

BlockChangeFlags can be combined using the BlockChangeFlag.andFlag(BlockChangeFlag) and BlockChangeFlag.andNotFlag(BlockChangeFlag) operators.

Field Summary

Fields

Modifier and Type	Field	Description
static final BlockChangeFlag	ALL	All the available flags are applied through the OR operator.
static final BlockChangeFlag	DEFAULT_PLACEMENT	The default flags for a placement event, such as a player placing a block, another entity placing a block, etc.
static final BlockChangeFlag	NONE	No flags are set, triggers nothing, the following flags are as such: BlockChangeFlag.notifyClients() is false BlockChangeFlag.updateNeighbors() ()} is false BlockChangeFlag.forceClientRerender() is false BlockChangeFlag.ignoreRender() is false BlockChangeFlag.movingBlocks() is false BlockChangeFlag.updateLighting() is false BlockChangeFlag.updateNeighboringShapes() is false BlockChangeFlag.performBlockPhysics() is false BlockChangeFlag.notifyPathfinding() is false
static final BlockChangeFlag	NOTIFY_CLIENTS	Sends block changes to clients but does not trigger block updates or other neighboring notification updates.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

ALL

public static final BlockChangeFlag ALL

All the available flags are applied through the OR operator.

DEFAULT_PLACEMENT

public static final BlockChangeFlag DEFAULT_PLACEMENT

The default flags for a placement event, such as a player placing a block, another entity placing a block, etc.

Note: While players are normally placing blocks with this flag, there's other circumstances of placing a block "as" a Player that are covered outside the purview of this default placement flag.

NONE

public static final BlockChangeFlag NONE

No flags are set, triggers nothing, the following flags are as such:

• BlockChangeFlag.notifyClients() is false
• BlockChangeFlag.updateNeighbors() ()} is false
• BlockChangeFlag.forceClientRerender() is false
• BlockChangeFlag.ignoreRender() is false
• BlockChangeFlag.movingBlocks() is false
• BlockChangeFlag.updateLighting() is false
• BlockChangeFlag.updateNeighboringShapes() is false
• BlockChangeFlag.performBlockPhysics() is false
• BlockChangeFlag.notifyPathfinding() is false

NOTIFY_CLIENTS

public static final BlockChangeFlag NOTIFY_CLIENTS

Sends block changes to clients but does not trigger block updates or other neighboring notification updates. It does enable lighting updates, usually much more preferred to having a "minimal"