RuneHive-Game
Loading...
Searching...
No Matches
com.runehive.game.plugin.PluginContext Class Reference

The base class that all plugins should extend. More...

Inheritance diagram for com.runehive.game.plugin.PluginContext:
Collaboration diagram for com.runehive.game.plugin.PluginContext:

Public Member Functions

boolean accept (Player player, Event event)
 The method that allows an event listener to accept an event.
void onInit ()
Public Member Functions inherited from com.runehive.game.event.listener.EventListener
default void accept (Event event)

Static Public Attributes

static final Logger logger = LogManager.getLogger(PluginContext.class)

Protected Member Functions

boolean allButOneItemContainer (Player player, ItemContainerContextMenuEvent event)
boolean fifthClickItemContainer (Player player, ItemContainerContextMenuEvent event)
boolean firstClickItem (Player player, ItemClickEvent event)
boolean firstClickItemContainer (Player player, ItemContainerContextMenuEvent event)
boolean firstClickNpc (Player player, NpcClickEvent event)
boolean firstClickObject (Player player, ObjectClickEvent event)
boolean fourthClickItem (Player player, ItemClickEvent event)
boolean fourthClickItemContainer (Player player, ItemContainerContextMenuEvent event)
boolean fourthClickNpc (Player player, NpcClickEvent event)
boolean handleCommand (Player player, CommandParser parser)
boolean itemOnItem (Player player, ItemOnItemEvent event)
boolean itemOnNpc (Player player, ItemOnNpcEvent event)
boolean itemOnObject (Player player, ItemOnObjectEvent event)
boolean itemOnPlayer (Player player, ItemOnPlayerEvent event)
boolean modifiableXItemContainer (Player player, ItemContainerContextMenuEvent event)
boolean onClick (final Player player, final int button)
boolean onDropItem (Player player, DropItemEvent event)
boolean onMovement (Player player, MovementEvent event)
boolean onPickupItem (Player player, PickupItemEvent event)
boolean secondClickItem (Player player, ItemClickEvent event)
boolean secondClickItemContainer (Player player, ItemContainerContextMenuEvent event)
boolean secondClickNpc (Player player, NpcClickEvent event)
boolean secondClickObject (Player player, ObjectClickEvent event)
boolean sixthClickItemContainer (Player player, ItemContainerContextMenuEvent event)
boolean thirdClickItem (Player player, ItemClickEvent event)
boolean thirdClickItemContainer (Player player, ItemContainerContextMenuEvent event)
boolean thirdClickNpc (Player player, NpcClickEvent event)
boolean thirdClickObject (Player player, ObjectClickEvent event)

Private Member Functions

boolean handleButtonClickEvent (Player player, ButtonClickEvent event)
boolean handleCommandEvent (Player player, CommandEvent event)
boolean handleDropItemEvent (Player player, DropItemEvent event)
boolean handleItemClickEvent (Player player, ItemClickEvent event)
boolean handleItemContainerContextMenuEvent (Player player, ItemContainerContextMenuEvent event)
boolean handleItemOnItemEvent (Player player, ItemOnItemEvent event)
boolean handleItemOnNpcEvent (Player player, ItemOnNpcEvent event)
boolean handleItemOnObjectEvent (Player player, ItemOnObjectEvent event)
boolean handleItemOnPlayerEvent (Player player, ItemOnPlayerEvent event)
boolean handleNpcClickEvent (Player player, NpcClickEvent event)
boolean handleObjectClickEvent (Player player, ObjectClickEvent event)
boolean handlePickupItemEvent (Player player, PickupItemEvent event)

Detailed Description

The base class that all plugins should extend.

This class allows plugins to have many different behaviors and listen to all types of events.

Author
nshusa

Definition at line 35 of file PluginContext.java.

Member Function Documentation

◆ accept()

boolean com.runehive.game.plugin.PluginContext.accept ( Player player,
Event event )

The method that allows an event listener to accept an event.

Parameters
playerThe player that is sending the event.
eventThe event that is being sent.
Returns
true If the event was handled. Otherwise return false.

Implements com.runehive.game.event.listener.PlayerEventListener.

Definition at line 44 of file PluginContext.java.

44 {
45 try {
46 if (event instanceof ButtonClickEvent) {
47 return handleButtonClickEvent(player, (ButtonClickEvent) event);
48 } else if (event instanceof ItemClickEvent) {
49 return handleItemClickEvent(player, (ItemClickEvent) event);
50 } else if (event instanceof NpcClickEvent) {
51 return handleNpcClickEvent(player, (NpcClickEvent) event);
52 } else if (event instanceof ObjectClickEvent) {
53 return handleObjectClickEvent(player, (ObjectClickEvent) event);
54 } else if (event instanceof ItemOnItemEvent) {
55 return handleItemOnItemEvent(player, (ItemOnItemEvent) event);
56 } else if (event instanceof ItemOnNpcEvent) {
57 return handleItemOnNpcEvent(player, (ItemOnNpcEvent) event);
58 } else if (event instanceof ItemOnObjectEvent) {
59 return handleItemOnObjectEvent(player, (ItemOnObjectEvent) event);
60 } else if (event instanceof ItemOnPlayerEvent) {
61 return handleItemOnPlayerEvent(player, (ItemOnPlayerEvent) event);
62 } else if (event instanceof CommandEvent) {
63 return handleCommandEvent(player, (CommandEvent) event);
64 } else if (event instanceof ItemContainerContextMenuEvent) {
65 return handleItemContainerContextMenuEvent(player, (ItemContainerContextMenuEvent) event);
66 } else if (event instanceof DropItemEvent) {
67 return handleDropItemEvent(player, (DropItemEvent) event);
68 } else if (event instanceof PickupItemEvent) {
69 return handlePickupItemEvent(player, (PickupItemEvent) event);
70 } else if (event instanceof MovementEvent) {
71 return onMovement(player, (MovementEvent) event);
72 }
73 } catch (Exception ex) {
74 logger.error(String.format("player=%s error while handling event: %s", player.getName(), this.getClass().getSimpleName()), ex);
75 }
76
77 return true;
78 }
com.runehive.game.world.entity.mob.player.Player.getName
String getName()
Gets the name of this entity.
Definition Player.java:774

