diff --git a/src/main/java/org/maxgamer/quickshop/event/ShopControlPanelOpenEvent.java b/src/main/java/org/maxgamer/quickshop/event/ShopControlPanelOpenEvent.java index ca046c007..094620260 100644 --- a/src/main/java/org/maxgamer/quickshop/event/ShopControlPanelOpenEvent.java +++ b/src/main/java/org/maxgamer/quickshop/event/ShopControlPanelOpenEvent.java @@ -33,6 +33,12 @@ public class ShopControlPanelOpenEvent extends QSEvent implements Cancellable { private final CommandSender sender; private boolean cancelled = false; + /** + * Called before shop control panel message. + * + * @param shop The shop bought from + * @param sender The player which receiving shop control panel message + */ public ShopControlPanelOpenEvent(@NotNull Shop shop, @NotNull CommandSender sender) { this.shop = shop; this.sender = sender; diff --git a/src/main/java/org/maxgamer/quickshop/event/ShopCreateEvent.java b/src/main/java/org/maxgamer/quickshop/event/ShopCreateEvent.java index 3950966b6..e04081143 100644 --- a/src/main/java/org/maxgamer/quickshop/event/ShopCreateEvent.java +++ b/src/main/java/org/maxgamer/quickshop/event/ShopCreateEvent.java @@ -39,7 +39,7 @@ public class ShopCreateEvent extends QSEvent implements Cancellable { private boolean cancelled; /** - * Call when have a new shop was createing. + * Call when have a new shop was creating. * * @param shop Target shop * @param player The player creaing the shop diff --git a/src/main/java/org/maxgamer/quickshop/event/ShopDeleteEvent.java b/src/main/java/org/maxgamer/quickshop/event/ShopDeleteEvent.java index b8bac997c..b6cc26093 100644 --- a/src/main/java/org/maxgamer/quickshop/event/ShopDeleteEvent.java +++ b/src/main/java/org/maxgamer/quickshop/event/ShopDeleteEvent.java @@ -37,7 +37,7 @@ public class ShopDeleteEvent extends QSEvent implements Cancellable { private boolean cancelled; /** - * Call the event when shop is deleteing. The ShopUnloadEvent will call after ShopDeleteEvent + * Call the event when shop is deleting. The ShopUnloadEvent will call after ShopDeleteEvent * * @param shop Target shop * @param fromMemory Only delete from the memory? false = delete both in memory and database diff --git a/src/main/java/org/maxgamer/quickshop/event/ShopInventoryPreviewEvent.java b/src/main/java/org/maxgamer/quickshop/event/ShopInventoryPreviewEvent.java index 610ce858d..8cb325b52 100644 --- a/src/main/java/org/maxgamer/quickshop/event/ShopInventoryPreviewEvent.java +++ b/src/main/java/org/maxgamer/quickshop/event/ShopInventoryPreviewEvent.java @@ -39,7 +39,7 @@ public class ShopInventoryPreviewEvent extends QSEvent implements Cancellable { private boolean cancelled; /** - * Build a event when player using GUI preview + * Called when player using GUI preview * * @param player Target plugin * @param itemStack The preview item, with preview flag. diff --git a/src/main/java/org/maxgamer/quickshop/event/ShopModeratorChangedEvent.java b/src/main/java/org/maxgamer/quickshop/event/ShopModeratorChangedEvent.java index 5fff03329..d065086b5 100644 --- a/src/main/java/org/maxgamer/quickshop/event/ShopModeratorChangedEvent.java +++ b/src/main/java/org/maxgamer/quickshop/event/ShopModeratorChangedEvent.java @@ -39,7 +39,8 @@ public class ShopModeratorChangedEvent extends QSEvent { private final Shop shop; /** - * Will call when shop price was changed. + * Will call when shop moderator was changed. + * Shop moderator included owner itself. * * @param shop Target shop * @param shopModerator The shop moderator diff --git a/src/main/java/org/maxgamer/quickshop/event/ShopPriceChangeEvent.java b/src/main/java/org/maxgamer/quickshop/event/ShopPriceChangeEvent.java index 8502741c8..e747beeb1 100644 --- a/src/main/java/org/maxgamer/quickshop/event/ShopPriceChangeEvent.java +++ b/src/main/java/org/maxgamer/quickshop/event/ShopPriceChangeEvent.java @@ -26,7 +26,7 @@ import org.jetbrains.annotations.NotNull; import org.maxgamer.quickshop.shop.Shop; /** - * Calling when shop price was changed, Can't cancel + * Calling when shop price was changed */ public class ShopPriceChangeEvent extends QSEvent implements Cancellable { diff --git a/src/main/java/org/maxgamer/quickshop/event/ShopProtectionCheckEvent.java b/src/main/java/org/maxgamer/quickshop/event/ShopProtectionCheckEvent.java index 462e5f842..b25a6cda9 100644 --- a/src/main/java/org/maxgamer/quickshop/event/ShopProtectionCheckEvent.java +++ b/src/main/java/org/maxgamer/quickshop/event/ShopProtectionCheckEvent.java @@ -44,7 +44,9 @@ public class ShopProtectionCheckEvent extends QSEvent { private final ProtectionCheckStatus status; /** - * Will call when shop price was changed. + * Will call when checking protection by other plugin, + * This event was used to compatible with QuickShop protection checking + * Which will fire a FAKE BlockBreakEvent * * @param location Target location will execute protect check. * @param status The checking status diff --git a/src/main/java/org/maxgamer/quickshop/event/ShopPurchaseEvent.java b/src/main/java/org/maxgamer/quickshop/event/ShopPurchaseEvent.java index 07b04fca0..47b058d32 100644 --- a/src/main/java/org/maxgamer/quickshop/event/ShopPurchaseEvent.java +++ b/src/main/java/org/maxgamer/quickshop/event/ShopPurchaseEvent.java @@ -46,8 +46,9 @@ public class ShopPurchaseEvent extends QSEvent implements Cancellable { private boolean cancelled; /** - * Builds a new shop purchase event This time, purchase not start, please listen the - * ShopSuccessPurchaseEvent. + * Builds a new shop purchase event + * Will called when purchase starting + * For recording purchase, please listen to ShopSuccessPurchaseEvent. * * @param shop The shop bought from * @param player The player buying diff --git a/src/main/java/org/maxgamer/quickshop/event/ShopSignUpdatedEvent.java b/src/main/java/org/maxgamer/quickshop/event/ShopSignUpdateEvent.java similarity index 88% rename from src/main/java/org/maxgamer/quickshop/event/ShopSignUpdatedEvent.java rename to src/main/java/org/maxgamer/quickshop/event/ShopSignUpdateEvent.java index 274a9f2da..40934a099 100644 --- a/src/main/java/org/maxgamer/quickshop/event/ShopSignUpdatedEvent.java +++ b/src/main/java/org/maxgamer/quickshop/event/ShopSignUpdateEvent.java @@ -28,7 +28,7 @@ import org.maxgamer.quickshop.shop.Shop; /** * Calling when shop sign update, Can't cancel */ -public class ShopSignUpdatedEvent extends QSEvent { +public class ShopSignUpdateEvent extends QSEvent { @Getter @NotNull @@ -39,12 +39,12 @@ public class ShopSignUpdatedEvent extends QSEvent { private final Sign sign; /** - * Will call when shop price was changed. + * Will call when shop sign was updated. * * @param shop Target shop * @param sign Updated sign */ - public ShopSignUpdatedEvent(@NotNull Shop shop, @NotNull Sign sign) { + public ShopSignUpdateEvent(@NotNull Shop shop, @NotNull Sign sign) { this.shop = shop; this.sign = sign; } diff --git a/src/main/java/org/maxgamer/quickshop/event/ShopSuccessPurchaseEvent.java b/src/main/java/org/maxgamer/quickshop/event/ShopSuccessPurchaseEvent.java index e30962141..6c45cab66 100644 --- a/src/main/java/org/maxgamer/quickshop/event/ShopSuccessPurchaseEvent.java +++ b/src/main/java/org/maxgamer/quickshop/event/ShopSuccessPurchaseEvent.java @@ -48,8 +48,8 @@ public class ShopSuccessPurchaseEvent extends QSEvent implements Cancellable { private boolean cancelled; /** - * Builds a new shop purchase event This time, purchase not start, please listen the - * ShopSuccessPurchaseEvent. + * Builds a new shop purchase event + * Will called when purchase ended * * @param shop The shop bought from * @param player The player buying diff --git a/src/main/java/org/maxgamer/quickshop/shop/ContainerShop.java b/src/main/java/org/maxgamer/quickshop/shop/ContainerShop.java index 68e6de128..e82604884 100644 --- a/src/main/java/org/maxgamer/quickshop/shop/ContainerShop.java +++ b/src/main/java/org/maxgamer/quickshop/shop/ContainerShop.java @@ -859,6 +859,7 @@ public class ContainerShop implements Shop { Util.debugLog("Skipped new sign text setup: Same content"); continue; } + Bukkit.getPluginManager().callEvent(new ShopSignUpdateEvent(this, sign)); for (int i = 0; i < lines.length; i++) { sign.setLine(i, lines[i]); }