Package me.metallicgoat.tweaksaddon.api.gentiers

Class GenTierHandler

java.lang.Object

me.metallicgoat.tweaksaddon.api.gentiers.GenTierHandler

public abstract class GenTierHandler
extends Object

Represents a handler for a gen tier occurance.

See Also:

• GenTiersAPI.registerHandler(GenTierHandler)

Constructor Summary

Constructors

Constructor	Description
GenTierHandler()

Method Summary

Modifier and Type	Method	Description
GenTierActionType	getActionType()	Get the type of action this handler performs
abstract String	getId()	Get the unique id of this handler as used in configs
abstract Plugin	getPlugin()	Get the plugin which registered this handler
final boolean	isRegistered()	Check if this handler is currently registered
abstract void	run(GenTierLevel level, Arena arena)	Called when the gen tier's time elapsed and it is being run.

Methods inherited from class java.lang.Object

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

Constructor Details

GenTierHandler

public GenTierHandler()

Method Details

run

public abstract void run(GenTierLevel level,
 Arena arena)

Called when the gen tier's time elapsed and it is being run.

Parameters:

level - the gen tier level being run

arena - the arena the gen tier is being run in

getPlugin

public abstract Plugin getPlugin()

Get the plugin which registered this handler

Returns:

the plugin which registered this handler

getId

public abstract String getId()

Get the unique id of this handler as used in configs

Returns:

the unique id of this handler

getActionType

public GenTierActionType getActionType()

Get the type of action this handler performs

Custom handlers should always return GenTierActionType.PLUGIN

Returns:

the type of action this handler performs

isRegistered

public final boolean isRegistered()

Check if this handler is currently registered

Returns:

true if this handler is registered