com.elmakers.mine.bukkit.api.block

Interface UndoQueue

public interface UndoQueue

Method Summary

Modifier and Type	Method and Description
void	add(UndoList blocks)
boolean	commit()
boolean	commitNext()
Collection<UndoList>	getAll()
UndoList	getLast()
UndoList	getLast(org.bukkit.block.Block target)
int	getSize() Get the current size of the queue.
boolean	hasScheduled() Check to see if there are any scheduled undo changes pending in this queue.
boolean	isEmpty()
void	load(UndoData data) Load the data in this undo queue.
void	save(UndoData data) Save the data in this undo queue.
UndoList	undoRecent(org.bukkit.block.Block block, int timeout) Undo a recent construction performed by this Mage against the given Block
UndoList	undoRecent(int timeout) Undo a recent construction performed by this Mage.
UndoList	undoRecent(int timeout, String spellKey)
int	undoScheduled() Immediately undo any scheduled undo tasks.

Method Detail

add

void add(UndoList blocks)

getLast

@Nullable
UndoList getLast()

getLast

@Nullable
UndoList getLast(org.bukkit.block.Block target)

undoRecent

@Nullable
UndoList undoRecent(int timeout)

Undo a recent construction performed by this Mage.

This will restore anything changed by the last-cast construction spell, and remove that construction from the Mage's UndoQueue.

It will skip undoing if the UndoList is older than the specified timeout.

Parameters:

timeout - The maximum age of the change

Returns:

The UndoList that was undone, or null if none.

undoRecent

@Nullable
UndoList undoRecent(int timeout,
                              String spellKey)

undoRecent

@Nullable
UndoList undoRecent(org.bukkit.block.Block block,
                              int timeout)

Undo a recent construction performed by this Mage against the given Block

This will restore anything changed by the last-cast construction spell by this Mage that targeted the specific Block, even if it was not the most recent Spell cast by that Mage.

It will skip undoing if the UndoList is older than the specified timeout.

Parameters:

block - The block to check for modifications.

timeout - The maximum age of the change

Returns:

The UndoList that was undone, or null if the Mage has no constructions for the given Block.

undoScheduled

int undoScheduled()

Immediately undo any scheduled undo tasks.

Returns:

The number of tasks (spells) undone.

getSize

int getSize()

Get the current size of the queue.

Returns:

The queue depth.

isEmpty

boolean isEmpty()

commit

boolean commit()

commitNext

boolean commitNext()

save

void save(UndoData data)

Save the data in this undo queue.

load

void load(UndoData data)

Load the data in this undo queue.

hasScheduled

boolean hasScheduled()

Check to see if there are any scheduled undo changes pending in this queue.

getAll

Collection<UndoList> getAll()