com.palmergames.bukkit.towny.regen

Class TownyRegenAPI

java.lang.Object

com.palmergames.bukkit.towny.regen.TownyRegenAPI

public class TownyRegenAPI
extends java.lang.Object

Author:

ElgarL

Constructor Summary

Constructors

Constructor and Description
TownyRegenAPI()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addDeleteTownBlockIdQueue(WorldCoord plot)
static void	addPlaceholder(org.bukkit.block.Block block) Add this block as a placeholder (will be replaced when it's regeneration task occurs)
static void	addPlotChunk(PlotBlockData plotChunk, boolean save) Adds a Plot Chunk to the regeneration Hashtable
static void	addPlotChunkSnapshot(PlotBlockData plotChunk) Saves a Plot Chunk snapshot to the datasource
static void	addProtectionRegenTask(ProtectionRegenTask task) Add this task to the protection regen queue.
static void	addWorldCoord(WorldCoord worldCoord) Add a TownBlocks WorldCoord for a snapshot to be taken.
static void	cancelProtectionRegenTasks() Cancel all regenerating tasks and clear all queues.
static void	deletePlotChunk(PlotBlockData plotChunk) Removes a Plot Chunk from the regeneration Hashtable
static void	deletePlotChunkSnapshot(PlotBlockData plotChunk) Deletes a Plot Chunk snapshot from the datasource
static void	deleteTownBlockMaterial(TownBlock townBlock, org.bukkit.Material material) Deletes all of a specified block type from a TownBlock
static void	doDeleteTownBlockIds(WorldCoord worldCoord) Deletes all of a specified block type from a TownBlock
static WorldCoord	getDeleteTownBlockIdQueue()
static PlotBlockData	getPlotChunk(TownBlock townBlock) Gets a Plot Chunk from the regeneration Hashtable
static java.util.Hashtable<java.lang.String,PlotBlockData>	getPlotChunks()
static PlotBlockData	getPlotChunkSnapshot(TownBlock townBlock) Loads a Plot Chunk snapshot from the datasource
static java.lang.String	getPlotKey(TownBlock townBlock)
static ProtectionRegenTask	GetProtectionRegenTask(BlockLocation blockLocation) Fetch the relevant regen task for this block
static WorldCoord	getWorldCoord()
static boolean	hasDeleteTownBlockIdQueue()
static boolean	hasPlotChunks()
static boolean	hasProtectionRegenTask(BlockLocation blockLocation) Does a task for this block already exist?
static boolean	hasWorldCoord(WorldCoord worldCoord) Check if this WorldCoord is waiting for a snapshot to be taken.
static boolean	hasWorldCoords()
static void	initialize(Towny plugin)
static boolean	isDeleteTownBlockIdQueue(WorldCoord plot)
static boolean	isPlaceholder(org.bukkit.block.Block block) Is this a placholder block?
static void	regenChunk(org.bukkit.entity.Player player) Regenerate the chunk the player is stood in and store the block data so it can be undone later.
static void	regenUndo(java.lang.Object[][][] snapshot, Resident resident) Restore the relevant chunk using the snapshot data stored in the resident object.
static void	removePlaceholder(org.bukkit.block.Block block) Remove this block from being tracked as a placeholder.
static void	removeProtectionRegenTask(ProtectionRegenTask task) Remove this task form the protection regen queue
static void	setPlotChunks(java.util.Hashtable<java.lang.String,PlotBlockData> plotChunks)

Methods inherited from class java.lang.Object

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

Constructor Detail

TownyRegenAPI

public TownyRegenAPI()

Method Detail

initialize

public static void initialize(Towny plugin)

addWorldCoord

public static void addWorldCoord(WorldCoord worldCoord)

Add a TownBlocks WorldCoord for a snapshot to be taken.

Parameters:

worldCoord -

hasWorldCoords

public static boolean hasWorldCoords()

Returns:

true if there are any TownBlocks to be processed.

hasWorldCoord

public static boolean hasWorldCoord(WorldCoord worldCoord)

Check if this WorldCoord is waiting for a snapshot to be taken.

Parameters:

worldCoord -

Returns:

true if it's in the queue.

getWorldCoord

public static WorldCoord getWorldCoord()

Returns:

First WorldCoord to be processed.

getPlotChunks

public static java.util.Hashtable<java.lang.String,PlotBlockData> getPlotChunks()

Returns:

the plotChunks which are being processed

hasPlotChunks

public static boolean hasPlotChunks()

Returns:

true if there are any chunks being processed.

setPlotChunks

public static void setPlotChunks(java.util.Hashtable<java.lang.String,PlotBlockData> plotChunks)

Parameters:

plotChunks - the plotChunks to set

deletePlotChunk

public static void deletePlotChunk(PlotBlockData plotChunk)

Removes a Plot Chunk from the regeneration Hashtable

Parameters:

plotChunk -

addPlotChunk

public static void addPlotChunk(PlotBlockData plotChunk,
                boolean save)

Adds a Plot Chunk to the regeneration Hashtable

Parameters:

plotChunk -

save -

addPlotChunkSnapshot

public static void addPlotChunkSnapshot(PlotBlockData plotChunk)

Saves a Plot Chunk snapshot to the datasource

Parameters:

plotChunk -

deletePlotChunkSnapshot

public static void deletePlotChunkSnapshot(PlotBlockData plotChunk)

Deletes a Plot Chunk snapshot from the datasource

Parameters:

plotChunk -

getPlotChunkSnapshot

public static PlotBlockData getPlotChunkSnapshot(TownBlock townBlock)

Loads a Plot Chunk snapshot from the datasource

Parameters:

townBlock -

getPlotChunk

public static PlotBlockData getPlotChunk(TownBlock townBlock)

Gets a Plot Chunk from the regeneration Hashtable

Parameters:

townBlock -

getPlotKey

public static java.lang.String getPlotKey(TownBlock townBlock)

regenChunk

public static void regenChunk(org.bukkit.entity.Player player)

Regenerate the chunk the player is stood in and store the block data so it can be undone later.

Parameters:

player -

regenUndo

public static void regenUndo(java.lang.Object[][][] snapshot,
             Resident resident)

Restore the relevant chunk using the snapshot data stored in the resident object.

Parameters:

snapshot -

resident -

hasDeleteTownBlockIdQueue

public static boolean hasDeleteTownBlockIdQueue()

Returns:

true if there are any chunks being processed.

isDeleteTownBlockIdQueue

public static boolean isDeleteTownBlockIdQueue(WorldCoord plot)

addDeleteTownBlockIdQueue

public static void addDeleteTownBlockIdQueue(WorldCoord plot)

getDeleteTownBlockIdQueue

public static WorldCoord getDeleteTownBlockIdQueue()

doDeleteTownBlockIds

public static void doDeleteTownBlockIds(WorldCoord worldCoord)

Deletes all of a specified block type from a TownBlock

Parameters:

worldCoord -

deleteTownBlockMaterial

public static void deleteTownBlockMaterial(TownBlock townBlock,
                           org.bukkit.Material material)

Deletes all of a specified block type from a TownBlock

Parameters:

townBlock -

material -

hasProtectionRegenTask

public static boolean hasProtectionRegenTask(BlockLocation blockLocation)

Does a task for this block already exist?

Parameters:

blockLocation -

Returns:

true if a task exists

GetProtectionRegenTask

public static ProtectionRegenTask GetProtectionRegenTask(BlockLocation blockLocation)

Fetch the relevant regen task for this block

Parameters:

blockLocation -

Returns:

the stored task, or null if there is none.

addProtectionRegenTask

public static void addProtectionRegenTask(ProtectionRegenTask task)

Add this task to the protection regen queue.

Parameters:

task -

removeProtectionRegenTask

public static void removeProtectionRegenTask(ProtectionRegenTask task)

Remove this task form the protection regen queue

Parameters:

task -

cancelProtectionRegenTasks

public static void cancelProtectionRegenTasks()

Cancel all regenerating tasks and clear all queues.

isPlaceholder

public static boolean isPlaceholder(org.bukkit.block.Block block)

Is this a placholder block?

Parameters:

block -

Returns:

true if it is a placeholder

addPlaceholder

public static void addPlaceholder(org.bukkit.block.Block block)

Add this block as a placeholder (will be replaced when it's regeneration task occurs)

Parameters:

block -

removePlaceholder

public static void removePlaceholder(org.bukkit.block.Block block)

Remove this block from being tracked as a placeholder.

Parameters:

block -