References com.runehive.game.world.entity.mob.player.Player.getName(), handleButtonClickEvent(), handleCommandEvent(), handleDropItemEvent(), handleItemClickEvent(), handleItemContainerContextMenuEvent(), handleItemOnItemEvent(), handleItemOnNpcEvent(), handleItemOnObjectEvent(), handleItemOnPlayerEvent(), handleNpcClickEvent(), handleObjectClickEvent(), handlePickupItemEvent(), logger, and onMovement().

Here is the call graph for this function:

◆ allButOneItemContainer()

boolean com.runehive.game.plugin.PluginContext.allButOneItemContainer ( Player player,
ItemContainerContextMenuEvent event )
protected

Definition at line 231 of file PluginContext.java.

231 {
232 return false;
233 }

Referenced by handleItemContainerContextMenuEvent().

Here is the caller graph for this function:

◆ fifthClickItemContainer()

boolean com.runehive.game.plugin.PluginContext.fifthClickItemContainer ( Player player,
ItemContainerContextMenuEvent event )
protected

Definition at line 223 of file PluginContext.java.

223 {
224 return false;
225 }

Referenced by handleItemContainerContextMenuEvent().

Here is the caller graph for this function:

◆ firstClickItem()

boolean com.runehive.game.plugin.PluginContext.firstClickItem ( Player player,
ItemClickEvent event )
protected

Definition at line 482 of file PluginContext.java.

482 {
483 return false;
484 }

Referenced by handleItemClickEvent().

Here is the caller graph for this function:

◆ firstClickItemContainer()

boolean com.runehive.game.plugin.PluginContext.firstClickItemContainer ( Player player,
ItemContainerContextMenuEvent event )
protected

Definition at line 207 of file PluginContext.java.

207 {
208 return false;
209 }

Referenced by handleItemContainerContextMenuEvent().

Here is the caller graph for this function:

◆ firstClickNpc()

boolean com.runehive.game.plugin.PluginContext.firstClickNpc ( Player player,
NpcClickEvent event )
protected

Definition at line 421 of file PluginContext.java.

421 {
422 return false;
423 }

Referenced by handleNpcClickEvent().

Here is the caller graph for this function:

◆ firstClickObject()

boolean com.runehive.game.plugin.PluginContext.firstClickObject ( Player player,
ObjectClickEvent event )
protected

Definition at line 347 of file PluginContext.java.

347 {
348 logger.log(Level.INFO, String.format("[%s, type=%d]:first click object=%d", this.getClass().getSimpleName(), event.getType(), event.getObject().getId()));
349 if (player.debug) {
350 player.send(new SendMessage(String.format("[%s, type=%d]: object=%d", this.getClass().getSimpleName(), event.getType(), event.getObject().getId())));
351 }
352 return false;
353 }
com.runehive.game.world.object.GameObject.getId
default int getId()
Gets the object id.
Definition GameObject.java:52

References com.runehive.game.world.entity.mob.player.Player.debug, logger, and com.runehive.game.world.entity.mob.player.Player.send().

Referenced by handleObjectClickEvent().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ fourthClickItem()

boolean com.runehive.game.plugin.PluginContext.fourthClickItem ( Player player,
ItemClickEvent event )
protected

Definition at line 494 of file PluginContext.java.

494 {
495 return false;
496 }

Referenced by handleItemClickEvent().

Here is the caller graph for this function:

◆ fourthClickItemContainer()

boolean com.runehive.game.plugin.PluginContext.fourthClickItemContainer ( Player player,
ItemContainerContextMenuEvent event )
protected

Definition at line 219 of file PluginContext.java.

219 {
220 return false;
221 }

Referenced by handleItemContainerContextMenuEvent().

Here is the caller graph for this function:

◆ fourthClickNpc()

boolean com.runehive.game.plugin.PluginContext.fourthClickNpc ( Player player,
NpcClickEvent event )
protected

Definition at line 433 of file PluginContext.java.

433 {
434 return false;
435 }

Referenced by handleNpcClickEvent().

Here is the caller graph for this function:

◆ handleButtonClickEvent()

boolean com.runehive.game.plugin.PluginContext.handleButtonClickEvent ( Player player,
ButtonClickEvent event )
private

Definition at line 498 of file PluginContext.java.

