mirror of
https://github.com/DRE2N/DungeonsXL.git
synced 2024-11-28 13:36:33 +01:00
Add Javadoc sign type descriptions
This commit is contained in:
parent
0b48675735
commit
0fe56fdf61
@ -21,6 +21,10 @@ import org.bukkit.block.Sign;
|
||||
import org.bukkit.entity.Player;
|
||||
|
||||
/**
|
||||
* A sign that performs a specific action every time it is triggered.
|
||||
* <p>
|
||||
* For example, a classes sign with the default interact trigger sets your class every time you punch it.
|
||||
*
|
||||
* @author Daniel Saukel
|
||||
*/
|
||||
public abstract class Button extends AbstractDSign {
|
||||
|
@ -20,6 +20,8 @@ import org.bukkit.block.Sign;
|
||||
import org.bukkit.entity.Player;
|
||||
|
||||
/**
|
||||
* A sign that does not do anything on its own. Its function is mostly to mark locations or blocks, like lobby or bed signs.
|
||||
*
|
||||
* @author Daniel Saukel
|
||||
*/
|
||||
public abstract class Passive extends AbstractDSign {
|
||||
|
@ -20,7 +20,10 @@ import org.bukkit.block.Sign;
|
||||
import org.bukkit.entity.Player;
|
||||
|
||||
/**
|
||||
* A {@link Deactivatable} that, if triggered, and already activated, is deactivated.
|
||||
* A sign that has a <i>deactivated</i> and an <i>activated state</i> and can switch between these two.
|
||||
* <p>
|
||||
* For example, if a door sign is activated, the door opens - if it is deactivated, the door closes. The state may be set for the whole game world or for the
|
||||
* player who triggered the sign depending on the context.
|
||||
*
|
||||
* @author Daniel Saukel
|
||||
*/
|
||||
|
@ -19,6 +19,9 @@ import de.erethon.dungeonsxl.api.world.GameWorld;
|
||||
import org.bukkit.block.Sign;
|
||||
|
||||
/**
|
||||
* A sign with an attached task that does actions in a set interval <i>n</i> times, like a mob sign that spawns <i>n</i> mobs. It is similar to a {@link Rocker}
|
||||
* as it expires (=is deactivated).
|
||||
*
|
||||
* @author Daniel Saukel
|
||||
*/
|
||||
public abstract class Windup extends Deactivatable {
|
||||
|
Loading…
Reference in New Issue
Block a user