Documentation/Api

As of version 2.0, the plugin now has some API features for plugin developers to use.

For now they only consist of 2 events.

ClockCreateEvent


Called whenever a player attempts to create a clock.

extends

org.bukkit.event.Event

implements

org.bukkit.event.Cancellable

Methods

org.bukkit.entity.Player getPlayer()

returns the player that is attempting to create a clock.

 

me.greenadine.clocksign.clocks.Clock getClock()

returns the clock that is being created.

 

ClockRemoveEvent


Called whenever a clock is being removed, by either a player or the plugin itself.

extends

org.bukkit.event.Event

implements

org.bukkit.event.Cancellable

Methods

org.bukkit.entity.Player getPlayer()

returns the player that is attempting to remove a clock.

 

NOTE: will always return null when getCause() == RemoveCause.PLUGIN

 

me.greenadine.clocksign.clocks.Clock getClock()

returns the clock that is being removed.

 

me.greenadine.clocksign.api.event.RemoveCause getCause()

returns RemoveCause.PLAYER if a player is destroying the clock.

returns RemoveCause.PLUGIN if the plugin itself is removing this clock, due to it not existing anymore, or being improperly defined.