498 {
499 if (onClick(player, event.getButton())) {
500 if (player.debug) {
501 player.send(new SendMessage(String.format("[%s]: button=%d", this.getClass().getSimpleName(), event.getButton())));
502 }
503 return true;
504 }
505 return false;
506 }

References com.runehive.game.world.entity.mob.player.Player.debug, onClick(), and com.runehive.game.world.entity.mob.player.Player.send().

Referenced by accept().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ handleCommand()

boolean com.runehive.game.plugin.PluginContext.handleCommand ( Player player,
CommandParser parser )
protected

Reimplemented in com.runehive.game.plugin.extension.CommandExtension.

Definition at line 249 of file PluginContext.java.

249 {
250 return false;
251 }

Referenced by handleCommandEvent().

Here is the caller graph for this function:

◆ handleCommandEvent()

boolean com.runehive.game.plugin.PluginContext.handleCommandEvent ( Player player,
CommandEvent event )
private

Definition at line 239 of file PluginContext.java.

239 {
240 if (handleCommand(player, event.getParser())) {
241 if (Config.LOG_PLAYER) {
242 World.getDataBus().publish(new CommandLogEvent(player, event.getParser()));
243 }
244 return true;
245 }
246 return false;
247 }

References com.runehive.game.world.World.getDataBus(), handleCommand(), com.runehive.Config.LOG_PLAYER, and com.runehive.game.event.bus.DataBus.publish().

Referenced by accept().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ handleDropItemEvent()

boolean com.runehive.game.plugin.PluginContext.handleDropItemEvent ( Player player,
DropItemEvent event )
private

Definition at line 100 of file PluginContext.java.

100 {
101 if (onDropItem(player, event)) {
102 logger.log(Level.INFO, String.format("player=%s dropped item=%d amount=%d slot=%d position=%s", player.getName(), event.getItem().getId(), event.getItem().getAmount(), event.getSlot(), event.getPosition()));
103 if (PlayerRight.isDeveloper(player)) {
104 player.send(new SendMessage(String.format("[%s]: item=%d amount=%d slot=%d position=%s", this.getClass().getSimpleName(), event.getItem().getId(), event.getItem().getAmount(), event.getSlot(), event.getPosition())));
105 }
106 return true;
107 }
108 return false;
109 }
com.runehive.game.world.items.Item.getId
final int getId()
Gets the identification of this item.
Definition Item.java:324
com.runehive.game.world.items.Item.getAmount
final int getAmount()
Gets the quantity of this item.
Definition Item.java:342

References com.runehive.game.world.entity.mob.player.Player.getName(), com.runehive.game.world.entity.mob.player.PlayerRight.isDeveloper(), logger, onDropItem(), and com.runehive.game.world.entity.mob.player.Player.send().

Referenced by accept().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ handleItemClickEvent()

boolean com.runehive.game.plugin.PluginContext.handleItemClickEvent ( Player player,
ItemClickEvent event )
private

Definition at line 437 of file PluginContext.java.

437 {
438 switch(event.getType()) {
439 case 1:
440 if (firstClickItem(player, event)) {
441 logger.log(Level.INFO, String.format("[%s, type=%d]:first click item=%d", this.getClass().getSimpleName(), event.getType(), event.getItem().getId()));
442 if (player.debug) {
443 player.send(new SendMessage(String.format("[%s, type=%d]: item=%d", this.getClass().getSimpleName(), event.getType(), event.getItem().getId())));
444 }
445 return true;
446 }
447 break;
448
449 case 2:
450 if (secondClickItem(player, event)) {
451 logger.log(Level.INFO, String.format("[%s, type=%d]:second click item=%d", this.getClass().getSimpleName(), event.getType(), event.getItem().getId()));
452 if (player.debug) {
453 player.send(new SendMessage(String.format("[%s, type=%d]: item=%d", this.getClass().getSimpleName(), event.getType(), event.getItem().getId())));
454 }
455 return true;
456 }
457 break;
458
459 case 3:
460 if (thirdClickItem(player, event)) {
461 logger.log(Level.INFO, String.format("[%s, type=%d]:third click item=%d", this.getClass().getSimpleName(), event.getType(), event.getItem().getId()));
462 if (player.debug) {
463 player.send(new SendMessage(String.format("[%s, type=%d]: item=%d", this.getClass().getSimpleName(), event.getType(), event.getItem().getId())));
464 }
465 return true;
466 }
467 break;
468
469 case 4:
470 if (fourthClickItem(player, event)) {
471 logger.log(Level.INFO, String.format("[%s, type=%d]:fourth click item=%d", this.getClass().getSimpleName(), event.getType(), event.getItem().getId()));
472 if (player.debug) {
473 player.send(new SendMessage(String.format("[%s, type=%d]: item=%d", this.getClass().getSimpleName(), event.getType(), event.getItem().getId())));
474 }
475 return true;
476 }
477 break;
478 }
479 return false;
480 }

References com.runehive.game.world.entity.mob.player.Player.debug, firstClickItem(), fourthClickItem(), logger, secondClickItem(), com.runehive.game.world.entity.mob.player.Player.send(), and thirdClickItem().

Referenced by accept().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ handleItemContainerContextMenuEvent()

