diff --git a/api/src/main/java/de/erethon/dungeonsxl/api/sign/Button.java b/api/src/main/java/de/erethon/dungeonsxl/api/sign/Button.java index d27451ca..de5e1e07 100644 --- a/api/src/main/java/de/erethon/dungeonsxl/api/sign/Button.java +++ b/api/src/main/java/de/erethon/dungeonsxl/api/sign/Button.java @@ -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. + *

+ * 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 { diff --git a/api/src/main/java/de/erethon/dungeonsxl/api/sign/Passive.java b/api/src/main/java/de/erethon/dungeonsxl/api/sign/Passive.java index bee8a32f..4615643d 100644 --- a/api/src/main/java/de/erethon/dungeonsxl/api/sign/Passive.java +++ b/api/src/main/java/de/erethon/dungeonsxl/api/sign/Passive.java @@ -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 { diff --git a/api/src/main/java/de/erethon/dungeonsxl/api/sign/Rocker.java b/api/src/main/java/de/erethon/dungeonsxl/api/sign/Rocker.java index c20f368a..7def67f3 100644 --- a/api/src/main/java/de/erethon/dungeonsxl/api/sign/Rocker.java +++ b/api/src/main/java/de/erethon/dungeonsxl/api/sign/Rocker.java @@ -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 deactivated and an activated state and can switch between these two. + *

+ * 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 */ diff --git a/api/src/main/java/de/erethon/dungeonsxl/api/sign/Windup.java b/api/src/main/java/de/erethon/dungeonsxl/api/sign/Windup.java index 01404099..7a77ab0d 100644 --- a/api/src/main/java/de/erethon/dungeonsxl/api/sign/Windup.java +++ b/api/src/main/java/de/erethon/dungeonsxl/api/sign/Windup.java @@ -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 n times, like a mob sign that spawns n mobs. It is similar to a {@link Rocker} + * as it expires (=is deactivated). + * * @author Daniel Saukel */ public abstract class Windup extends Deactivatable {