From 5c0a11dab04555efadcabcdd26ff5c5bdff2e8c9 Mon Sep 17 00:00:00 2001 From: Major- Date: Sun, 16 Feb 2014 17:47:22 +0000 Subject: [PATCH] Standardise comments in Event implementations. --- .../game/event/impl/AddFriendEvent.java | 2 +- .../game/event/impl/AddIgnoreEvent.java | 2 +- .../apollo/game/event/impl/ButtonEvent.java | 2 +- src/org/apollo/game/event/impl/ChatEvent.java | 2 +- .../game/event/impl/CloseInterfaceEvent.java | 2 +- .../game/event/impl/ClosedInterfaceEvent.java | 2 +- .../apollo/game/event/impl/CommandEvent.java | 2 +- .../apollo/game/event/impl/ConfigEvent.java | 2 +- .../event/impl/DialogueContinueEvent.java | 2 +- .../event/impl/DisplayTabInterfaceEvent.java | 2 +- .../game/event/impl/EnterAmountEvent.java | 2 +- .../game/event/impl/EnteredAmountEvent.java | 2 +- .../game/event/impl/FifthItemOptionEvent.java | 2 +- .../game/event/impl/FirstItemOptionEvent.java | 2 +- .../event/impl/FirstObjectActionEvent.java | 2 +- .../game/event/impl/FocusUpdateEvent.java | 6 ++--- .../impl/ForwardPrivateMessageEvent.java | 2 +- .../event/impl/FriendServerStatusEvent.java | 2 +- .../game/event/impl/IdAssignmentEvent.java | 2 +- .../game/event/impl/IgnoreListEvent.java | 2 +- .../game/event/impl/InventoryItemEvent.java | 4 ++-- .../game/event/impl/ItemActionEvent.java | 4 +++- .../game/event/impl/ItemOnItemEvent.java | 2 +- .../game/event/impl/ItemOptionEvent.java | 5 +++-- .../game/event/impl/KeepAliveEvent.java | 2 +- .../apollo/game/event/impl/LogoutEvent.java | 2 +- .../game/event/impl/MagicOnItemEvent.java | 2 +- .../event/impl/MobAnimationResetEvent.java | 4 ++-- .../game/event/impl/MouseClickEvent.java | 4 ++-- .../game/event/impl/NpcActionEvent.java | 22 ++++++++++--------- .../event/impl/NpcSynchronizationEvent.java | 4 ++-- .../game/event/impl/ObjectActionEvent.java | 4 +++- .../impl/OpenDialogueInterfaceEvent.java | 2 +- .../game/event/impl/OpenInterfaceEvent.java | 2 +- .../event/impl/OpenInterfaceSidebarEvent.java | 2 +- .../game/event/impl/PlayerDesignEvent.java | 2 +- .../impl/PlayerSynchronizationEvent.java | 2 +- .../apollo/game/event/impl/PositionEvent.java | 3 +-- .../game/event/impl/PrivacyOptionEvent.java | 3 ++- .../game/event/impl/RegionChangeEvent.java | 2 +- .../game/event/impl/RemoveFriendEvent.java | 2 +- .../game/event/impl/RemoveIgnoreEvent.java | 2 +- .../game/event/impl/RemoveTileItemEvent.java | 2 +- .../event/impl/SecondItemOptionEvent.java | 2 +- .../event/impl/SecondObjectActionEvent.java | 2 +- .../game/event/impl/ServerMessageEvent.java | 2 +- .../event/impl/SetWidgetItemModelEvent.java | 2 +- .../impl/SetWidgetModelAnimationEvent.java | 2 +- .../event/impl/SetWidgetNpcModelEvent.java | 2 +- .../event/impl/SetWidgetPlayerModelEvent.java | 2 +- .../game/event/impl/SetWidgetTextEvent.java | 2 +- .../event/impl/SetWidgetVisibilityEvent.java | 4 ++-- .../game/event/impl/SpamPacketEvent.java | 4 ++-- .../game/event/impl/SwitchItemEvent.java | 2 +- .../event/impl/SwitchTabInterfaceEvent.java | 2 +- .../game/event/impl/TakeTileItemEvent.java | 2 +- .../event/impl/ThirdObjectActionEvent.java | 2 +- .../game/event/impl/UpdateItemsEvent.java | 2 +- .../game/event/impl/UpdateRunEnergyEvent.java | 2 +- .../event/impl/UpdateSlottedItemsEvent.java | 2 +- .../game/event/impl/UpdateTileItemEvent.java | 2 +- src/org/apollo/game/event/impl/WalkEvent.java | 2 +- 62 files changed, 88 insertions(+), 81 deletions(-) diff --git a/src/org/apollo/game/event/impl/AddFriendEvent.java b/src/org/apollo/game/event/impl/AddFriendEvent.java index 8a832588..ce442241 100644 --- a/src/org/apollo/game/event/impl/AddFriendEvent.java +++ b/src/org/apollo/game/event/impl/AddFriendEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An {@link Event} sent by the client when a player is befriended. + * An {@link Event} sent by the client when a player adds someone to their friends list. * * @author Major */ diff --git a/src/org/apollo/game/event/impl/AddIgnoreEvent.java b/src/org/apollo/game/event/impl/AddIgnoreEvent.java index 61d2a303..fff53923 100644 --- a/src/org/apollo/game/event/impl/AddIgnoreEvent.java +++ b/src/org/apollo/game/event/impl/AddIgnoreEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An {@link Event} sent by the client when a player is ignored. + * An {@link Event} sent by the client when a player adds someone to their ignore list. * * @author Major */ diff --git a/src/org/apollo/game/event/impl/ButtonEvent.java b/src/org/apollo/game/event/impl/ButtonEvent.java index ed9035da..a52744be 100644 --- a/src/org/apollo/game/event/impl/ButtonEvent.java +++ b/src/org/apollo/game/event/impl/ButtonEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An event sent when a player clicks a button. + * An {@link Event} sent by the client when a player clicks a button. * * @author Graham */ diff --git a/src/org/apollo/game/event/impl/ChatEvent.java b/src/org/apollo/game/event/impl/ChatEvent.java index 8aa87fc6..f3565fd8 100644 --- a/src/org/apollo/game/event/impl/ChatEvent.java +++ b/src/org/apollo/game/event/impl/ChatEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An event sent by the client to send a public chat message to other players. + * An {@link Event} sent by the client to send a public chat message to other players. * * @author Graham */ diff --git a/src/org/apollo/game/event/impl/CloseInterfaceEvent.java b/src/org/apollo/game/event/impl/CloseInterfaceEvent.java index c248af40..db14f386 100644 --- a/src/org/apollo/game/event/impl/CloseInterfaceEvent.java +++ b/src/org/apollo/game/event/impl/CloseInterfaceEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An event which closes the open interface. + * An {@link Event} sent to the client that closes the open interface. * * @author Graham */ diff --git a/src/org/apollo/game/event/impl/ClosedInterfaceEvent.java b/src/org/apollo/game/event/impl/ClosedInterfaceEvent.java index ab1002fd..615845cf 100644 --- a/src/org/apollo/game/event/impl/ClosedInterfaceEvent.java +++ b/src/org/apollo/game/event/impl/ClosedInterfaceEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * Sent by the client when the current interface is closed. + * An {@link Event} sent by the client when the current interface is closed. * * @author Graham */ diff --git a/src/org/apollo/game/event/impl/CommandEvent.java b/src/org/apollo/game/event/impl/CommandEvent.java index cb693dbd..a0332197 100644 --- a/src/org/apollo/game/event/impl/CommandEvent.java +++ b/src/org/apollo/game/event/impl/CommandEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An event issued by the client to send a {@code ::} command. + * An {@link Event} sent by the client to send a {@code ::} command. * * @author Graham */ diff --git a/src/org/apollo/game/event/impl/ConfigEvent.java b/src/org/apollo/game/event/impl/ConfigEvent.java index 575666bc..dae8caf4 100644 --- a/src/org/apollo/game/event/impl/ConfigEvent.java +++ b/src/org/apollo/game/event/impl/ConfigEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An event sent to the client to adjust a certain config or attribute setting. + * An {@link Event} sent to the client to adjust a certain config or attribute setting. * * @author Chris Fletcher */ diff --git a/src/org/apollo/game/event/impl/DialogueContinueEvent.java b/src/org/apollo/game/event/impl/DialogueContinueEvent.java index c2bbdaeb..a1b10557 100644 --- a/src/org/apollo/game/event/impl/DialogueContinueEvent.java +++ b/src/org/apollo/game/event/impl/DialogueContinueEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An {@link Event} that is sent by the client when the player clicks "Click here to continue" button on a dialogue + * An {@link Event} sent by the client when the player clicks the "Click here to continue" button on a dialogue * interface. * * @author Chris Fletcher diff --git a/src/org/apollo/game/event/impl/DisplayTabInterfaceEvent.java b/src/org/apollo/game/event/impl/DisplayTabInterfaceEvent.java index 19ab6418..a4b284d8 100644 --- a/src/org/apollo/game/event/impl/DisplayTabInterfaceEvent.java +++ b/src/org/apollo/game/event/impl/DisplayTabInterfaceEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An event which is sent to the client to switch the currently displayed tab interface. + * An {@link Event} sent to the client to change the currently displayed tab interface. * * @author Chris Fletcher */ diff --git a/src/org/apollo/game/event/impl/EnterAmountEvent.java b/src/org/apollo/game/event/impl/EnterAmountEvent.java index 07726101..4c27584f 100644 --- a/src/org/apollo/game/event/impl/EnterAmountEvent.java +++ b/src/org/apollo/game/event/impl/EnterAmountEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An {@link Event} which is sent to the client to open up the enter amount interface. + * An {@link Event} sent to the client to open up the enter amount interface. * * @author Graham */ diff --git a/src/org/apollo/game/event/impl/EnteredAmountEvent.java b/src/org/apollo/game/event/impl/EnteredAmountEvent.java index 654aed24..74930dcc 100644 --- a/src/org/apollo/game/event/impl/EnteredAmountEvent.java +++ b/src/org/apollo/game/event/impl/EnteredAmountEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An event sent by the client when the player has entered an amount. + * An {@link Event} sent by the client when the player has entered an amount. * * @author Graham */ diff --git a/src/org/apollo/game/event/impl/FifthItemOptionEvent.java b/src/org/apollo/game/event/impl/FifthItemOptionEvent.java index 86f5c1ce..bc7e6251 100644 --- a/src/org/apollo/game/event/impl/FifthItemOptionEvent.java +++ b/src/org/apollo/game/event/impl/FifthItemOptionEvent.java @@ -1,7 +1,7 @@ package org.apollo.game.event.impl; /** - * The fifth {@link ItemOptionEvent}, used mainly for dropping items. + * The fifth {@link ItemOptionEvent}. * * @author Chris Fletcher */ diff --git a/src/org/apollo/game/event/impl/FirstItemOptionEvent.java b/src/org/apollo/game/event/impl/FirstItemOptionEvent.java index 218994cf..0af5e860 100644 --- a/src/org/apollo/game/event/impl/FirstItemOptionEvent.java +++ b/src/org/apollo/game/event/impl/FirstItemOptionEvent.java @@ -1,7 +1,7 @@ package org.apollo.game.event.impl; /** - * The first {@link ItemOptionEvent}, used for eating food or identifying herbs (amongst others). + * The first {@link ItemOptionEvent}. * * @author Chris Fletcher */ diff --git a/src/org/apollo/game/event/impl/FirstObjectActionEvent.java b/src/org/apollo/game/event/impl/FirstObjectActionEvent.java index e1bbe284..b51ddcaf 100644 --- a/src/org/apollo/game/event/impl/FirstObjectActionEvent.java +++ b/src/org/apollo/game/event/impl/FirstObjectActionEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.model.Position; /** - * An event sent when the first option at an object is used. + * The first {@link ObjectActionEvent}. * * @author Graham */ diff --git a/src/org/apollo/game/event/impl/FocusUpdateEvent.java b/src/org/apollo/game/event/impl/FocusUpdateEvent.java index e91b50a8..ad4605d8 100644 --- a/src/org/apollo/game/event/impl/FocusUpdateEvent.java +++ b/src/org/apollo/game/event/impl/FocusUpdateEvent.java @@ -3,14 +3,14 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * Represents a change in the client's focus (if it is the active window). + * An {@link Event} sent by the client to indicate a change in the client's focus (i.e. if it is the active window). * * @author Major */ -public class FocusUpdateEvent extends Event { +public final class FocusUpdateEvent extends Event { /** - * Dictates whether the client is focused or not. + * Indicates whether the client is focused or not. */ private final boolean focused; diff --git a/src/org/apollo/game/event/impl/ForwardPrivateMessageEvent.java b/src/org/apollo/game/event/impl/ForwardPrivateMessageEvent.java index 312157ec..332abe28 100644 --- a/src/org/apollo/game/event/impl/ForwardPrivateMessageEvent.java +++ b/src/org/apollo/game/event/impl/ForwardPrivateMessageEvent.java @@ -4,7 +4,7 @@ import org.apollo.game.event.Event; import org.apollo.game.model.settings.PrivilegeLevel; /** - * An {@link Event} that forwards a private message to a client. + * An {@link Event} sent to the client that forwards a private message. * * @author Major */ diff --git a/src/org/apollo/game/event/impl/FriendServerStatusEvent.java b/src/org/apollo/game/event/impl/FriendServerStatusEvent.java index 8bf12a32..2b86d853 100644 --- a/src/org/apollo/game/event/impl/FriendServerStatusEvent.java +++ b/src/org/apollo/game/event/impl/FriendServerStatusEvent.java @@ -4,7 +4,7 @@ import org.apollo.game.event.Event; import org.apollo.game.model.settings.ServerStatus; /** - * An {@link Event} sent by the server to update the friend server status. + * An {@link Event} sent to the client to update the friend server status. * * @author Major */ diff --git a/src/org/apollo/game/event/impl/IdAssignmentEvent.java b/src/org/apollo/game/event/impl/IdAssignmentEvent.java index ea2be256..becbc728 100644 --- a/src/org/apollo/game/event/impl/IdAssignmentEvent.java +++ b/src/org/apollo/game/event/impl/IdAssignmentEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An event which specifies the local id and membership status of the current player. + * An {@link Event} sent to the client that specifies the local id and membership status of the current player. * * @author Graham */ diff --git a/src/org/apollo/game/event/impl/IgnoreListEvent.java b/src/org/apollo/game/event/impl/IgnoreListEvent.java index 6cb56455..58e69a22 100644 --- a/src/org/apollo/game/event/impl/IgnoreListEvent.java +++ b/src/org/apollo/game/event/impl/IgnoreListEvent.java @@ -5,7 +5,7 @@ import java.util.List; import org.apollo.game.event.Event; /** - * An {@link Event} which is sent to the client that updates the ignored user list. + * An {@link Event} sent to the client that updates the ignored user list. * * @author Major */ diff --git a/src/org/apollo/game/event/impl/InventoryItemEvent.java b/src/org/apollo/game/event/impl/InventoryItemEvent.java index 285ca54b..b3830027 100644 --- a/src/org/apollo/game/event/impl/InventoryItemEvent.java +++ b/src/org/apollo/game/event/impl/InventoryItemEvent.java @@ -3,8 +3,8 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An {@link Event} which represents some sort of action on an item in an inventory. Note that this is the parent of - * both the item option and action event classes, and so cannot be used to determine when one of those events is fired. + * An {@link Event} that represents some sort of action on an item in an inventory. Note that this is the parent of both + * item option and item action event, and so cannot be used to determine when one of those events is fired. * * @author Chris Fletcher */ diff --git a/src/org/apollo/game/event/impl/ItemActionEvent.java b/src/org/apollo/game/event/impl/ItemActionEvent.java index edc4b49b..7b2f9105 100644 --- a/src/org/apollo/game/event/impl/ItemActionEvent.java +++ b/src/org/apollo/game/event/impl/ItemActionEvent.java @@ -3,7 +3,9 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An {@link Event} which represents some sort of action on an item. + * An {@link Event} sent by the client that represents some sort of action on an item. Note that the actual event sent + * by the client is one of the five item action events, but this is the event that should be intercepted (and the option + * verified). * * @author Chris Fletcher */ diff --git a/src/org/apollo/game/event/impl/ItemOnItemEvent.java b/src/org/apollo/game/event/impl/ItemOnItemEvent.java index bd6c1c95..40c2c912 100644 --- a/src/org/apollo/game/event/impl/ItemOnItemEvent.java +++ b/src/org/apollo/game/event/impl/ItemOnItemEvent.java @@ -1,7 +1,7 @@ package org.apollo.game.event.impl; /** - * An event which is sent by the client when a player uses one inventory item on another. + * An {@link Event} sent by the client when a player uses one inventory item on another. * * @author Chris Fletcher */ diff --git a/src/org/apollo/game/event/impl/ItemOptionEvent.java b/src/org/apollo/game/event/impl/ItemOptionEvent.java index 8bdc1503..44f5d5c7 100644 --- a/src/org/apollo/game/event/impl/ItemOptionEvent.java +++ b/src/org/apollo/game/event/impl/ItemOptionEvent.java @@ -1,8 +1,9 @@ package org.apollo.game.event.impl; /** - * An {@link InventoryItemEvent} which is sent by the client when an item's option is clicked (e.g. equip, eat, drink, - * etc). + * An {@link InventoryItemEvent} sent by the client when an item's option is clicked (e.g. equip, eat, drink, etc). Note + * that the actual event sent by the client is one of the five item option events, but this is the event that should be + * intercepted (and the option verified). * * @author Chris Fletcher */ diff --git a/src/org/apollo/game/event/impl/KeepAliveEvent.java b/src/org/apollo/game/event/impl/KeepAliveEvent.java index c01370c8..0876eb68 100644 --- a/src/org/apollo/game/event/impl/KeepAliveEvent.java +++ b/src/org/apollo/game/event/impl/KeepAliveEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An event which is periodically sent by the client to keep a connection alive. + * An {@link Event} periodically sent by the client to keep a connection alive. * * @author Graham */ diff --git a/src/org/apollo/game/event/impl/LogoutEvent.java b/src/org/apollo/game/event/impl/LogoutEvent.java index 26e90dd0..4524f359 100644 --- a/src/org/apollo/game/event/impl/LogoutEvent.java +++ b/src/org/apollo/game/event/impl/LogoutEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An event sent to the client which logs it out cleanly. + * An {@link Event} sent to the client that cleanly logs it out. * * @author Graham */ diff --git a/src/org/apollo/game/event/impl/MagicOnItemEvent.java b/src/org/apollo/game/event/impl/MagicOnItemEvent.java index ae1d86d0..f6996972 100644 --- a/src/org/apollo/game/event/impl/MagicOnItemEvent.java +++ b/src/org/apollo/game/event/impl/MagicOnItemEvent.java @@ -1,7 +1,7 @@ package org.apollo.game.event.impl; /** - * An event sent by the client when a player casts a spell on an inventory item. + * An {@link Event} sent by the client when a player casts a spell on an inventory item. * * @author Chris Fletcher */ diff --git a/src/org/apollo/game/event/impl/MobAnimationResetEvent.java b/src/org/apollo/game/event/impl/MobAnimationResetEvent.java index 76575e38..2a6a1bce 100644 --- a/src/org/apollo/game/event/impl/MobAnimationResetEvent.java +++ b/src/org/apollo/game/event/impl/MobAnimationResetEvent.java @@ -3,10 +3,10 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An outgoing event sent to reset the animations of every mob. + * An {@link Event} sent to the client to reset the animations of every mob. * * @author Major */ -public class MobAnimationResetEvent extends Event { +public final class MobAnimationResetEvent extends Event { } \ No newline at end of file diff --git a/src/org/apollo/game/event/impl/MouseClickEvent.java b/src/org/apollo/game/event/impl/MouseClickEvent.java index 7b54d543..a034b634 100644 --- a/src/org/apollo/game/event/impl/MouseClickEvent.java +++ b/src/org/apollo/game/event/impl/MouseClickEvent.java @@ -3,11 +3,11 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An {@link Event} sent when the player clicks with their mouse (or mousekeys etc). + * An {@link Event} sent by the client when the player clicks with their mouse (or mousekeys etc). * * @author Major */ -public class MouseClickEvent extends Event { +public final class MouseClickEvent extends Event { /** * The number of clicks on this point (i.e. the point ({@link #x}, {@link #y})). diff --git a/src/org/apollo/game/event/impl/NpcActionEvent.java b/src/org/apollo/game/event/impl/NpcActionEvent.java index 1fcd3dd0..1d3fdda4 100644 --- a/src/org/apollo/game/event/impl/NpcActionEvent.java +++ b/src/org/apollo/game/event/impl/NpcActionEvent.java @@ -3,16 +3,18 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An {@link Event} representing the clicking of an npc menu action. + * An {@link Event} sent by the client representing the clicking of an npc menu action. Note that the actual event sent + * by the client is one of the three npc action events, but this is the event that should be intercepted (and the option + * verified). * * @author Major */ public abstract class NpcActionEvent extends Event { /** - * The action number . + * The option number . */ - private final int action; + private final int option; /** * The npc index. @@ -22,21 +24,21 @@ public abstract class NpcActionEvent extends Event { /** * Creates a new npc action event. * - * @param action The action number. + * @param option The option number. * @param index The index of the npc. */ - public NpcActionEvent(int action, int index) { - this.action = action; + public NpcActionEvent(int option, int index) { + this.option = option; this.index = index; } /** - * Gets the menu action number clicked. + * Gets the menu action number (i.e. the action event 'option') clicked. * - * @return The action number. + * @return The option number. */ - public int getAction() { - return action; + public int getOption() { + return option; } /** diff --git a/src/org/apollo/game/event/impl/NpcSynchronizationEvent.java b/src/org/apollo/game/event/impl/NpcSynchronizationEvent.java index 6fa255db..f8a77fbb 100644 --- a/src/org/apollo/game/event/impl/NpcSynchronizationEvent.java +++ b/src/org/apollo/game/event/impl/NpcSynchronizationEvent.java @@ -8,11 +8,11 @@ import org.apollo.game.model.Position; import org.apollo.game.sync.seg.SynchronizationSegment; /** - * An event which is sent to synchronize npcs with players. + * An {@link Event} sent to the client to synchronize npcs with players. * * @author Major */ -public class NpcSynchronizationEvent extends Event { +public final class NpcSynchronizationEvent extends Event { /** * The amount of local npcs. diff --git a/src/org/apollo/game/event/impl/ObjectActionEvent.java b/src/org/apollo/game/event/impl/ObjectActionEvent.java index 3c2e9ba7..c4de0482 100644 --- a/src/org/apollo/game/event/impl/ObjectActionEvent.java +++ b/src/org/apollo/game/event/impl/ObjectActionEvent.java @@ -4,7 +4,9 @@ import org.apollo.game.event.Event; import org.apollo.game.model.Position; /** - * An {@link Event} which represents some sort of action at an object. + * An {@link Event} sent by the client that represents some sort of action on an object. Note that the actual event sent + * by the client is one of the five object action events, but this is the event that should be intercepted (and the + * option verified). * * @author Graham */ diff --git a/src/org/apollo/game/event/impl/OpenDialogueInterfaceEvent.java b/src/org/apollo/game/event/impl/OpenDialogueInterfaceEvent.java index ff45b2f5..7cf87c24 100644 --- a/src/org/apollo/game/event/impl/OpenDialogueInterfaceEvent.java +++ b/src/org/apollo/game/event/impl/OpenDialogueInterfaceEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An {@link Event} that opens a dialogue interface (an interface that appears in the chat box). + * An {@link Event} sent to the client that opens a dialogue interface (an interface that appears in the chat box). * * @author Chris Fletcher */ diff --git a/src/org/apollo/game/event/impl/OpenInterfaceEvent.java b/src/org/apollo/game/event/impl/OpenInterfaceEvent.java index 943d3846..368b958b 100644 --- a/src/org/apollo/game/event/impl/OpenInterfaceEvent.java +++ b/src/org/apollo/game/event/impl/OpenInterfaceEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An {@link Event} that opens an interface. + * An {@link Event} sent to the client that opens an interface. * * @author Graham */ diff --git a/src/org/apollo/game/event/impl/OpenInterfaceSidebarEvent.java b/src/org/apollo/game/event/impl/OpenInterfaceSidebarEvent.java index 2c62263d..b7990691 100644 --- a/src/org/apollo/game/event/impl/OpenInterfaceSidebarEvent.java +++ b/src/org/apollo/game/event/impl/OpenInterfaceSidebarEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An {@link Event} sent to open an interface and temporary sidebar overlay. + * An {@link Event} sent to the client to open an interface and temporary sidebar overlay. * * @author Graham */ diff --git a/src/org/apollo/game/event/impl/PlayerDesignEvent.java b/src/org/apollo/game/event/impl/PlayerDesignEvent.java index 29126ebd..a8396703 100644 --- a/src/org/apollo/game/event/impl/PlayerDesignEvent.java +++ b/src/org/apollo/game/event/impl/PlayerDesignEvent.java @@ -4,7 +4,7 @@ import org.apollo.game.event.Event; import org.apollo.game.model.Appearance; /** - * An event sent by the client when the player modifies their design. + * An {@link Event} sent by the client when the player modifies their design. * * @author Graham */ diff --git a/src/org/apollo/game/event/impl/PlayerSynchronizationEvent.java b/src/org/apollo/game/event/impl/PlayerSynchronizationEvent.java index a4e54827..c69d3f3b 100644 --- a/src/org/apollo/game/event/impl/PlayerSynchronizationEvent.java +++ b/src/org/apollo/game/event/impl/PlayerSynchronizationEvent.java @@ -7,7 +7,7 @@ import org.apollo.game.model.Position; import org.apollo.game.sync.seg.SynchronizationSegment; /** - * An event which is sent to synchronize the players. + * An {@link Event} sent to the client to synchronize players. * * @author Graham */ diff --git a/src/org/apollo/game/event/impl/PositionEvent.java b/src/org/apollo/game/event/impl/PositionEvent.java index ceb932b4..b059e1b0 100644 --- a/src/org/apollo/game/event/impl/PositionEvent.java +++ b/src/org/apollo/game/event/impl/PositionEvent.java @@ -4,8 +4,7 @@ import org.apollo.game.event.Event; import org.apollo.game.model.Position; /** - * An {@link Event} which tells the client to focus on a specific {@link Position} (on which an action should be - * performed). + * An {@link Event} sent to the client to focus on a specific {@link Position} (on which an action should be performed). * * @author Chris Fletcher */ diff --git a/src/org/apollo/game/event/impl/PrivacyOptionEvent.java b/src/org/apollo/game/event/impl/PrivacyOptionEvent.java index 250865dd..7fa2198e 100644 --- a/src/org/apollo/game/event/impl/PrivacyOptionEvent.java +++ b/src/org/apollo/game/event/impl/PrivacyOptionEvent.java @@ -4,7 +4,8 @@ import org.apollo.game.event.Event; import org.apollo.game.model.settings.PrivacyState; /** - * An {@link Event} sent by the client or server to update the chat and trade privacy state. + * An {@link Event} sent both by and to the client to update the public chat, private (friend) chat, and trade chat + * privacy state. * * @author Kyle Stevenson * @author Major diff --git a/src/org/apollo/game/event/impl/RegionChangeEvent.java b/src/org/apollo/game/event/impl/RegionChangeEvent.java index 94755b0a..ab818a1a 100644 --- a/src/org/apollo/game/event/impl/RegionChangeEvent.java +++ b/src/org/apollo/game/event/impl/RegionChangeEvent.java @@ -4,7 +4,7 @@ import org.apollo.game.event.Event; import org.apollo.game.model.Position; /** - * An event which indicates that the client should load the specified region. + * An {@link Event sent to the client instructing it to load the specified region. * * @author Graham */ diff --git a/src/org/apollo/game/event/impl/RemoveFriendEvent.java b/src/org/apollo/game/event/impl/RemoveFriendEvent.java index 07061f2f..7008c0c9 100644 --- a/src/org/apollo/game/event/impl/RemoveFriendEvent.java +++ b/src/org/apollo/game/event/impl/RemoveFriendEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An {@link Event} sent by the client when a player is removed from a friends list. + * An {@link Event} sent by the client when a player removes someone from their friends list. * * @author Major */ diff --git a/src/org/apollo/game/event/impl/RemoveIgnoreEvent.java b/src/org/apollo/game/event/impl/RemoveIgnoreEvent.java index cb9ae680..a5316fe0 100644 --- a/src/org/apollo/game/event/impl/RemoveIgnoreEvent.java +++ b/src/org/apollo/game/event/impl/RemoveIgnoreEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An {@link Event} sent by the client when a player is removed from a ignore list. + * An {@link Event} sent by the client when a player removes someone from their ignore list. * * @author Major */ diff --git a/src/org/apollo/game/event/impl/RemoveTileItemEvent.java b/src/org/apollo/game/event/impl/RemoveTileItemEvent.java index 0966689a..82a8a1d5 100644 --- a/src/org/apollo/game/event/impl/RemoveTileItemEvent.java +++ b/src/org/apollo/game/event/impl/RemoveTileItemEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An {@link Event} sent to the client to instruct it to remove an item from a tile. + * An {@link Event} sent to the client to remove an item from a tile. * * @author Major */ diff --git a/src/org/apollo/game/event/impl/SecondItemOptionEvent.java b/src/org/apollo/game/event/impl/SecondItemOptionEvent.java index c713e093..db4c6e22 100644 --- a/src/org/apollo/game/event/impl/SecondItemOptionEvent.java +++ b/src/org/apollo/game/event/impl/SecondItemOptionEvent.java @@ -1,7 +1,7 @@ package org.apollo.game.event.impl; /** - * The second {@link ItemOptionEvent}, used for equipping an item (amongst others?). + * The second {@link ItemOptionEvent}. * * @author Chris Fletcher */ diff --git a/src/org/apollo/game/event/impl/SecondObjectActionEvent.java b/src/org/apollo/game/event/impl/SecondObjectActionEvent.java index 1c46ba53..85444d9c 100644 --- a/src/org/apollo/game/event/impl/SecondObjectActionEvent.java +++ b/src/org/apollo/game/event/impl/SecondObjectActionEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.model.Position; /** - * An event sent when the second option at an object is used. + * The second {@link ObjectActionEvent}. * * @author Graham */ diff --git a/src/org/apollo/game/event/impl/ServerMessageEvent.java b/src/org/apollo/game/event/impl/ServerMessageEvent.java index 9a5a16ae..544eb3eb 100644 --- a/src/org/apollo/game/event/impl/ServerMessageEvent.java +++ b/src/org/apollo/game/event/impl/ServerMessageEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An event which is sent to the client with a server-side message. + * An {@link Event} sent to the client to display a server message. * * @author Graham */ diff --git a/src/org/apollo/game/event/impl/SetWidgetItemModelEvent.java b/src/org/apollo/game/event/impl/SetWidgetItemModelEvent.java index b3f4f619..1cff80c9 100644 --- a/src/org/apollo/game/event/impl/SetWidgetItemModelEvent.java +++ b/src/org/apollo/game/event/impl/SetWidgetItemModelEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An event sent to the client to change an interface's item model. + * An {@link Event} sent to the client to set a widget's displayed item model. * * @author Chris Fletcher */ diff --git a/src/org/apollo/game/event/impl/SetWidgetModelAnimationEvent.java b/src/org/apollo/game/event/impl/SetWidgetModelAnimationEvent.java index 35b9e2ba..de6e1a7c 100644 --- a/src/org/apollo/game/event/impl/SetWidgetModelAnimationEvent.java +++ b/src/org/apollo/game/event/impl/SetWidgetModelAnimationEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An event which is sent to the client to make a mob model on an interface play a certain animation. + * An {@link Event} sent to the client to set a widget's displayed mob's animation. * * @author Chris Fletcher */ diff --git a/src/org/apollo/game/event/impl/SetWidgetNpcModelEvent.java b/src/org/apollo/game/event/impl/SetWidgetNpcModelEvent.java index f485a55f..0b36069f 100644 --- a/src/org/apollo/game/event/impl/SetWidgetNpcModelEvent.java +++ b/src/org/apollo/game/event/impl/SetWidgetNpcModelEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An event sent to the client to change an interface's NPC model. + * An {@link Event} sent to the client to set a widget's displayed npc model. * * @author Chris Fletcher */ diff --git a/src/org/apollo/game/event/impl/SetWidgetPlayerModelEvent.java b/src/org/apollo/game/event/impl/SetWidgetPlayerModelEvent.java index 7fc86871..4d12a771 100644 --- a/src/org/apollo/game/event/impl/SetWidgetPlayerModelEvent.java +++ b/src/org/apollo/game/event/impl/SetWidgetPlayerModelEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An event sent to the client to set an interface's player model. + * An {@link Event} sent to the client to set a widget's displayed player model. * * @author Chris Fletcher */ diff --git a/src/org/apollo/game/event/impl/SetWidgetTextEvent.java b/src/org/apollo/game/event/impl/SetWidgetTextEvent.java index 8f7d13e6..33f5027c 100644 --- a/src/org/apollo/game/event/impl/SetWidgetTextEvent.java +++ b/src/org/apollo/game/event/impl/SetWidgetTextEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An event sent to the client to update an interface's text. + * An {@link Event} sent to the client to set a widget's text. * * @author Graham */ diff --git a/src/org/apollo/game/event/impl/SetWidgetVisibilityEvent.java b/src/org/apollo/game/event/impl/SetWidgetVisibilityEvent.java index f1589c63..8889a9f7 100644 --- a/src/org/apollo/game/event/impl/SetWidgetVisibilityEvent.java +++ b/src/org/apollo/game/event/impl/SetWidgetVisibilityEvent.java @@ -3,8 +3,8 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An event which changes the state of a hidden interface component (i.e./e.g. the special attack bar on the weapon - * tab). + * An {@link Event} sent to the client that changes the state of a hidden widget component (e.g. the special attack bar + * on the weapon tab). * * @author Chris Fletcher */ diff --git a/src/org/apollo/game/event/impl/SpamPacketEvent.java b/src/org/apollo/game/event/impl/SpamPacketEvent.java index 402be7d9..84e1cdd7 100644 --- a/src/org/apollo/game/event/impl/SpamPacketEvent.java +++ b/src/org/apollo/game/event/impl/SpamPacketEvent.java @@ -3,11 +3,11 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * A message sent after a short period of time containing random data. + * A {@link Event} sent by the client after a short period of time containing random data. * * @author Major */ -public class SpamPacketEvent extends Event { +public final class SpamPacketEvent extends Event { /** * Data sent by the spam packet. diff --git a/src/org/apollo/game/event/impl/SwitchItemEvent.java b/src/org/apollo/game/event/impl/SwitchItemEvent.java index 46cb9db6..7b8d991e 100644 --- a/src/org/apollo/game/event/impl/SwitchItemEvent.java +++ b/src/org/apollo/game/event/impl/SwitchItemEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An event sent by the client when two items are switched. + * An {@link Event} sent by the client when two items are switched. * * @author Graham */ diff --git a/src/org/apollo/game/event/impl/SwitchTabInterfaceEvent.java b/src/org/apollo/game/event/impl/SwitchTabInterfaceEvent.java index 5e8cf871..9801a5e7 100644 --- a/src/org/apollo/game/event/impl/SwitchTabInterfaceEvent.java +++ b/src/org/apollo/game/event/impl/SwitchTabInterfaceEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.event.Event; /** - * An event sent to the client to change the interface of a tab. + * An {@link Event} sent to the client to change the interface of a tab. * * @author Graham */ diff --git a/src/org/apollo/game/event/impl/TakeTileItemEvent.java b/src/org/apollo/game/event/impl/TakeTileItemEvent.java index 9b7a6e09..7643e13d 100644 --- a/src/org/apollo/game/event/impl/TakeTileItemEvent.java +++ b/src/org/apollo/game/event/impl/TakeTileItemEvent.java @@ -4,7 +4,7 @@ import org.apollo.game.event.Event; import org.apollo.game.model.Position; /** - * An {@link Event} sent by the client indicating a request to pick up an item on a tile. + * An {@link Event} sent by the client to pick up an item on a tile. * * @author Major */ diff --git a/src/org/apollo/game/event/impl/ThirdObjectActionEvent.java b/src/org/apollo/game/event/impl/ThirdObjectActionEvent.java index 91a01177..c759aa50 100644 --- a/src/org/apollo/game/event/impl/ThirdObjectActionEvent.java +++ b/src/org/apollo/game/event/impl/ThirdObjectActionEvent.java @@ -3,7 +3,7 @@ package org.apollo.game.event.impl; import org.apollo.game.model.Position; /** - * An event sent when the third option at an object is used. + * The third {@link ObjectActionEvent}. * * @author Graham */ diff --git a/src/org/apollo/game/event/impl/UpdateItemsEvent.java b/src/org/apollo/game/event/impl/UpdateItemsEvent.java index 5124bfe2..fe18b877 100644 --- a/src/org/apollo/game/event/impl/UpdateItemsEvent.java +++ b/src/org/apollo/game/event/impl/UpdateItemsEvent.java @@ -4,7 +4,7 @@ import org.apollo.game.event.Event; import org.apollo.game.model.Item; /** - * An event which updates all the items in an interface. + * An {@link Event} sent to the client that updates all the items in an interface. * * @author Graham */ diff --git a/src/org/apollo/game/event/impl/UpdateRunEnergyEvent.java b/src/org/apollo/game/event/impl/UpdateRunEnergyEvent.java index 0097378e..ea5187e2 100644 --- a/src/org/apollo/game/event/impl/UpdateRunEnergyEvent.java +++ b/src/org/apollo/game/event/impl/UpdateRunEnergyEvent.java @@ -7,7 +7,7 @@ import org.apollo.game.event.Event; * * @author Major */ -public class UpdateRunEnergyEvent extends Event { +public final class UpdateRunEnergyEvent extends Event { /** * The run energy. diff --git a/src/org/apollo/game/event/impl/UpdateSlottedItemsEvent.java b/src/org/apollo/game/event/impl/UpdateSlottedItemsEvent.java index 917ac348..f0202460 100644 --- a/src/org/apollo/game/event/impl/UpdateSlottedItemsEvent.java +++ b/src/org/apollo/game/event/impl/UpdateSlottedItemsEvent.java @@ -4,7 +4,7 @@ import org.apollo.game.event.Event; import org.apollo.game.model.SlottedItem; /** - * An event which updates a single item in an interface. + * An {@link Event} sent to the client that updates a single item in an interface. * * @author Graham */ diff --git a/src/org/apollo/game/event/impl/UpdateTileItemEvent.java b/src/org/apollo/game/event/impl/UpdateTileItemEvent.java index 086569d9..574a9103 100644 --- a/src/org/apollo/game/event/impl/UpdateTileItemEvent.java +++ b/src/org/apollo/game/event/impl/UpdateTileItemEvent.java @@ -4,7 +4,7 @@ import org.apollo.game.event.Event; import org.apollo.game.model.Item; /** - * An {@link Event} sent to tell the client to update the amount of an item display on a tile. + * An {@link Event} sent to the client to update the amount of an item display on a tile. * * @author Major */ diff --git a/src/org/apollo/game/event/impl/WalkEvent.java b/src/org/apollo/game/event/impl/WalkEvent.java index 55ce6a9f..1055d2b6 100644 --- a/src/org/apollo/game/event/impl/WalkEvent.java +++ b/src/org/apollo/game/event/impl/WalkEvent.java @@ -4,7 +4,7 @@ import org.apollo.game.event.Event; import org.apollo.game.model.Position; /** - * An event which the client sends to request that the player walks somewhere. + * An {@link Event} sent by the client to request that the player walks somewhere. * * @author Graham */