Standardise comments in Event implementations.

This commit is contained in:
Major-
2014-02-16 17:47:22 +00:00
parent 57f08d8bfc
commit 5c0a11dab0
62 changed files with 88 additions and 81 deletions
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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;
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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 {
}
@@ -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})).
@@ -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;
}
/**
@@ -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.
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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.
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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
*/
@@ -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.
@@ -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
*/
@@ -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
*/
@@ -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
*/