boolean com.runehive.game.plugin.PluginContext.handleItemContainerContextMenuEvent ( Player player,
ItemContainerContextMenuEvent event )
private

Definition at line 115 of file PluginContext.java.

115 {
116 switch(event.getType()) {
117 case 1:
118 if (firstClickItemContainer(player, event)) {
119 logger.log(Level.INFO, String.format("[%s, type=%d]: first item interfaceId=%d (removeId=%d, removeSlot=%d)", this.getClass().getSimpleName(), event.getType(), event.getInterfaceId(), event.getRemoveId(), event.getRemoveSlot()));
120 if (PlayerRight.isDeveloper(player)) {
121 player.send(new SendMessage(String.format("[%s, type=%d]: interfaceId=%d (removeId=%d, removeSlot=%d)", this.getClass().getSimpleName(), event.getType(), event.getInterfaceId(), event.getRemoveId(), event.getRemoveSlot())));
122 }
123 return true;
124 }
125 break;
126
127 case 2:
128 if (secondClickItemContainer(player, event)) {
129 logger.log(Level.INFO, String.format("[%s, type=%d]: second item interfaceId=%d (removeId=%d, removeSlot=%d)", this.getClass().getSimpleName(), event.getType(), event.getInterfaceId(), event.getRemoveId(), event.getRemoveSlot()));
130
131 if (PlayerRight.isDeveloper(player)) {
132 player.send(new SendMessage(String.format("[%s, type=%d]: interfaceId=%d (removeId=%d, removeSlot=%d)", this.getClass().getSimpleName(), event.getType(), event.getInterfaceId(), event.getRemoveId(), event.getRemoveSlot())));
133 }
134 return true;
135 }
136 break;
137
138 case 3:
139 if (thirdClickItemContainer(player, event)) {
140 logger.log(Level.INFO, String.format("[%s, type=%d]: third item interfaceId=%d (removeId=%d, removeSlot=%d)", this.getClass().getSimpleName(), event.getType(), event.getInterfaceId(), event.getRemoveId(), event.getRemoveSlot()));
141
142 if (PlayerRight.isDeveloper(player)) {
143 player.send(new SendMessage(String.format("[%s, type=%d]: interfaceId=%d (removeId=%d, removeSlot=%d)", this.getClass().getSimpleName(), event.getType(), event.getInterfaceId(), event.getRemoveId(), event.getRemoveSlot())));
144 }
145 return true;
146 }
147 break;
148
149 case 4:
150 if (fourthClickItemContainer(player, event)) {
151 logger.log(Level.INFO, String.format("[%s, type=%d]: fourth item interfaceId=%d (removeId=%d, removeSlot=%d)", this.getClass().getSimpleName(), event.getType(), event.getInterfaceId(), event.getRemoveId(), event.getRemoveSlot()));
152
153 if (PlayerRight.isDeveloper(player)) {
154 player.send(new SendMessage(String.format("[%s, type=%d]: interfaceId=%d (removeId=%d, removeSlot=%d)", this.getClass().getSimpleName(), event.getType(), event.getInterfaceId(), event.getRemoveId(), event.getRemoveSlot())));
155 }
156 return true;
157 }
158 break;
159
160 case 5:
161 if (fifthClickItemContainer(player, event)) {
162 logger.log(Level.INFO, String.format("[%s, type=%d]: fifth item interfaceId=%d (removeId=%d, removeSlot=%d)", this.getClass().getSimpleName(), event.getType(), event.getInterfaceId(), event.getRemoveId(), event.getRemoveSlot()));
163
164 if (PlayerRight.isDeveloper(player) ) {
165 player.send(new SendMessage(String.format("[%s, type=%d]: interfaceId=%d (removeId=%d, removeSlot=%d)", this.getClass().getSimpleName(), event.getType(), event.getInterfaceId(), event.getRemoveId(), event.getRemoveSlot())));
166 }
167 return true;
168 }
169 break;
170
171 case 6:
172 if (sixthClickItemContainer(player, event)) {
173 logger.log(Level.INFO, String.format("[%s, type=%d]: sixth item interfaceId=%d (removeId=%d, removeSlot=%d)", this.getClass().getSimpleName(), event.getType(), event.getInterfaceId(), event.getRemoveId(), event.getRemoveSlot()));
174
175 if (PlayerRight.isDeveloper(player) ) {
176 player.send(new SendMessage(String.format("[%s, type=%d]: interfaceId=%d (removeId=%d, removeSlot=%d)", this.getClass().getSimpleName(), event.getType(), event.getInterfaceId(), event.getRemoveId(), event.getRemoveSlot())));
177 }
178 return true;
179 }
180 break;
181
182 case 7:
183 if (allButOneItemContainer(player, event)) {
184 logger.log(Level.INFO, String.format("[%s, type=%d]: seventh item interfaceId=%d (removeId=%d, removeSlot=%d)", this.getClass().getSimpleName(), event.getType(), event.getInterfaceId(), event.getRemoveId(), event.getRemoveSlot()));
185
186 if (PlayerRight.isDeveloper(player)) {
187 player.send(new SendMessage(String.format("[%s, type=%d]: interfaceId=%d (removeId=%d, removeSlot=%d)", this.getClass().getSimpleName(), event.getType(), event.getInterfaceId(), event.getRemoveId(), event.getRemoveSlot())));
188 }
189 return true;
190 }
191 break;
192
193 case 8:
194 if (modifiableXItemContainer(player, event)) {
195 logger.log(Level.INFO, String.format("[%s, type=%d]: eight item interfaceId=%d (removeId=%d, removeSlot=%d)", this.getClass().getSimpleName(), event.getType(), event.getInterfaceId(), event.getRemoveId(), event.getRemoveSlot()));
196
197 if (PlayerRight.isDeveloper(player) ) {
198 player.send(new SendMessage(String.format("[%s, type=%d]: interfaceId=%d (removeId=%d, removeSlot=%d)", this.getClass().getSimpleName(), event.getType(), event.getInterfaceId(), event.getRemoveId(), event.getRemoveSlot())));
199 }
200 return true;
201 }
202 break;
203 }
204 return false;
205 }

