Package me.mrCookieSlime.Slimefun.Objects.handlers

Class BlockTicker

java.lang.Object

me.mrCookieSlime.Slimefun.Objects.handlers.BlockTicker

All Implemented Interfaces:

ItemHandler

Direct Known Subclasses:

RainbowTicker

public abstract class BlockTicker
extends Object
implements ItemHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	unique

Constructor Summary

Constructors

Constructor	Description
BlockTicker()

Method Summary

Modifier and Type	Method	Description
Class<? extends ItemHandler>	getIdentifier()	This method returns the identifier for this ItemHandler.
abstract boolean	isSynchronized()	This method must be overridden to define whether a Block needs to be run on the main server thread (World Manipulation requires that)
void	startNewTick()	This method resets the 'unique' flag for uniqueTick()
abstract void	tick(Block b, SlimefunItem item, me.mrCookieSlime.CSCoreLibPlugin.Configuration.Config data)	This method is called every tick for every block
void	uniqueTick()	This method is called every tick but not per-block and only once.
void	update()
Optional<IncompatibleItemHandlerException>	validate(SlimefunItem item)	This method is used to check whether a given SlimefunItem is compatible with this ItemHandler, it will return an IncompatibleItemHandlerException if the items are not compatible.

Methods inherited from interface me.mrCookieSlime.Slimefun.Objects.handlers.ItemHandler

isPrivate

Methods inherited from class java.lang.Object

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

Field Detail

unique

protected boolean unique

Constructor Detail

BlockTicker

public BlockTicker()

Method Detail

update

public void update()

validate

public Optional<IncompatibleItemHandlerException> validate(SlimefunItem item)

Description copied from interface: ItemHandler

This method is used to check whether a given SlimefunItem is compatible with this ItemHandler, it will return an IncompatibleItemHandlerException if the items are not compatible.

Specified by:

validate in interface ItemHandler

Parameters:

item - The SlimefunItem to validate

Returns:

An Optional describing the result, it will contain an IncompatibleItemHandlerException should there be an issue

isSynchronized

public abstract boolean isSynchronized()

This method must be overridden to define whether a Block needs to be run on the main server thread (World Manipulation requires that)

Returns:

Whether this task should run on the main server thread

tick

public abstract void tick(Block b,
                          SlimefunItem item,
                          me.mrCookieSlime.CSCoreLibPlugin.Configuration.Config data)

This method is called every tick for every block

Parameters:

b - The Block that was ticked

item - The corresponding SlimefunItem

data - The data stored in this Block

uniqueTick

public void uniqueTick()

This method is called every tick but not per-block and only once.

getIdentifier

public Class<? extends ItemHandler> getIdentifier()

Description copied from interface: ItemHandler

This method returns the identifier for this ItemHandler. We use a Class identifier to group Item Handlers together.

Specified by:

getIdentifier in interface ItemHandler

Returns:

The Class identifier for this ItemHandler

startNewTick

public void startNewTick()

This method resets the 'unique' flag for uniqueTick()