-
Notifications
You must be signed in to change notification settings - Fork 78
/
GuiListener.java
450 lines (367 loc) · 14.2 KB
/
GuiListener.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
package com.github.stefvanschie.inventoryframework.gui;
import com.github.stefvanschie.inventoryframework.gui.type.*;
import com.github.stefvanschie.inventoryframework.gui.type.util.Gui;
import org.bukkit.Bukkit;
import org.bukkit.entity.HumanEntity;
import org.bukkit.entity.Player;
import org.bukkit.event.EventHandler;
import org.bukkit.event.EventPriority;
import org.bukkit.event.Listener;
import org.bukkit.event.entity.EntityPickupItemEvent;
import org.bukkit.event.inventory.*;
import org.bukkit.event.server.PluginDisableEvent;
import org.bukkit.inventory.*;
import org.bukkit.plugin.Plugin;
import org.jetbrains.annotations.Contract;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.*;
import java.util.logging.Logger;
/**
* Listens to events for {@link Gui}s. Only one instance of this class gets constructed.
* (One instance per plugin, but plugins are supposed to shade and relocate IF.)
*
* @since 0.5.4
*/
public class GuiListener implements Listener {
/**
* The owning plugin of this listener.
*/
@NotNull
private final Plugin plugin;
/**
* A collection of all {@link Gui} instances that have at least one viewer.
*/
@NotNull
private final Set<Gui> activeGuiInstances = new HashSet<>();
/**
* Creates a new listener for all guis for the provided {@code plugin}.
*
* @param plugin the owning plugin of this listener
* @since 0.10.8
*/
public GuiListener(@NotNull Plugin plugin) {
this.plugin = plugin;
}
/**
* Handles clicks in inventories
*
* @param event the event fired
* @since 0.5.4
*/
@EventHandler(ignoreCancelled = true)
public void onInventoryClick(@NotNull InventoryClickEvent event) {
Gui gui = getGui(event.getInventory());
if (gui == null) {
return;
}
InventoryView view = event.getView();
Inventory inventory = view.getInventory(event.getRawSlot());
if (inventory == null) {
gui.callOnOutsideClick(event);
return;
}
gui.callOnGlobalClick(event);
if (inventory.equals(view.getTopInventory())) {
gui.callOnTopClick(event);
} else {
gui.callOnBottomClick(event);
}
gui.click(event);
if (event.isCancelled()) {
Bukkit.getScheduler().runTask(this.plugin, () -> {
PlayerInventory playerInventory = event.getWhoClicked().getInventory();
/* due to a client issue off-hand items appear as ghost items, this updates the off-hand correctly
client-side */
playerInventory.setItemInOffHand(playerInventory.getItemInOffHand());
});
}
}
/**
* Resets the items into the correct positions for anvil guis
*
* @param event the event fired
* @since 0.8.0
* @deprecated no longer used internally
*/
@Deprecated
public void resetItemsAnvil(@NotNull InventoryClickEvent event) {
InventoryHolder holder = event.getInventory().getHolder();
if (!(holder instanceof AnvilGui) || !(event.getWhoClicked() instanceof Player)) {
return;
}
((AnvilGui) holder).handleClickEvent(event);
}
/**
* Resets the items into the correct positions for beacon guis
*
* @param event the event fired
* @since 0.8.0
*/
@EventHandler(priority = EventPriority.HIGHEST)
public void resetItemsBeacon(@NotNull InventoryClickEvent event) {
InventoryHolder holder = event.getInventory().getHolder();
if (!(holder instanceof BeaconGui) || !(event.getWhoClicked() instanceof Player)) {
return;
}
((BeaconGui) holder).handleClickEvent(event);
}
/**
* Resets the items into the correct positions for cartography table guis
*
* @param event the event fired
* @since 0.8.0
*/
@EventHandler(priority = EventPriority.HIGHEST)
public void resetItemsCartographyTable(@NotNull InventoryClickEvent event) {
InventoryHolder holder = event.getInventory().getHolder();
if (!(holder instanceof CartographyTableGui) || !(event.getWhoClicked() instanceof Player)) {
return;
}
((CartographyTableGui) holder).handleClickEvent(event);
}
/**
* Resets the items into the correct positions for enchanting table guis
*
* @param event the event fired
* @since 0.8.0
*/
@EventHandler(priority = EventPriority.HIGHEST)
public void resetItemsEnchantingTable(@NotNull InventoryClickEvent event) {
InventoryHolder holder = event.getInventory().getHolder();
if (!(holder instanceof EnchantingTableGui) || !(event.getWhoClicked() instanceof Player)) {
return;
}
((EnchantingTableGui) holder).handleClickEvent(event);
}
/**
* Resets the items into the correct positions for grindstone guis
*
* @param event the event fired
* @since 0.8.0
* @deprecated no longer used internally
*/
@Deprecated
public void resetItemsGrindstone(@NotNull InventoryClickEvent event) {
InventoryHolder holder = event.getInventory().getHolder();
if (!(holder instanceof GrindstoneGui) || !(event.getWhoClicked() instanceof Player)) {
return;
}
((GrindstoneGui) holder).handleClickEvent(event);
}
/**
* Resets the items into the correct positions for stonecutter guis
*
* @param event the event fired
* @since 0.8.0
*/
@EventHandler(priority = EventPriority.HIGHEST)
public void resetItemsStonecutter(@NotNull InventoryClickEvent event) {
InventoryHolder holder = event.getInventory().getHolder();
if (!(holder instanceof StonecutterGui) || !(event.getWhoClicked() instanceof Player)) {
return;
}
((StonecutterGui) holder).handleClickEvent(event);
}
/**
* Resets the items into the correct positions for smithing table guis
*
* @param event the event fired
* @since 0.8.0
*/
@EventHandler(priority = EventPriority.HIGHEST)
public void resetItemsSmithingTable(@NotNull InventoryClickEvent event) {
InventoryHolder holder = event.getInventory().getHolder();
if (!(holder instanceof SmithingTableGui) || !(event.getWhoClicked() instanceof Player)) {
return;
}
((SmithingTableGui) holder).handleClickEvent(event);
}
/**
* Handles users picking up items while their bottom inventory is in use.
*
* @param event the event fired when an entity picks up an item
* @since 0.6.1
*/
@EventHandler(ignoreCancelled = true, priority = EventPriority.MONITOR)
public void onEntityPickupItem(@NotNull EntityPickupItemEvent event) {
if (!(event.getEntity() instanceof HumanEntity)) {
return;
}
Gui gui = getGui(((HumanEntity) event.getEntity()).getOpenInventory().getTopInventory());
if (gui == null || !gui.isPlayerInventoryUsed()) {
return;
}
int leftOver = gui.getHumanEntityCache().add((HumanEntity) event.getEntity(), event.getItem().getItemStack());
if (leftOver == 0) {
event.getItem().remove();
} else {
ItemStack itemStack = event.getItem().getItemStack();
itemStack.setAmount(leftOver);
event.getItem().setItemStack(itemStack);
}
event.setCancelled(true);
}
/**
* Handles drag events
*
* @param event the event fired
* @since 0.6.1
*/
@EventHandler
public void onInventoryDrag(@NotNull InventoryDragEvent event) {
Gui gui = getGui(event.getInventory());
if (gui == null) {
return;
}
InventoryView view = event.getView();
Set<Integer> inventorySlots = event.getRawSlots();
if (inventorySlots.size() > 1) {
boolean top = false, bottom = false;
for (int inventorySlot : inventorySlots) {
Inventory inventory = view.getInventory(inventorySlot);
if (view.getTopInventory().equals(inventory)) {
top = true;
} else if (view.getBottomInventory().equals(inventory)) {
bottom = true;
}
if (top && bottom) {
break;
}
}
gui.callOnGlobalDrag(event);
if (top) {
gui.callOnTopDrag(event);
}
if (bottom) {
gui.callOnBottomDrag(event);
}
} else {
int index = inventorySlots.toArray(new Integer[0])[0];
InventoryType.SlotType slotType = view.getSlotType(index);
boolean even = event.getType() == DragType.EVEN;
ClickType clickType = even ? ClickType.LEFT : ClickType.RIGHT;
InventoryAction inventoryAction = even ? InventoryAction.PLACE_SOME : InventoryAction.PLACE_ONE;
ItemStack previousViewCursor = view.getCursor();
// Overwrite getCursor in inventory click event to mimic real event fired by Bukkit.
view.setCursor(event.getOldCursor());
//this is a fake click event, firing this may cause other plugins to function incorrectly, so keep it local
InventoryClickEvent inventoryClickEvent = new InventoryClickEvent(view, slotType, index, clickType,
inventoryAction);
onInventoryClick(inventoryClickEvent);
// Restore previous cursor only if someone has not changed it manually in onInventoryClick.
if (Objects.equals(view.getCursor(), event.getOldCursor())) {
view.setCursor(previousViewCursor);
}
event.setCancelled(inventoryClickEvent.isCancelled());
}
}
/**
* Handles the selection of trades in merchant guis
*
* @param event the event fired
*/
@EventHandler(ignoreCancelled = true)
public void onTradeSelect(@NotNull TradeSelectEvent event) {
Gui gui = getGui(event.getInventory());
if (!(gui instanceof MerchantGui)) {
return;
}
((MerchantGui) gui).callOnTradeSelect(event);
}
/**
* Handles closing in inventories
*
* @param event the event fired
* @since 0.5.4
*/
@EventHandler(ignoreCancelled = true)
public void onInventoryClose(@NotNull InventoryCloseEvent event) {
Gui gui = getGui(event.getInventory());
if (gui == null) {
return;
}
HumanEntity humanEntity = event.getPlayer();
PlayerInventory playerInventory = humanEntity.getInventory();
//due to a client issue off-hand items appear as ghost items, this updates the off-hand correctly client-side
playerInventory.setItemInOffHand(playerInventory.getItemInOffHand());
if (!gui.isUpdating()) {
gui.callOnClose(event);
event.getInventory().clear(); //clear inventory to prevent items being put back
gui.getHumanEntityCache().restoreAndForget(humanEntity);
if (gui.getViewerCount() == 1) {
activeGuiInstances.remove(gui);
}
if (gui instanceof AnvilGui) {
((AnvilGui) gui).handleClose(humanEntity);
} else if (gui instanceof MerchantGui) {
((MerchantGui) gui).handleClose(humanEntity);
} else if (gui instanceof ModernSmithingTableGui) {
((ModernSmithingTableGui) gui).handleClose(humanEntity);
}
//Bukkit doesn't like it if you open an inventory while the previous one is being closed
Bukkit.getScheduler().runTask(this.plugin, () -> gui.navigateToParent(humanEntity));
}
}
/**
* Registers newly opened inventories
*
* @param event the event fired
* @since 0.5.19
*/
@EventHandler(ignoreCancelled = true)
public void onInventoryOpen(@NotNull InventoryOpenEvent event) {
Gui gui = getGui(event.getInventory());
if (gui == null) {
return;
}
activeGuiInstances.add(gui);
}
/**
* Handles the disabling of the plugin
*
* @param event the event fired
* @since 0.5.19
*/
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true)
public void onPluginDisable(@NotNull PluginDisableEvent event) {
if (event.getPlugin() != this.plugin) {
return;
}
int counter = 0; //callbacks might open GUIs, eg. in nested menus
int maxCount = 10;
while (!activeGuiInstances.isEmpty() && counter++ < maxCount) {
for (Gui gui : new ArrayList<>(activeGuiInstances)) {
for (HumanEntity viewer : gui.getViewers()) {
viewer.closeInventory();
}
}
}
if (counter == maxCount) {
Logger logger = this.plugin.getLogger();
logger.warning(
"Unable to close GUIs on plugin disable: they keep getting opened (tried: " + maxCount + " times)"
);
}
}
/**
* Gets the gui from the inventory or null if the inventory isn't a gui
*
* @param inventory the inventory to get the gui from
* @return the gui or null if the inventory doesn't have a gui
* @since 0.8.1
*/
@Nullable
@Contract(pure = true)
private Gui getGui(@NotNull Inventory inventory) {
Gui gui = Gui.getGui(inventory);
if (gui != null) {
return gui;
}
InventoryHolder holder = inventory.getHolder();
if (holder instanceof Gui) {
return (Gui) holder;
}
return null;
}
}