References allButOneItemContainer(), fifthClickItemContainer(), firstClickItemContainer(), fourthClickItemContainer(), com.runehive.game.world.entity.mob.player.PlayerRight.isDeveloper(), logger, modifiableXItemContainer(), secondClickItemContainer(), com.runehive.game.world.entity.mob.player.Player.send(), sixthClickItemContainer(), and thirdClickItemContainer().

Referenced by accept().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ handleItemOnItemEvent()

boolean com.runehive.game.plugin.PluginContext.handleItemOnItemEvent ( Player player,
ItemOnItemEvent event )
private

Definition at line 297 of file PluginContext.java.

297 {
298 if (itemOnItem(player, event)) {
299 logger.log(Level.INFO, String.format("[%s]: used=%d usedSlot=%d with=%d withSlot=%d", this.getClass().getSimpleName(), event.getUsed().getId(), event.getUsedSlot(), event.getWith().getId(), event.getWithSlot()));
300 if (player.debug) {
301 player.send(new SendMessage(String.format("[%s]: used=%d usedSlot=%d with=%d withSlot=%d", this.getClass().getSimpleName(), event.getUsed().getId(), event.getUsedSlot(), event.getWith().getId(), event.getWithSlot())));
302 }
303 return true;
304 }
305 return false;
306 }

References com.runehive.game.world.entity.mob.player.Player.debug, itemOnItem(), logger, and com.runehive.game.world.entity.mob.player.Player.send().

Referenced by accept().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ handleItemOnNpcEvent()

boolean com.runehive.game.plugin.PluginContext.handleItemOnNpcEvent ( Player player,
ItemOnNpcEvent event )
private

Definition at line 282 of file PluginContext.java.

282 {
283 if (itemOnNpc(player, event)) {
284 logger.log(Level.INFO, String.format("[%s]: item=%d slot=%d npc=%d", this.getClass().getSimpleName(), event.getUsed().getId(), event.getSlot(), event.getNpc().id));
285 if (player.debug) {
286 player.send(new SendMessage(String.format("[%s]: item=%d slot=%d npc=%d", this.getClass().getSimpleName(), event.getUsed().getId(), event.getSlot(), event.getNpc().id)));
287 }
288 return true;
289 }
290 return false;
291 }

References com.runehive.game.world.entity.mob.player.Player.debug, itemOnNpc(), logger, and com.runehive.game.world.entity.mob.player.Player.send().

Referenced by accept().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ handleItemOnObjectEvent()

boolean com.runehive.game.plugin.PluginContext.handleItemOnObjectEvent ( Player player,
ItemOnObjectEvent event )
private

Definition at line 267 of file PluginContext.java.

267 {
268 if (itemOnObject(player, event)) {
269 logger.log(Level.INFO, String.format("[%s]: item=%d slot=%d object=%d", this.getClass().getSimpleName(), event.getUsed().getId(), event.getSlot(), event.getObject().getId()));
270 if (player.debug) {
271 player.send(new SendMessage(String.format("[%s]: item=%d slot=%d object=%d", this.getClass().getSimpleName(), event.getUsed().getId(), event.getSlot(), event.getObject().getId())));
272 }
273 return true;
274 }
275 return false;
276 }

References com.runehive.game.world.entity.mob.player.Player.debug, itemOnObject(), logger, and com.runehive.game.world.entity.mob.player.Player.send().

Referenced by accept().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ handleItemOnPlayerEvent()

boolean com.runehive.game.plugin.PluginContext.handleItemOnPlayerEvent ( Player player,
ItemOnPlayerEvent event )
private

Definition at line 253 of file PluginContext.java.

253 {
254 if (itemOnPlayer(player, event)) {
255 if (player.debug) {
256 player.send(new SendMessage(String.format("[%s]: item=%d slot=%d player=%s", this.getClass().getSimpleName(), event.getUsed().getId(), event.getSlot(), event.getOther().getName())));
257 }
258 return true;
259 }
260 return false;
261 }

References com.runehive.game.world.entity.mob.player.Player.debug, itemOnPlayer(), and com.runehive.game.world.entity.mob.player.Player.send().

Referenced by accept().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ handleNpcClickEvent()

boolean com.runehive.game.plugin.PluginContext.handleNpcClickEvent ( Player player,
NpcClickEvent event )
private

Definition at line 373 of file PluginContext.java.

