com.bgsoftware.superiorskyblock.api.island.algorithms

Interface IslandBlocksTrackerAlgorithm

public interface IslandBlocksTrackerAlgorithm

Method Summary

Modifier and Type	Method and Description
void	clearBlockCounts() Clear all the block counts of the island.
java.math.BigInteger	getBlockCount(Key key) Get the amount of blocks that are on the island.
java.util.Map<Key,java.math.BigInteger>	getBlockCounts() Get all the blocks that are on the island.
java.math.BigInteger	getExactBlockCount(Key key) Get the amount of blocks that are on the island.
void	setLoadingDataMode(boolean loadingDataMode) Set whether the tracker should be in "loading data mode" or not.
boolean	trackBlock(Key key, java.math.BigInteger amount) Track a new block with a specific amount.
boolean	untrackBlock(Key key, java.math.BigInteger amount) Untrack a block with a specific amount.

Method Detail

trackBlock

boolean trackBlock(Key key,
                   java.math.BigInteger amount)

Track a new block with a specific amount.

Parameters:

key - The block's key that should be tracked.

amount - The amount of the block.

Returns:

Whether the block was successfully tracked.

untrackBlock

boolean untrackBlock(Key key,
                     java.math.BigInteger amount)

Untrack a block with a specific amount.

Parameters:

key - The block's key that should be untracked.

amount - The amount of the block.

Returns:

Whether the block was successfully untracked.

getBlockCount

java.math.BigInteger getBlockCount(Key key)

Get the amount of blocks that are on the island.

Parameters:

key - The block's key to check.

getExactBlockCount

java.math.BigInteger getExactBlockCount(Key key)

Get the amount of blocks that are on the island. Unlike getBlockCount(Key), this method returns the count for the exactly block that is given as a parameter.

Parameters:

key - The block's key to check.

getBlockCounts

java.util.Map<Key,java.math.BigInteger> getBlockCounts()

Get all the blocks that are on the island.

clearBlockCounts

void clearBlockCounts()

Clear all the block counts of the island.

setLoadingDataMode

void setLoadingDataMode(boolean loadingDataMode)

Set whether the tracker should be in "loading data mode" or not. When loading mode is enabled, the tracker should only track blocks for the given blocks and not their variants (limits, global blocks, etc)

Parameters:

loadingDataMode - loading mode