373 {
374 switch(event.getType()) {
375 case 1:
376
377 if (firstClickNpc(player, event)) {
378 logger.log(Level.INFO, String.format("[%s, type=%d]:first click npc=%d", this.getClass().getSimpleName(), event.getType(), event.getNpc().id));
379 if (player.debug) {
380 player.send(new SendMessage(String.format("[%s, type=%d]: npc=%d", this.getClass().getSimpleName(), event.getType(), event.getNpc().id)));
381 }
382 return true;
383 }
384 break;
385
386 case 2:
387 if (secondClickNpc(player, event)) {
388 logger.log(Level.INFO, String.format("[%s, type=%d]:second click npc=%d", this.getClass().getSimpleName(), event.getType(), event.getNpc().id));
389 if (player.debug) {
390 player.send(new SendMessage(String.format("[%s, type=%d]: npc=%d", this.getClass().getSimpleName(), event.getType(), event.getNpc().id)));
391 }
392 return true;
393 }
394 break;
395
396
397 case 3:
398 if (thirdClickNpc(player, event)) {
399 logger.log(Level.INFO, String.format("[%s, type=%d]:third click npc=%d", this.getClass().getSimpleName(), event.getType(), event.getNpc().id));
400 if (player.debug) {
401 player.send(new SendMessage(String.format("[%s, type=%d]: npc=%d", this.getClass().getSimpleName(), event.getType(), event.getNpc().id)));
402 }
403 return true;
404 }
405 break;
406
407 case 4:
408 if (fourthClickNpc(player, event)) {
409 logger.log(Level.INFO, String.format("[%s, type=%d]:fourth click npc=%d", this.getClass().getSimpleName(), event.getType(), event.getNpc().id));
410 if (player.debug) {
411 player.send(new SendMessage(String.format("[%s, type=%d]: npc=%d", this.getClass().getSimpleName(), event.getType(), event.getNpc().id)));
412 }
413 return true;
414 }
415 break;
416 }
417
418 return false;
419 }

References com.runehive.game.world.entity.mob.player.Player.debug, firstClickNpc(), fourthClickNpc(), logger, secondClickNpc(), com.runehive.game.world.entity.mob.player.Player.send(), and thirdClickNpc().

Referenced by accept().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ handleObjectClickEvent()

boolean com.runehive.game.plugin.PluginContext.handleObjectClickEvent ( Player player,
ObjectClickEvent event )
private

Definition at line 312 of file PluginContext.java.

312 {
313 switch(event.getType()) {
314 case 1:
315 if (firstClickObject(player, event)) {
316 logger.log(Level.INFO, String.format("[%s, type=%d]:first click object=%d", this.getClass().getSimpleName(), event.getType(), event.getObject().getId()));
317 if (player.debug) {
318 player.send(new SendMessage(String.format("[%s, type=%d]: object=%d", this.getClass().getSimpleName(), event.getType(), event.getObject().getId())));
319 }
320 return true;
321 }
322 break;
323
324 case 2:
325 if (secondClickObject(player, event)) {
326 logger.log(Level.INFO, String.format("[%s, type=%d]:second click object=%d", this.getClass().getSimpleName(), event.getType(), event.getObject().getId()));
327 if (player.debug) {
328 player.send(new SendMessage(String.format("[%s, type=%d]: object=%d", this.getClass().getSimpleName(), event.getType(), event.getObject().getId())));
329 }
330 return true;
331 }
332 break;
333
334 case 3:
335 if (thirdClickObject(player, event)) {
336 logger.log(Level.INFO, String.format("[%s, type=%d]:third click object=%d", this.getClass().getSimpleName(), event.getType(), event.getObject().getId()));
337 if (player.debug) {
338 player.send(new SendMessage(String.format("[%s, type=%d]: object=%d", this.getClass().getSimpleName(), event.getType(), event.getObject().getId())));
339 }
340 return true;
341 }
342 break;
343 }
344 return false;
345 }

References com.runehive.game.world.entity.mob.player.Player.debug, firstClickObject(), logger, secondClickObject(), com.runehive.game.world.entity.mob.player.Player.send(), and thirdClickObject().

Referenced by accept().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ handlePickupItemEvent()

boolean com.runehive.game.plugin.PluginContext.handlePickupItemEvent ( Player player,
PickupItemEvent event )
private

Definition at line 84 of file PluginContext.java.

84 {
85 if (onPickupItem(player, event)) {
86 logger.log(Level.INFO, String.format("player=%s picked up item=%d amount=%d position=%s", player.getName(), event.getItem().getId(), event.getItem().getAmount(), event.getPosition()));
87 if (PlayerRight.isDeveloper(player)) {
88 player.send(new SendMessage(String.format("[%s]: item=%d position=%s", this.getClass().getSimpleName(), event.getItem().getId(), event.getPosition().toString())));
89 }
90 World.getDataBus().publish(new PickupItemLogEvent(player, event.getGroundItem()));
91 return true;
92 }
93 return false;
94 }

References com.runehive.game.world.World.getDataBus(), com.runehive.game.world.entity.mob.player.Player.getName(), com.runehive.game.world.entity.mob.player.PlayerRight.isDeveloper(), logger, onPickupItem(), com.runehive.game.event.bus.DataBus.publish(), and com.runehive.game.world.entity.mob.player.Player.send().

Referenced by accept().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ itemOnItem()

boolean com.runehive.game.plugin.PluginContext.itemOnItem ( Player player,
ItemOnItemEvent event )
protected

Definition at line 308 of file PluginContext.java.

308 {
309 return false;
310 }

Referenced by handleItemOnItemEvent().

Here is the caller graph for this function:

◆ itemOnNpc()

boolean com.runehive.game.plugin.PluginContext.itemOnNpc ( Player player,
ItemOnNpcEvent event )
protected

Definition at line 293 of file PluginContext.java.

293 {
294 return false;
295 }

Referenced by handleItemOnNpcEvent().

Here is the caller graph for this function:

◆ itemOnObject()

boolean com.runehive.game.plugin.PluginContext.itemOnObject ( Player player,
ItemOnObjectEvent event )
protected

Definition at line 278 of file PluginContext.java.

278 {
279 return false;
280 }

Referenced by handleItemOnObjectEvent().

Here is the caller graph for this function:

◆ itemOnPlayer()

boolean com.runehive.game.plugin.PluginContext.itemOnPlayer ( Player player,
ItemOnPlayerEvent event )
protected

Definition at line 263 of file PluginContext.java.

263 {
264 return false;
265 }

Referenced by handleItemOnPlayerEvent().

Here is the caller graph for this function:

◆ modifiableXItemContainer()

boolean com.runehive.game.plugin.PluginContext.modifiableXItemContainer ( Player player,
ItemContainerContextMenuEvent event )
protected

Definition at line 235 of file PluginContext.java.

235 {
236 return false;
237 }

Referenced by handleItemContainerContextMenuEvent().

Here is the caller graph for this function:

◆ onClick()

boolean com.runehive.game.plugin.PluginContext.onClick ( final Player player,
final int button )
protected

Definition at line 508 of file PluginContext.java.

508 {
509 switch (button) {
510 case 29404:
511 player.send(new SendURL("https://runehive.com"));
512 return true;
513 case 29408:
514 InterfaceWriter.write(new AchievementWriter(player));
515 player.interfaceManager.setSidebar(Config.QUEST_TAB, 35_000);
516 return true;
517
518 case 29411:
519 InterfaceWriter.write(new InformationWriter(player));
520 return true;
521 case -30528:
522 InterfaceWriter.write(new InformationWriter(player));
523 player.interfaceManager.setSidebar(Config.QUEST_TAB, 29_400);
524 return true;
525 case -30525:
526 player.dialogueFactory.sendOption("Activity Logger", () -> {
527 player.dialogueFactory.onAction(player.activityLogger::open);
528 }, "Drop Simulator", () -> {
529 player.dialogueFactory.onAction(() -> DropSimulator.open(player));
530 /* }, "Activity Logger", () -> {
531 player.dialogueFactory.onAction(player.activityLogger::open);*/
532 }, "Title Manager", () -> {
533 player.dialogueFactory.onAction(() -> TitleManager.open(player));
534 }, "Slayer Interface", () -> {
535 player.dialogueFactory.onAction(() -> player.slayer.open(SlayerTab.MAIN));
536 }).execute();
537 return true;
538 case -30085:
539 ProfileViewer.open(player, player);
540 return true;
541
542 case -30084:
543 player.activityLogger.open();
544 return true;
545
546 case -30083:
547 TitleManager.open(player);
548 return true;
549
550 case -30082:
551 DropDisplay.open(player);
552 return true;
553
554 case -30081:
555 DropSimulator.open(player);
556 return true;
557
558 case -30080:
559 player.gameRecord.display(ActivityType.getFirst());
560 return true;
561
562 }
563 return false;
564 }

References com.runehive.game.world.entity.mob.player.Player.activityLogger, com.runehive.game.world.entity.mob.player.Player.dialogueFactory, com.runehive.content.activity.record.PlayerRecord.display(), com.runehive.game.world.entity.mob.player.Player.gameRecord, com.runehive.content.activity.ActivityType.getFirst(), com.runehive.game.world.entity.mob.player.Player.interfaceManager, com.runehive.content.skill.impl.slayer.SlayerTab.MAIN, com.runehive.content.dialogue.DialogueFactory.onAction(), com.runehive.content.ActivityLogger.open(), com.runehive.content.DropDisplay.open(), com.runehive.content.ProfileViewer.open(), com.runehive.content.simulator.DropSimulator.open(), com.runehive.content.skill.impl.slayer.Slayer.open(), com.runehive.content.tittle.TitleManager.open(), com.runehive.Config.QUEST_TAB, com.runehive.game.world.entity.mob.player.Player.send(), com.runehive.content.dialogue.DialogueFactory.sendOption(), com.runehive.game.world.entity.mob.player.InterfaceManager.setSidebar(), com.runehive.game.world.entity.mob.player.Player.slayer, and com.runehive.content.writer.InterfaceWriter.write().

Referenced by handleButtonClickEvent().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ onDropItem()

boolean com.runehive.game.plugin.PluginContext.onDropItem ( Player player,
DropItemEvent event )
protected

Definition at line 111 of file PluginContext.java.

111 {
112 return false;
113 }

Referenced by handleDropItemEvent().

Here is the caller graph for this function:

◆ onInit()

void com.runehive.game.plugin.PluginContext.onInit ( )

Reimplemented in com.runehive.game.plugin.extension.CommandExtension.

Definition at line 39 of file PluginContext.java.

39 {
40
41 }

Referenced by com.runehive.game.plugin.PluginManager.load().

Here is the caller graph for this function:

◆ onMovement()

boolean com.runehive.game.plugin.PluginContext.onMovement ( Player player,
MovementEvent event )
protected

Definition at line 80 of file PluginContext.java.

80 {
81 return false;
82 }

Referenced by accept().

Here is the caller graph for this function:

◆ onPickupItem()

boolean com.runehive.game.plugin.PluginContext.onPickupItem ( Player player,
PickupItemEvent event )
protected

Definition at line 96 of file PluginContext.java.

96 {
97 return false;
98 }

Referenced by handlePickupItemEvent().

Here is the caller graph for this function:

◆ secondClickItem()

boolean com.runehive.game.plugin.PluginContext.secondClickItem ( Player player,
ItemClickEvent event )
protected

Definition at line 486 of file PluginContext.java.

486 {
487 return false;
488 }

Referenced by handleItemClickEvent().

Here is the caller graph for this function:

◆ secondClickItemContainer()

boolean com.runehive.game.plugin.PluginContext.secondClickItemContainer ( Player player,
ItemContainerContextMenuEvent event )
protected

Definition at line 211 of file PluginContext.java.

211 {
212 return false;
213 }

Referenced by handleItemContainerContextMenuEvent().

Here is the caller graph for this function:

◆ secondClickNpc()

boolean com.runehive.game.plugin.PluginContext.secondClickNpc ( Player player,
NpcClickEvent event )
protected

Definition at line 425 of file PluginContext.java.

425 {
426 return false;
427 }

Referenced by handleNpcClickEvent().

Here is the caller graph for this function:

◆ secondClickObject()

boolean com.runehive.game.plugin.PluginContext.secondClickObject ( Player player,
ObjectClickEvent event )
protected

Definition at line 355 of file PluginContext.java.

355 {
356 logger.log(Level.INFO, String.format("[%s, type=%d]:second click object=%d", this.getClass().getSimpleName(), event.getType(), event.getObject().getId()));
357
358 if (player.debug) {
359 player.send(new SendMessage(String.format("[%s, type=%d]: object=%d", this.getClass().getSimpleName(), event.getType(), event.getObject().getId())));
360 }
361 return false;
362 }

References com.runehive.game.world.entity.mob.player.Player.debug, logger, and com.runehive.game.world.entity.mob.player.Player.send().

Referenced by handleObjectClickEvent().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ sixthClickItemContainer()

boolean com.runehive.game.plugin.PluginContext.sixthClickItemContainer ( Player player,
ItemContainerContextMenuEvent event )
protected

Definition at line 227 of file PluginContext.java.

227 {
228 return false;
229 }

Referenced by handleItemContainerContextMenuEvent().

Here is the caller graph for this function:

◆ thirdClickItem()

boolean com.runehive.game.plugin.PluginContext.thirdClickItem ( Player player,
ItemClickEvent event )
protected

Definition at line 490 of file PluginContext.java.

490 {
491 return false;
492 }

Referenced by handleItemClickEvent().

Here is the caller graph for this function:

◆ thirdClickItemContainer()

boolean com.runehive.game.plugin.PluginContext.thirdClickItemContainer ( Player player,
ItemContainerContextMenuEvent event )
protected

Definition at line 215 of file PluginContext.java.

215 {
216 return false;
217 }

Referenced by handleItemContainerContextMenuEvent().

Here is the caller graph for this function:

◆ thirdClickNpc()

boolean com.runehive.game.plugin.PluginContext.thirdClickNpc ( Player player,
NpcClickEvent event )
protected

Definition at line 429 of file PluginContext.java.

429 {
430 return false;
431 }

Referenced by handleNpcClickEvent().

Here is the caller graph for this function:

◆ thirdClickObject()

boolean com.runehive.game.plugin.PluginContext.thirdClickObject ( Player player,
ObjectClickEvent event )
protected

Definition at line 364 of file PluginContext.java.

364 {
365 logger.log(Level.INFO, String.format("[%s, type=%d]:third click object=%d", this.getClass().getSimpleName(), event.getType(), event.getObject().getId()));
366
367 if (player.debug) {
368 player.send(new SendMessage(String.format("[%s, type=%d]: object=%d", this.getClass().getSimpleName(), event.getType(), event.getObject().getId())));
369 }
370 return false;
371 }

References com.runehive.game.world.entity.mob.player.Player.debug, logger, and com.runehive.game.world.entity.mob.player.Player.send().

Referenced by handleObjectClickEvent().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ logger

final Logger com.runehive.game.plugin.PluginContext.logger = LogManager.getLogger(PluginContext.class)
static

Definition at line 37 of file PluginContext.java.

Referenced by accept(), firstClickObject(), handleDropItemEvent(), handleItemClickEvent(), handleItemContainerContextMenuEvent(), handleItemOnItemEvent(), handleItemOnNpcEvent(), handleItemOnObjectEvent(), handleNpcClickEvent(), handleObjectClickEvent(), handlePickupItemEvent(), secondClickObject(), and thirdClickObject().

The documentation for this class was generated from the following file: