From 6bffd5c0a1c388b81763f63f0ab5b4e9a0604d5d Mon Sep 17 00:00:00 2001 From: Steve Date: Sun, 5 Apr 2015 20:18:58 -0400 Subject: [PATCH 01/18] Fix grouped region updating. Will need to account for re-adding StaticObjects after they have been removed from the game world. Also commented out some broken functionality in bootstrap involving first/second/third/etc message handlers. Should revisit with fix. --- data/plugins/bootstrap.rb | 19 ++++++++-------- data/plugins/navigation/door/door.rb | 7 +++--- data/plugins/navigation/door/util.rb | 4 ++-- .../impl/GroupedRegionUpdateMessage.java | 18 +++++++-------- .../task/PrePlayerSynchronizationTask.java | 22 +++++++------------ .../GroupedRegionUpdateMessageEncoder.java | 8 +++---- .../GroupedRegionUpdateMessageEncoder.java | 2 +- 7 files changed, 38 insertions(+), 42 deletions(-) diff --git a/data/plugins/bootstrap.rb b/data/plugins/bootstrap.rb index 89e520c7..c2704f12 100644 --- a/data/plugins/bootstrap.rb +++ b/data/plugins/bootstrap.rb @@ -177,15 +177,16 @@ def on_message(args, proc) numbers = [ 'first', 'second', 'third', 'fourth', 'fifth' ] message = args[0]; option = 0 - numbers.each_index do |index| - number = numbers[index] - - if message.to_s.start_with?(number) - option = index + 1 - message = message[number.length + 1, message.length].to_sym - break - end - end + # TODO + # numbers.each_index do |index| + # number = numbers[index] + # + # if message.to_s.start_with?(number) + # option = index + 1 + # message = message[number.length + 1, message.length].to_sym + # break + # end + # end class_name = message.to_s.camelize.concat('Message') diff --git a/data/plugins/navigation/door/door.rb b/data/plugins/navigation/door/door.rb index 3bb5f564..81d96f52 100644 --- a/data/plugins/navigation/door/door.rb +++ b/data/plugins/navigation/door/door.rb @@ -13,12 +13,12 @@ class OpenDoorAction < DistancedAction def executeAction mob.turn_to(@door.position) - DoorUtil::toggle(@door, mob) + DoorUtil::toggle(@door) stop end def equals(other) - return (get_class == other.get_class && @door_object == other.door_object) + return (get_class == other.get_class && @door == other.door) end end @@ -28,6 +28,7 @@ on :message, :first_object_action do |player, message| if DoorUtil::is_door?(message.id) puts "Player: #{player.position}, door: #{message.position}" door = DoorUtil::get_door_object(message.position, message.id) - player.start_action(OpenDoorAction.new(player, door)) unless door.nil? + DoorUtil::toggle(door) unless door.nil? + # player.start_action(OpenDoorAction.new(player, door)) unless door.nil? end end \ No newline at end of file diff --git a/data/plugins/navigation/door/util.rb b/data/plugins/navigation/door/util.rb index 31b23e1e..16d16e06 100644 --- a/data/plugins/navigation/door/util.rb +++ b/data/plugins/navigation/door/util.rb @@ -46,7 +46,7 @@ module DoorUtil end # Toggles the given door. - def self.toggle(door, player) + def self.toggle(door) position = door.position region = $world.region_repository.from_position(position) region.remove_entity(door) @@ -59,7 +59,7 @@ module DoorUtil else toggled_position = translate_door_position(door) toggled_orientation = translate_door_orientation(door) - toggled_door = DynamicGameObject.createPublic(door.id, toggled_position, door.type, toggled_orientation) + toggled_door = DynamicGameObject.createPublic($world, door.id, toggled_position, door.type, toggled_orientation) toggled_region = $world.region_repository.from_position(toggled_position) toggled_region.add_entity(toggled_door) diff --git a/src/org/apollo/game/message/impl/GroupedRegionUpdateMessage.java b/src/org/apollo/game/message/impl/GroupedRegionUpdateMessage.java index a605c9ac..3dc299ee 100644 --- a/src/org/apollo/game/message/impl/GroupedRegionUpdateMessage.java +++ b/src/org/apollo/game/message/impl/GroupedRegionUpdateMessage.java @@ -1,11 +1,11 @@ package org.apollo.game.message.impl; -import java.util.List; - import org.apollo.game.message.Message; import org.apollo.game.model.Position; import org.apollo.game.model.area.RegionCoordinates; +import java.util.List; + /** * A {@link Message} sent to the client that contains multiple * @@ -14,9 +14,9 @@ import org.apollo.game.model.area.RegionCoordinates; public final class GroupedRegionUpdateMessage extends Message { /** - * The Position of the Player. + * The last known region Position of the Player. */ - private final Position player; + private final Position lastKnownRegion; /** * The Position of the Region being updated. @@ -31,12 +31,12 @@ public final class GroupedRegionUpdateMessage extends Message { /** * Creates the GroupedRegionUpdateMessage. * - * @param player The {@link Position} of the Player. + * @param lastKnownRegion The last known region {@link Position} of the Player. * @param coordinates The {@link RegionCoordinates} of the Region being updated. * @param messages The {@link List} of {@link RegionUpdateMessage}s. */ - public GroupedRegionUpdateMessage(Position player, RegionCoordinates coordinates, List messages) { - this.player = player; + public GroupedRegionUpdateMessage(Position lastKnownRegion, RegionCoordinates coordinates, List messages) { + this.lastKnownRegion = lastKnownRegion; this.region = new Position(coordinates.getAbsoluteX(), coordinates.getAbsoluteY()); this.messages = messages; } @@ -46,8 +46,8 @@ public final class GroupedRegionUpdateMessage extends Message { * * @return The Position. */ - public Position getPlayerPosition() { - return player; + public Position getLastKnownRegion() { + return lastKnownRegion; } /** diff --git a/src/org/apollo/game/sync/task/PrePlayerSynchronizationTask.java b/src/org/apollo/game/sync/task/PrePlayerSynchronizationTask.java index c93050d2..3a1a6074 100644 --- a/src/org/apollo/game/sync/task/PrePlayerSynchronizationTask.java +++ b/src/org/apollo/game/sync/task/PrePlayerSynchronizationTask.java @@ -1,12 +1,6 @@ package org.apollo.game.sync.task; -import java.util.ArrayList; -import java.util.HashSet; -import java.util.List; -import java.util.Map; -import java.util.Optional; -import java.util.Set; - +import com.google.common.collect.ImmutableSet; import org.apollo.game.message.impl.ClearRegionMessage; import org.apollo.game.message.impl.GroupedRegionUpdateMessage; import org.apollo.game.message.impl.RegionChangeMessage; @@ -17,7 +11,7 @@ import org.apollo.game.model.area.RegionCoordinates; import org.apollo.game.model.area.RegionRepository; import org.apollo.game.model.entity.Player; -import com.google.common.collect.ImmutableSet; +import java.util.*; /** * A {@link SynchronizationTask} which does pre-synchronization work for the specified {@link Player}. @@ -181,7 +175,7 @@ public final class PrePlayerSynchronizationTask extends SynchronizationTask { player.send(new ClearRegionMessage(position, coordinates)); } - Optional message = toUpdateMessage(local, position, coordinates, repository); + Optional message = toUpdateMessage(local, player.getLastKnownRegion(), coordinates, repository); if (message.isPresent()) { messages.add(message.get()); } @@ -216,12 +210,12 @@ public final class PrePlayerSynchronizationTask extends SynchronizationTask { * {@link Optional#empty()} if no update message is required. * * @param mode The RegionUpdateMode for the Message. - * @param position The {@link Position} of the Player. + * @param lastKnownRegion The last known region {@link Position} of the Player. * @param coordinates The {@link RegionCoordinates} of the {@link Region}. * @param repository The {@link RegionRepository} containing the Regions. * @return The Optional containing the GroupedRegionUpdateMessage. */ - private Optional toUpdateMessage(RegionUpdateMode mode, Position position, RegionCoordinates coordinates, RegionRepository repository) { + private Optional toUpdateMessage(RegionUpdateMode mode, Position lastKnownRegion, RegionCoordinates coordinates, RegionRepository repository) { List messages; /* @@ -237,7 +231,7 @@ public final class PrePlayerSynchronizationTask extends SynchronizationTask { messages = updates.get(coordinates); if (messages == null) { synchronized (updates) { - messages = updates.computeIfAbsent(coordinates, coords -> repository.get(coords).getUpdates(position.getHeight())); + messages = updates.computeIfAbsent(coordinates, coords -> repository.get(coords).getUpdates(lastKnownRegion.getHeight())); } } @@ -246,7 +240,7 @@ public final class PrePlayerSynchronizationTask extends SynchronizationTask { messages = snapshots.get(coordinates); if (messages == null) { synchronized (snapshots) { - messages = snapshots.computeIfAbsent(coordinates, coords -> repository.get(coords).getSnapshot(position.getHeight())); + messages = snapshots.computeIfAbsent(coordinates, coords -> repository.get(coords).getSnapshot(lastKnownRegion.getHeight())); } } @@ -255,7 +249,7 @@ public final class PrePlayerSynchronizationTask extends SynchronizationTask { throw new IllegalArgumentException("Unrecognised RegionUpdateMode " + mode + "."); } - return messages.isEmpty() ? Optional.empty() : Optional.of(new GroupedRegionUpdateMessage(position, coordinates, messages)); + return messages.isEmpty() ? Optional.empty() : Optional.of(new GroupedRegionUpdateMessage(lastKnownRegion, coordinates, messages)); } } \ No newline at end of file diff --git a/src/org/apollo/net/release/r317/GroupedRegionUpdateMessageEncoder.java b/src/org/apollo/net/release/r317/GroupedRegionUpdateMessageEncoder.java index 289134c8..bfdbc008 100644 --- a/src/org/apollo/net/release/r317/GroupedRegionUpdateMessageEncoder.java +++ b/src/org/apollo/net/release/r317/GroupedRegionUpdateMessageEncoder.java @@ -35,11 +35,11 @@ public final class GroupedRegionUpdateMessageEncoder extends MessageEncoder Date: Tue, 7 Apr 2015 18:57:55 -0400 Subject: [PATCH 02/18] Update Netty. http://netty.io/news/2015/04/02/4-0-27-Final.html --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 6a6543b4..4d5eeb1c 100644 --- a/pom.xml +++ b/pom.xml @@ -58,7 +58,7 @@ io.netty netty-all - 4.0.26.Final + 4.0.27.Final compile From 6ada19fdc470b708991821dee83d500cb0fd9f99 Mon Sep 17 00:00:00 2001 From: atomicint Date: Tue, 7 Apr 2015 18:58:58 -0400 Subject: [PATCH 03/18] Rewrite capitalize method --- src/org/apollo/util/TextUtil.java | 39 ++++++++++++------------------- 1 file changed, 15 insertions(+), 24 deletions(-) diff --git a/src/org/apollo/util/TextUtil.java b/src/org/apollo/util/TextUtil.java index fe76006a..222b2a93 100644 --- a/src/org/apollo/util/TextUtil.java +++ b/src/org/apollo/util/TextUtil.java @@ -2,7 +2,7 @@ package org.apollo.util; /** * A class which contains text-related utility methods. - * + * * @author Graham */ public final class TextUtil { @@ -18,37 +18,28 @@ public final class TextUtil { /** * Capitalizes the string correctly. - * + * * @param str The input string. * @return The string with correct capitalization. */ public static String capitalize(String str) { - char[] chars = str.toCharArray(); - boolean sentenceStart = true; - for (int i = 0; i < chars.length; i++) { - char c = chars[i]; - if (sentenceStart) { - if (c >= 'a' && c <= 'z') { - chars[i] -= 0x20; - sentenceStart = false; - } else if (c >= 'A' && c <= 'Z') { - sentenceStart = false; - } - } else { - if (c >= 'A' && c <= 'Z') { - chars[i] += 0x20; - } - } - if (c == '.' || c == '!' || c == '?') { - sentenceStart = true; + boolean capitalize = true; + StringBuilder bldr = new StringBuilder(str); + for (int index = 0, length = str.length(); index < length; index++) { + char character = bldr.charAt(index); + if (character == '.' || character == '!' || character == '?') { + capitalize = true; + } else if (capitalize && !Character.isWhitespace(character)) { + bldr.setCharAt(index, Character.toUpperCase(character)); + capitalize = false; } } - return new String(chars, 0, chars.length); + return bldr.toString(); } /** * Compresses the input text ({@code in}) and places the result in the {@code out} array. - * + * * @param in The input text. * @param out The output array. * @return The number of bytes written to the output array. @@ -95,7 +86,7 @@ public final class TextUtil { /** * Filters invalid characters from the specified string. - * + * * @param str The input string. * @return The filtered string. */ @@ -115,7 +106,7 @@ public final class TextUtil { /** * Uncompresses the compressed data ({@code in}) with the length ({@code len}) and returns the uncompressed * {@link String}. - * + * * @param in The compressed input data. * @param len The length. * @return The uncompressed {@link String}. From 08ffdf9f411f7d20db24157b4064f7f69a9934a0 Mon Sep 17 00:00:00 2001 From: atomicint Date: Tue, 7 Apr 2015 18:59:22 -0400 Subject: [PATCH 04/18] Format POM --- pom.xml | 133 ++++++++++++++++++++++++++++---------------------------- 1 file changed, 66 insertions(+), 67 deletions(-) diff --git a/pom.xml b/pom.xml index 4d5eeb1c..fb44099f 100644 --- a/pom.xml +++ b/pom.xml @@ -1,78 +1,77 @@ - - 4.0.0 - org.apollo - 1.0 - apollo + 4.0.0 + org.apollo + 1.0 + apollo - - src - test - - - org.apache.maven.plugins - maven-compiler-plugin - 3.1 - - 1.8 - 1.8 - - + + src + test + + + org.apache.maven.plugins + maven-compiler-plugin + 3.1 + + 1.8 + 1.8 + + - - org.codehaus.mojo - exec-maven-plugin - 1.3.2 - - org.apollo.Server - - -server - -Xmx750M - - - - - + + org.codehaus.mojo + exec-maven-plugin + 1.3.2 + + org.apollo.Server + + -server + -Xmx750M + + + + + - - - org.apache.commons - commons-compress - 1.9 - + + + org.apache.commons + commons-compress + 1.9 + - - org.jruby - jruby-complete - 1.7.19 - + + org.jruby + jruby-complete + 1.7.19 + - - com.google.guava - guava - 18.0 - + + com.google.guava + guava + 18.0 + - - io.netty - netty-all - 4.0.27.Final - compile - + + io.netty + netty-all + 4.0.27.Final + compile + - - com.lambdaworks - scrypt - 1.4.0 - + + com.lambdaworks + scrypt + 1.4.0 + - - com.mchange - c3p0 - 0.9.5 - + + com.mchange + c3p0 + 0.9.5 + - + \ No newline at end of file From 433d4c359a559f95f1fe69f8e3d0630f5320e251 Mon Sep 17 00:00:00 2001 From: atomicint Date: Wed, 8 Apr 2015 16:40:15 -0400 Subject: [PATCH 05/18] Strict whitespace format, make private fields final that can be immutable --- data/plugins/bootstrap.rb | 19 ++- .../burtleburtle/bob/rand/IsaacRandom.java | 14 +- src/org/apollo/Server.java | 10 +- src/org/apollo/ServerContext.java | 10 +- src/org/apollo/Service.java | 6 +- src/org/apollo/ServiceManager.java | 14 +- src/org/apollo/fs/FileDescriptor.java | 8 +- src/org/apollo/fs/FileSystemConstants.java | 2 +- src/org/apollo/fs/Index.java | 10 +- src/org/apollo/fs/IndexedFileSystem.java | 20 +-- src/org/apollo/fs/archive/Archive.java | 10 +- src/org/apollo/fs/archive/ArchiveEntry.java | 8 +- .../apollo/fs/decoder/GameObjectDecoder.java | 28 ++-- .../fs/decoder/ItemDefinitionDecoder.java | 8 +- src/org/apollo/fs/decoder/MapFileDecoder.java | 12 +- .../fs/decoder/NpcDefinitionDecoder.java | 18 +-- .../fs/decoder/ObjectDefinitionDecoder.java | 8 +- src/org/apollo/game/GameConstants.java | 2 +- src/org/apollo/game/GamePulseHandler.java | 4 +- src/org/apollo/game/GameService.java | 16 +-- src/org/apollo/game/action/Action.java | 6 +- .../apollo/game/action/DistancedAction.java | 4 +- src/org/apollo/game/command/Command.java | 8 +- .../game/command/CommandDispatcher.java | 8 +- .../apollo/game/command/CommandListener.java | 8 +- .../game/command/CreditsCommandListener.java | 6 +- src/org/apollo/game/message/Message.java | 4 +- .../apollo/game/message/MessageHandler.java | 4 +- .../game/message/MessageHandlerChain.java | 8 +- .../game/message/MessageHandlerChainSet.java | 8 +- .../handler/BankButtonMessageHandler.java | 2 +- .../message/handler/BankMessageHandler.java | 8 +- .../message/handler/ChatMessageHandler.java | 2 +- .../handler/ChatVerificationHandler.java | 2 +- .../ClosedInterfaceMessageHandler.java | 2 +- .../handler/CommandMessageHandler.java | 2 +- .../handler/DialogueButtonHandler.java | 2 +- .../DialogueContinueMessageHandler.java | 2 +- .../handler/EnteredAmountMessageHandler.java | 2 +- .../message/handler/EquipItemHandler.java | 7 +- .../ItemOnItemVerificationHandler.java | 2 +- .../ItemOnObjectVerificationHandler.java | 5 +- .../handler/ItemVerificationHandler.java | 8 +- .../ObjectActionVerificationHandler.java | 4 +- .../PlayerActionVerificationHandler.java | 2 +- .../handler/PlayerDesignMessageHandler.java | 2 +- .../PlayerDesignVerificationHandler.java | 8 +- .../handler/RemoveEquippedItemHandler.java | 2 +- .../handler/SwitchItemMessageHandler.java | 2 +- .../message/handler/WalkMessageHandler.java | 2 +- .../game/message/impl/AddFriendMessage.java | 6 +- .../game/message/impl/AddIgnoreMessage.java | 6 +- .../game/message/impl/ArrowKeyMessage.java | 8 +- .../game/message/impl/ButtonMessage.java | 6 +- .../apollo/game/message/impl/ChatMessage.java | 12 +- .../game/message/impl/ClearRegionMessage.java | 6 +- .../message/impl/CloseInterfaceMessage.java | 2 +- .../message/impl/ClosedInterfaceMessage.java | 2 +- .../game/message/impl/CommandMessage.java | 6 +- .../game/message/impl/ConfigMessage.java | 8 +- .../message/impl/DialogueContinueMessage.java | 6 +- .../impl/DisplayCrossbonesMessage.java | 6 +- .../impl/DisplayTabInterfaceMessage.java | 6 +- .../game/message/impl/EnterAmountMessage.java | 2 +- .../message/impl/EnteredAmountMessage.java | 6 +- .../message/impl/FifthItemActionMessage.java | 4 +- .../message/impl/FifthItemOptionMessage.java | 4 +- .../message/impl/FifthNpcActionMessage.java | 2 +- .../impl/FifthPlayerActionMessage.java | 4 +- .../message/impl/FirstItemActionMessage.java | 4 +- .../message/impl/FirstItemOptionMessage.java | 4 +- .../message/impl/FirstNpcActionMessage.java | 4 +- .../impl/FirstObjectActionMessage.java | 4 +- .../impl/FirstPlayerActionMessage.java | 4 +- .../impl/FlaggedMouseEventMessage.java | 12 +- .../impl/FlashTabInterfaceMessage.java | 2 +- .../impl/FlashingTabClickedMessage.java | 2 +- .../game/message/impl/FocusUpdateMessage.java | 6 +- .../impl/ForwardPrivateChatMessage.java | 12 +- .../message/impl/FourthItemActionMessage.java | 4 +- .../message/impl/FourthItemOptionMessage.java | 4 +- .../message/impl/FourthNpcActionMessage.java | 4 +- .../impl/FourthPlayerActionMessage.java | 4 +- .../impl/FriendServerStatusMessage.java | 6 +- .../impl/GroupedRegionUpdateMessage.java | 14 +- .../game/message/impl/HintIconMessage.java | 10 +- .../message/impl/IdAssignmentMessage.java | 8 +- .../game/message/impl/IgnoreListMessage.java | 6 +- .../message/impl/InventoryItemMessage.java | 12 +- .../game/message/impl/ItemActionMessage.java | 4 +- .../game/message/impl/ItemOnItemMessage.java | 10 +- .../message/impl/ItemOnObjectMessage.java | 10 +- .../game/message/impl/ItemOptionMessage.java | 4 +- .../game/message/impl/KeepAliveMessage.java | 4 +- .../game/message/impl/LogoutMessage.java | 2 +- .../game/message/impl/MagicOnItemMessage.java | 6 +- .../impl/MobAnimationResetMessage.java | 2 +- .../game/message/impl/NpcActionMessage.java | 8 +- .../impl/NpcSynchronizationMessage.java | 10 +- .../message/impl/ObjectActionMessage.java | 10 +- .../impl/OpenDialogueInterfaceMessage.java | 6 +- .../impl/OpenDialogueOverlayMessage.java | 6 +- .../message/impl/OpenInterfaceMessage.java | 6 +- .../impl/OpenInterfaceSidebarMessage.java | 8 +- .../game/message/impl/OpenOverlayMessage.java | 4 +- .../game/message/impl/OpenSidebarMessage.java | 4 +- .../message/impl/PlayerActionMessage.java | 8 +- .../message/impl/PlayerDesignMessage.java | 6 +- .../impl/PlayerSynchronizationMessage.java | 16 +-- .../message/impl/PrivacyOptionMessage.java | 10 +- .../game/message/impl/PrivateChatMessage.java | 10 +- .../message/impl/RegionChangeMessage.java | 6 +- .../message/impl/RegionUpdateMessage.java | 2 +- .../message/impl/RemoveFriendMessage.java | 6 +- .../message/impl/RemoveIgnoreMessage.java | 6 +- .../message/impl/RemoveObjectMessage.java | 12 +- .../message/impl/RemoveTileItemMessage.java | 10 +- .../message/impl/SecondItemActionMessage.java | 4 +- .../message/impl/SecondItemOptionMessage.java | 4 +- .../message/impl/SecondNpcActionMessage.java | 4 +- .../impl/SecondObjectActionMessage.java | 4 +- .../impl/SecondPlayerActionMessage.java | 4 +- .../game/message/impl/SendFriendMessage.java | 8 +- .../game/message/impl/SendObjectMessage.java | 14 +- .../impl/SendPublicTileItemMessage.java | 12 +- .../message/impl/SendTileItemMessage.java | 10 +- .../game/message/impl/ServerChatMessage.java | 8 +- .../message/impl/SetPlayerActionMessage.java | 14 +- .../message/impl/SetUpdatedRegionMessage.java | 8 +- .../impl/SetWidgetItemModelMessage.java | 10 +- .../impl/SetWidgetModelAnimationMessage.java | 8 +- .../impl/SetWidgetNpcModelMessage.java | 8 +- .../impl/SetWidgetPlayerModelMessage.java | 6 +- .../message/impl/SetWidgetTextMessage.java | 8 +- .../impl/SetWidgetVisibilityMessage.java | 8 +- .../game/message/impl/SpamPacketMessage.java | 6 +- .../game/message/impl/SwitchItemMessage.java | 14 +- .../impl/SwitchTabInterfaceMessage.java | 8 +- .../message/impl/TakeTileItemMessage.java | 8 +- .../message/impl/ThirdItemActionMessage.java | 4 +- .../message/impl/ThirdItemOptionMessage.java | 4 +- .../message/impl/ThirdNpcActionMessage.java | 4 +- .../impl/ThirdObjectActionMessage.java | 4 +- .../impl/ThirdPlayerActionMessage.java | 4 +- .../game/message/impl/UpdateItemsMessage.java | 8 +- .../message/impl/UpdateRunEnergyMessage.java | 6 +- .../game/message/impl/UpdateSkillMessage.java | 8 +- .../impl/UpdateSlottedItemsMessage.java | 8 +- .../message/impl/UpdateTileItemMessage.java | 14 +- .../message/impl/UpdateWeightMessage.java | 6 +- .../apollo/game/message/impl/WalkMessage.java | 10 +- src/org/apollo/game/model/Animation.java | 10 +- src/org/apollo/game/model/Appearance.java | 14 +- src/org/apollo/game/model/Direction.java | 10 +- src/org/apollo/game/model/Graphic.java | 14 +- src/org/apollo/game/model/Item.java | 14 +- src/org/apollo/game/model/Position.java | 40 +++--- src/org/apollo/game/model/World.java | 44 +++--- src/org/apollo/game/model/WorldConstants.java | 2 +- .../game/model/area/EntityUpdateType.java | 2 +- src/org/apollo/game/model/area/Region.java | 38 ++--- .../game/model/area/RegionCoordinates.java | 14 +- .../game/model/area/RegionListener.java | 4 +- .../game/model/area/RegionRepository.java | 22 +-- .../model/area/collision/CollisionFlag.java | 12 +- .../model/area/collision/CollisionMatrix.java | 24 ++-- .../model/area/update/UpdateOperation.java | 12 +- .../game/model/def/EquipmentDefinition.java | 48 +++---- .../apollo/game/model/def/ItemDefinition.java | 66 ++++----- .../apollo/game/model/def/NpcDefinition.java | 68 ++++----- .../game/model/def/ObjectDefinition.java | 50 +++---- src/org/apollo/game/model/entity/Entity.java | 14 +- .../game/model/entity/EquipmentConstants.java | 2 +- .../apollo/game/model/entity/GroundItem.java | 6 +- src/org/apollo/game/model/entity/Mob.java | 74 +++++----- src/org/apollo/game/model/entity/Npc.java | 16 +-- src/org/apollo/game/model/entity/Player.java | 130 +++++++++--------- src/org/apollo/game/model/entity/Skill.java | 22 +-- .../apollo/game/model/entity/SkillSet.java | 42 +++--- .../game/model/entity/WalkingQueue.java | 20 +-- .../game/model/entity/attr/Attribute.java | 10 +- .../entity/attr/AttributeDefinition.java | 18 +-- .../game/model/entity/attr/AttributeMap.java | 20 +-- .../game/model/entity/attr/AttributeType.java | 6 +- .../model/entity/attr/BooleanAttribute.java | 4 +- .../model/entity/attr/NumericalAttribute.java | 10 +- .../model/entity/attr/StringAttribute.java | 6 +- .../model/entity/obj/DynamicGameObject.java | 6 +- .../game/model/entity/obj/GameObject.java | 18 +-- .../game/model/entity/obj/ObjectGroup.java | 4 +- .../game/model/entity/obj/ObjectType.java | 2 +- .../path/AStarPathfindingAlgorithm.java | 8 +- .../model/entity/path/ChebyshevHeuristic.java | 2 +- .../game/model/entity/path/Heuristic.java | 4 +- .../model/entity/path/ManhattanHeuristic.java | 2 +- .../apollo/game/model/entity/path/Node.java | 20 +-- .../entity/path/PathfindingAlgorithm.java | 8 +- .../path/SimplePathfindingAlgorithm.java | 10 +- .../game/model/entity/setting/Gender.java | 4 +- .../entity/setting/MembershipStatus.java | 4 +- .../model/entity/setting/PrivacyState.java | 8 +- .../model/entity/setting/PrivilegeLevel.java | 6 +- .../entity/setting/ScreenBrightness.java | 6 +- .../model/entity/setting/ServerStatus.java | 6 +- src/org/apollo/game/model/event/Event.java | 2 +- .../game/model/event/EventListener.java | 2 +- .../game/model/event/EventListenerChain.java | 4 +- .../model/event/EventListenerChainSet.java | 6 +- .../apollo/game/model/event/PlayerEvent.java | 2 +- .../game/model/event/impl/LoginEvent.java | 2 +- .../game/model/event/impl/LogoutEvent.java | 2 +- .../event/impl/MobPositionUpdateEvent.java | 6 +- .../game/model/inter/EnterAmountListener.java | 4 +- .../game/model/inter/InterfaceConstants.java | 2 +- .../game/model/inter/InterfaceListener.java | 2 +- .../apollo/game/model/inter/InterfaceSet.java | 44 +++--- .../game/model/inter/InterfaceType.java | 2 +- .../game/model/inter/bank/BankConstants.java | 2 +- .../bank/BankDepositEnterAmountListener.java | 4 +- .../inter/bank/BankInterfaceListener.java | 4 +- .../game/model/inter/bank/BankUtils.java | 8 +- .../bank/BankWithdrawEnterAmountListener.java | 4 +- .../model/inter/dialogue/DialogueAdapter.java | 2 +- .../inter/dialogue/DialogueListener.java | 7 +- .../inv/AppearanceInventoryListener.java | 4 +- .../game/model/inv/FullInventoryListener.java | 4 +- src/org/apollo/game/model/inv/Inventory.java | 66 ++++----- .../game/model/inv/InventoryAdapter.java | 2 +- .../game/model/inv/InventoryConstants.java | 2 +- .../game/model/inv/InventoryListener.java | 8 +- .../apollo/game/model/inv/SlottedItem.java | 12 +- .../inv/SynchronizationInventoryListener.java | 4 +- .../model/skill/LevelUpSkillListener.java | 4 +- .../apollo/game/model/skill/SkillAdapter.java | 2 +- .../game/model/skill/SkillListener.java | 8 +- .../skill/SynchronizationSkillListener.java | 4 +- .../apollo/game/scheduling/ScheduledTask.java | 8 +- src/org/apollo/game/scheduling/Scheduler.java | 4 +- .../game/scheduling/impl/NpcMovementTask.java | 8 +- .../impl/SkillNormalizationTask.java | 4 +- .../apollo/game/sync/ClientSynchronizer.java | 4 +- .../game/sync/ParallelClientSynchronizer.java | 2 +- .../sync/SequentialClientSynchronizer.java | 2 +- .../game/sync/block/AnimationBlock.java | 6 +- .../game/sync/block/AppearanceBlock.java | 24 ++-- src/org/apollo/game/sync/block/ChatBlock.java | 14 +- .../game/sync/block/ForceChatBlock.java | 6 +- .../game/sync/block/ForceMovementBlock.java | 18 +-- .../apollo/game/sync/block/GraphicBlock.java | 6 +- .../game/sync/block/HitUpdateBlock.java | 12 +- .../game/sync/block/InteractingMobBlock.java | 6 +- .../sync/block/SecondaryHitUpdateBlock.java | 12 +- .../game/sync/block/SynchronizationBlock.java | 22 +-- .../sync/block/SynchronizationBlockSet.java | 12 +- .../game/sync/block/TransformBlock.java | 6 +- .../game/sync/block/TurnToPositionBlock.java | 6 +- .../apollo/game/sync/seg/AddNpcSegment.java | 10 +- .../game/sync/seg/AddPlayerSegment.java | 8 +- .../apollo/game/sync/seg/MovementSegment.java | 6 +- .../game/sync/seg/RemoveMobSegment.java | 2 +- src/org/apollo/game/sync/seg/SegmentType.java | 2 +- .../game/sync/seg/SynchronizationSegment.java | 8 +- .../apollo/game/sync/seg/TeleportSegment.java | 6 +- .../sync/task/NpcSynchronizationTask.java | 10 +- .../sync/task/PhasedSynchronizationTask.java | 4 +- .../sync/task/PlayerSynchronizationTask.java | 7 +- .../sync/task/PostNpcSynchronizationTask.java | 4 +- .../task/PostPlayerSynchronizationTask.java | 4 +- .../sync/task/PreNpcSynchronizationTask.java | 4 +- .../task/PrePlayerSynchronizationTask.java | 24 ++-- .../game/sync/task/SynchronizationTask.java | 2 +- .../apollo/io/EquipmentDefinitionParser.java | 6 +- .../io/MessageHandlerChainSetParser.java | 6 +- src/org/apollo/io/PluginMetaDataParser.java | 8 +- src/org/apollo/io/player/BinaryFileUtils.java | 4 +- .../io/player/BinaryPlayerSerializer.java | 12 +- .../io/player/DummyPlayerSerializer.java | 2 +- .../io/player/JdbcPlayerSerializer.java | 2 +- .../io/player/PlayerLoaderResponse.java | 10 +- .../apollo/io/player/PlayerSerializer.java | 6 +- src/org/apollo/login/LoginService.java | 10 +- src/org/apollo/login/PlayerLoaderWorker.java | 4 +- src/org/apollo/login/PlayerSaverWorker.java | 4 +- src/org/apollo/net/ApolloHandler.java | 4 +- .../apollo/net/HttpChannelInitializer.java | 4 +- .../apollo/net/JagGrabChannelInitializer.java | 4 +- src/org/apollo/net/NetworkConstants.java | 2 +- .../apollo/net/ServiceChannelInitializer.java | 4 +- src/org/apollo/net/codec/game/AccessMode.java | 2 +- .../apollo/net/codec/game/DataConstants.java | 2 +- src/org/apollo/net/codec/game/DataOrder.java | 2 +- .../net/codec/game/DataTransformation.java | 2 +- src/org/apollo/net/codec/game/DataType.java | 6 +- .../net/codec/game/GameDecoderState.java | 2 +- .../net/codec/game/GameMessageDecoder.java | 4 +- .../net/codec/game/GameMessageEncoder.java | 4 +- src/org/apollo/net/codec/game/GamePacket.java | 12 +- .../net/codec/game/GamePacketBuilder.java | 52 +++---- .../net/codec/game/GamePacketDecoder.java | 10 +- .../net/codec/game/GamePacketEncoder.java | 4 +- .../net/codec/game/GamePacketReader.java | 50 +++---- .../codec/handshake/HandshakeConstants.java | 2 +- .../net/codec/handshake/HandshakeDecoder.java | 2 +- .../net/codec/handshake/HandshakeMessage.java | 6 +- .../net/codec/jaggrab/JagGrabRequest.java | 6 +- .../codec/jaggrab/JagGrabRequestDecoder.java | 2 +- .../net/codec/jaggrab/JagGrabResponse.java | 6 +- .../codec/jaggrab/JagGrabResponseEncoder.java | 2 +- .../net/codec/login/LoginConstants.java | 2 +- .../apollo/net/codec/login/LoginDecoder.java | 8 +- .../net/codec/login/LoginDecoderState.java | 2 +- .../apollo/net/codec/login/LoginEncoder.java | 2 +- .../apollo/net/codec/login/LoginRequest.java | 18 +-- .../apollo/net/codec/login/LoginResponse.java | 10 +- .../net/codec/update/OnDemandRequest.java | 16 +-- .../net/codec/update/OnDemandResponse.java | 12 +- .../net/codec/update/UpdateDecoder.java | 2 +- .../net/codec/update/UpdateEncoder.java | 2 +- src/org/apollo/net/meta/PacketMetaData.java | 14 +- .../apollo/net/meta/PacketMetaDataGroup.java | 6 +- src/org/apollo/net/meta/PacketType.java | 2 +- .../apollo/net/release/MessageDecoder.java | 4 +- .../apollo/net/release/MessageEncoder.java | 4 +- src/org/apollo/net/release/Release.java | 16 +-- .../release/r317/AddFriendMessageDecoder.java | 2 +- .../r317/AddGlobalTileItemMessageEncoder.java | 2 +- .../release/r317/AddIgnoreMessageDecoder.java | 2 +- .../r317/AddTileItemMessageEncoder.java | 2 +- .../release/r317/ArrowKeyMessageDecoder.java | 2 +- .../release/r317/ButtonMessageDecoder.java | 2 +- .../net/release/r317/ChatMessageDecoder.java | 2 +- .../r317/CloseInterfaceMessageEncoder.java | 2 +- .../r317/ClosedInterfaceMessageDecoder.java | 2 +- .../release/r317/CommandMessageDecoder.java | 2 +- .../release/r317/ConfigMessageEncoder.java | 2 +- .../r317/DialogueContinueMessageDecoder.java | 2 +- .../r317/DisplayCrossbonesMessageEncoder.java | 2 +- .../DisplayTabInterfaceMessageEncoder.java | 2 +- .../r317/EnterAmountMessageEncoder.java | 2 +- .../r317/EnteredAmountMessageDecoder.java | 2 +- .../r317/FifthItemActionMessageDecoder.java | 2 +- .../r317/FifthItemOptionMessageDecoder.java | 2 +- .../r317/FifthPlayerActionMessageDecoder.java | 2 +- .../r317/FirstItemActionMessageDecoder.java | 2 +- .../r317/FirstItemOptionMessageDecoder.java | 2 +- .../r317/FirstNpcActionMessageDecoder.java | 2 +- .../r317/FirstObjectActionMessageDecoder.java | 2 +- .../r317/FirstPlayerActionMessageDecoder.java | 2 +- .../r317/FlaggedMouseEventMessageDecoder.java | 8 +- .../r317/FocusUpdateMessageDecoder.java | 2 +- .../ForwardPrivateChatMessageEncoder.java | 2 +- .../r317/FourthItemActionMessageDecoder.java | 2 +- .../r317/FourthItemOptionMessageDecoder.java | 2 +- .../FourthPlayerActionMessageDecoder.java | 2 +- .../FriendServerStatusMessageEncoder.java | 2 +- .../GroupedRegionUpdateMessageEncoder.java | 2 +- .../r317/IdAssignmentMessageEncoder.java | 2 +- .../r317/IgnoreListMessageEncoder.java | 2 +- .../r317/ItemOnItemMessageDecoder.java | 2 +- .../r317/ItemOnObjectMessageDecoder.java | 2 +- .../release/r317/KeepAliveMessageDecoder.java | 2 +- .../release/r317/LogoutMessageEncoder.java | 2 +- .../r317/MagicOnItemMessageDecoder.java | 2 +- .../r317/MobAnimationResetMessageEncoder.java | 2 +- .../r317/MouseClickedMessageDecoder.java | 4 +- .../NpcSynchronizationMessageEncoder.java | 26 ++-- .../OpenDialogueInterfaceMessageEncoder.java | 2 +- .../OpenDialogueOverlayMessageEncoder.java | 2 +- .../r317/OpenInterfaceMessageEncoder.java | 2 +- .../OpenInterfaceSidebarMessageEncoder.java | 2 +- .../r317/PlayerDesignMessageDecoder.java | 2 +- .../PlayerSynchronizationMessageEncoder.java | 30 ++-- .../r317/PrivacyOptionMessageDecoder.java | 2 +- .../r317/PrivacyOptionMessageEncoder.java | 2 +- .../r317/PrivateChatMessageDecoder.java | 2 +- .../r317/RegionChangeMessageEncoder.java | 2 +- .../apollo/net/release/r317/Release317.java | 2 +- .../r317/RemoveFriendMessageDecoder.java | 2 +- .../r317/RemoveIgnoreMessageDecoder.java | 2 +- .../r317/RemoveObjectMessageEncoder.java | 2 +- .../r317/RemoveTileItemMessageEncoder.java | 2 +- .../r317/SecondItemActionMessageDecoder.java | 2 +- .../r317/SecondItemOptionMessageDecoder.java | 2 +- .../r317/SecondNpcActionMessageDecoder.java | 2 +- .../SecondObjectActionMessageDecoder.java | 2 +- .../SecondPlayerActionMessageDecoder.java | 2 +- .../r317/SendFriendMessageEncoder.java | 2 +- .../r317/SendObjectMessageEncoder.java | 2 +- .../r317/ServerMessageMessageEncoder.java | 2 +- .../r317/SetPlayerActionMessageEncoder.java | 2 +- .../r317/SetUpdatedRegionMessageEncoder.java | 2 +- .../SetWidgetItemModelMessageEncoder.java | 2 +- ...SetWidgetModelAnimationMessageEncoder.java | 2 +- .../r317/SetWidgetNpcModelMessageEncoder.java | 2 +- .../SetWidgetPlayerModelMessageEncoder.java | 2 +- .../r317/SetWidgetTextMessageEncoder.java | 2 +- .../SetWidgetVisibilityMessageEncoder.java | 2 +- .../r317/SpamPacketMessageDecoder.java | 2 +- .../r317/SwitchItemMessageDecoder.java | 2 +- .../SwitchTabInterfaceMessageEncoder.java | 2 +- .../r317/TakeTileItemMessageDecoder.java | 2 +- .../r317/ThirdItemActionMessageDecoder.java | 2 +- .../r317/ThirdItemOptionMessageDecoder.java | 2 +- .../r317/ThirdNpcActionMessageDecoder.java | 2 +- .../r317/ThirdObjectActionMessageDecoder.java | 2 +- .../r317/ThirdPlayerActionMessageDecoder.java | 2 +- .../r317/UpdateItemsMessageEncoder.java | 2 +- .../r317/UpdateRunEnergyMessageEncoder.java | 2 +- .../r317/UpdateSkillMessageEncoder.java | 2 +- .../UpdateSlottedItemsMessageEncoder.java | 2 +- .../r317/UpdateTileItemMessageEncoder.java | 2 +- .../r317/UpdateWeightMessageEncoder.java | 2 +- .../net/release/r317/WalkMessageDecoder.java | 2 +- .../release/r377/AddFriendMessageDecoder.java | 2 +- .../r377/AddGlobalTileItemMessageEncoder.java | 2 +- .../release/r377/AddIgnoreMessageDecoder.java | 2 +- .../r377/AddTileItemMessageEncoder.java | 2 +- .../release/r377/ArrowKeyMessageDecoder.java | 2 +- .../release/r377/ButtonMessageDecoder.java | 2 +- .../net/release/r377/ChatMessageDecoder.java | 2 +- .../r377/CloseInterfaceMessageEncoder.java | 2 +- .../r377/ClosedInterfaceMessageDecoder.java | 2 +- .../release/r377/CommandMessageDecoder.java | 2 +- .../release/r377/ConfigMessageEncoder.java | 2 +- .../r377/DialogueContinueMessageDecoder.java | 2 +- .../r377/DisplayCrossbonesMessageEncoder.java | 2 +- .../DisplayTabInterfaceMessageEncoder.java | 2 +- .../r377/EnterAmountMessageEncoder.java | 2 +- .../r377/EnteredAmountMessageDecoder.java | 2 +- .../r377/FifthItemActionMessageDecoder.java | 2 +- .../r377/FifthItemOptionMessageDecoder.java | 2 +- .../r377/FifthPlayerActionMessageDecoder.java | 2 +- .../r377/FirstItemActionMessageDecoder.java | 2 +- .../r377/FirstItemOptionMessageDecoder.java | 2 +- .../r377/FirstNpcActionMessageDecoder.java | 2 +- .../r377/FirstObjectActionMessageDecoder.java | 2 +- .../r377/FirstPlayerActionMessageDecoder.java | 2 +- .../r377/FlaggedMouseEventMessageDecoder.java | 8 +- .../r377/FocusUpdateMessageDecoder.java | 2 +- .../ForwardPrivateChatMessageEncoder.java | 2 +- .../r377/FourthItemActionMessageDecoder.java | 2 +- .../r377/FourthItemOptionMessageDecoder.java | 2 +- .../FourthPlayerActionMessageDecoder.java | 2 +- .../FriendServerStatusMessageEncoder.java | 2 +- .../r377/IdAssignmentMessageEncoder.java | 2 +- .../r377/IgnoreListMessageEncoder.java | 2 +- .../r377/ItemOnItemMessageDecoder.java | 2 +- .../r377/ItemOnObjectMessageDecoder.java | 2 +- .../release/r377/KeepAliveMessageDecoder.java | 2 +- .../release/r377/LogoutMessageEncoder.java | 2 +- .../r377/MagicOnItemMessageDecoder.java | 2 +- .../r377/MobAnimationResetMessageEncoder.java | 2 +- .../r377/MouseClickedMessageDecoder.java | 4 +- .../NpcSynchronizationMessageEncoder.java | 26 ++-- .../OpenDialogueInterfaceMessageEncoder.java | 2 +- .../OpenDialogueOverlayMessageEncoder.java | 2 +- .../r377/OpenInterfaceMessageEncoder.java | 2 +- .../OpenInterfaceSidebarMessageEncoder.java | 2 +- .../r377/PlayerDesignMessageDecoder.java | 2 +- .../PlayerSynchronizationMessageEncoder.java | 30 ++-- .../r377/PrivacyOptionMessageDecoder.java | 2 +- .../r377/PrivacyOptionMessageEncoder.java | 2 +- .../r377/PrivateChatMessageDecoder.java | 2 +- .../r377/RegionChangeMessageEncoder.java | 2 +- .../apollo/net/release/r377/Release377.java | 2 +- .../r377/RemoveFriendMessageDecoder.java | 2 +- .../r377/RemoveIgnoreMessageDecoder.java | 2 +- .../r377/RemoveObjectMessageEncoder.java | 2 +- .../r377/RemoveTileItemMessageEncoder.java | 2 +- .../r377/SecondItemActionMessageDecoder.java | 2 +- .../r377/SecondItemOptionMessageDecoder.java | 2 +- .../r377/SecondNpcActionMessageDecoder.java | 2 +- .../SecondObjectActionMessageDecoder.java | 2 +- .../SecondPlayerActionMessageDecoder.java | 2 +- .../r377/SendFriendMessageEncoder.java | 2 +- .../r377/SendObjectMessageEncoder.java | 2 +- .../r377/ServerMessageMessageEncoder.java | 2 +- .../r377/SetPlayerActionMessageEncoder.java | 2 +- .../r377/SetUpdatedRegionMessageEncoder.java | 2 +- .../SetWidgetItemModelMessageEncoder.java | 2 +- ...SetWidgetModelAnimationMessageEncoder.java | 2 +- .../r377/SetWidgetNpcModelMessageEncoder.java | 2 +- .../SetWidgetPlayerModelMessageEncoder.java | 2 +- .../r377/SetWidgetTexMessageEncoder.java | 2 +- .../SetWidgetVisibilityMessageEncoder.java | 2 +- .../r377/SpamPacketMessageDecoder.java | 2 +- .../r377/SwitchItemMessageDecoder.java | 2 +- .../SwitchTabInterfaceMessageEncoder.java | 2 +- .../r377/TakeTileItemMessageDecoder.java | 2 +- .../r377/ThirdItemActionMessageDecoder.java | 2 +- .../r377/ThirdItemOptionMessageDecoder.java | 2 +- .../r377/ThirdNpcActionMessageDecoder.java | 2 +- .../r377/ThirdObjectActionMessageDecoder.java | 2 +- .../r377/ThirdPlayerActionMessageDecoder.java | 2 +- .../r377/UpdateItemsMessageEncoder.java | 2 +- .../r377/UpdateRunEnergyMessageEncoder.java | 2 +- .../r377/UpdateSkillMessageEncoder.java | 2 +- .../UpdateSlottedItemsMessageEncoder.java | 2 +- .../r377/UpdateTileItemMessageEncoder.java | 2 +- .../r377/UpdateWeightMessageEncoder.java | 2 +- .../net/release/r377/WalkMessageDecoder.java | 2 +- src/org/apollo/net/session/GameSession.java | 10 +- src/org/apollo/net/session/LoginSession.java | 14 +- src/org/apollo/net/session/Session.java | 8 +- src/org/apollo/net/session/UpdateSession.java | 4 +- src/org/apollo/security/IsaacRandomPair.java | 8 +- .../apollo/security/PlayerCredentials.java | 18 +-- src/org/apollo/tools/EquipmentConstants.java | 2 +- src/org/apollo/tools/EquipmentUpdater.java | 24 ++-- src/org/apollo/tools/RsaKeyGenerator.java | 7 +- src/org/apollo/update/ChannelRequest.java | 8 +- src/org/apollo/update/HttpRequestWorker.java | 8 +- .../apollo/update/JagGrabRequestWorker.java | 4 +- .../apollo/update/OnDemandRequestWorker.java | 4 +- src/org/apollo/update/RequestWorker.java | 8 +- src/org/apollo/update/UpdateConstants.java | 2 +- src/org/apollo/update/UpdateDispatcher.java | 14 +- src/org/apollo/update/UpdateService.java | 6 +- .../resource/CombinedResourceProvider.java | 4 +- .../resource/HypertextResourceProvider.java | 4 +- .../update/resource/ResourceProvider.java | 6 +- .../resource/VirtualResourceProvider.java | 2 +- src/org/apollo/util/BufferUtil.java | 8 +- src/org/apollo/util/CollectionUtil.java | 4 +- src/org/apollo/util/CompressionUtil.java | 12 +- src/org/apollo/util/EnumerationUtil.java | 4 +- src/org/apollo/util/LanguageUtil.java | 6 +- src/org/apollo/util/MobRepository.java | 18 +-- src/org/apollo/util/NameUtil.java | 6 +- src/org/apollo/util/Point.java | 8 +- src/org/apollo/util/StatefulFrameDecoder.java | 14 +- src/org/apollo/util/StreamUtil.java | 6 +- .../util/plugin/DependencyException.java | 4 +- src/org/apollo/util/plugin/PluginContext.java | 6 +- .../apollo/util/plugin/PluginEnvironment.java | 6 +- src/org/apollo/util/plugin/PluginManager.java | 23 ++-- .../apollo/util/plugin/PluginMetaData.java | 20 +-- .../util/plugin/RubyPluginEnvironment.java | 6 +- src/org/apollo/util/xml/XmlNode.java | 38 ++--- src/org/apollo/util/xml/XmlParser.java | 14 +- 540 files changed, 1905 insertions(+), 1908 deletions(-) diff --git a/data/plugins/bootstrap.rb b/data/plugins/bootstrap.rb index c2704f12..ea4b5153 100644 --- a/data/plugins/bootstrap.rb +++ b/data/plugins/bootstrap.rb @@ -177,16 +177,15 @@ def on_message(args, proc) numbers = [ 'first', 'second', 'third', 'fourth', 'fifth' ] message = args[0]; option = 0 - # TODO - # numbers.each_index do |index| - # number = numbers[index] - # - # if message.to_s.start_with?(number) - # option = index + 1 - # message = message[number.length + 1, message.length].to_sym - # break - # end - # end + numbers.each_index do |index| + number = numbers[index] + + if message.to_s.start_with?(number) + option = index + 1 + message = message[number.length + 1, message.length].to_sym + break + end + end class_name = message.to_s.camelize.concat('Message') diff --git a/src/net/burtleburtle/bob/rand/IsaacRandom.java b/src/net/burtleburtle/bob/rand/IsaacRandom.java index d09d7320..80e3b9f9 100644 --- a/src/net/burtleburtle/bob/rand/IsaacRandom.java +++ b/src/net/burtleburtle/bob/rand/IsaacRandom.java @@ -5,7 +5,7 @@ package net.burtleburtle.bob.rand; * An implementation of the ISAAC psuedorandom number * generator. *

- * + * *
  * ------------------------------------------------------------------------------
  * Rand.java: By Bob Jenkins.  My random number generator, ISAAC.
@@ -20,7 +20,7 @@ package net.burtleburtle.bob.rand;
  * 

* This class has been changed to be more conformant to Java and javadoc conventions. *

- * + * * @author Bob Jenkins */ public final class IsaacRandom { @@ -68,12 +68,12 @@ public final class IsaacRandom { /** * The internal state. */ - private int[] mem; + private final int[] mem; /** * The results given to the user. */ - private int[] rsl; + private final int[] rsl; /** * Creates the random number generator without an initial seed. @@ -86,7 +86,7 @@ public final class IsaacRandom { /** * Creates the random number generator with the specified seed. - * + * * @param seed The seed. */ public IsaacRandom(int[] seed) { @@ -100,7 +100,7 @@ public final class IsaacRandom { /** * Initialises this random number generator. - * + * * @param hasSeed Set to {@code true} if a seed was passed to the constructor. */ private void init(boolean hasSeed) { @@ -291,7 +291,7 @@ public final class IsaacRandom { /** * Gets the next random value. - * + * * @return The next random value. */ public int nextInt() { diff --git a/src/org/apollo/Server.java b/src/org/apollo/Server.java index eb3703c9..57cda878 100644 --- a/src/org/apollo/Server.java +++ b/src/org/apollo/Server.java @@ -27,7 +27,7 @@ import org.apollo.util.plugin.PluginManager; /** * The core class of the Apollo server. - * + * * @author Graham */ public final class Server { @@ -39,7 +39,7 @@ public final class Server { /** * The entry point of the Apollo server application. - * + * * @param args The command-line arguments passed to the application. */ public static void main(String[] args) { @@ -81,7 +81,7 @@ public final class Server { /** * Creates the Apollo server. - * + * * @throws Exception If an error occurs whilst creating services. */ public Server() throws Exception { @@ -90,7 +90,7 @@ public final class Server { /** * Binds the server to the specified address. - * + * * @param serviceAddress The service address to bind to. * @param httpAddress The HTTP address to bind to. * @param jagGrabAddress The JAGGRAB address to bind to. @@ -115,7 +115,7 @@ public final class Server { /** * Initialises the server. - * + * * @param releaseClassName The class name of the current active {@link Release}. * @throws Exception If an error occurs. */ diff --git a/src/org/apollo/ServerContext.java b/src/org/apollo/ServerContext.java index b5b99744..ebfe295f 100644 --- a/src/org/apollo/ServerContext.java +++ b/src/org/apollo/ServerContext.java @@ -6,7 +6,7 @@ import org.apollo.net.release.Release; * A {@link ServerContext} is created along with the {@link Server} object. The primary difference is that a reference * to the current context should be passed around within the server. The {@link Server} should not be as it allows * access to some methods such as {@link Server#bind} which user scripts/code should not be able to access. - * + * * @author Graham */ public final class ServerContext { @@ -23,7 +23,7 @@ public final class ServerContext { /** * Creates a new server context. - * + * * @param release The current release. * @param serviceManager The service manager. */ @@ -35,7 +35,7 @@ public final class ServerContext { /** * Gets the current release. - * + * * @return The current release. */ public Release getRelease() { @@ -44,7 +44,7 @@ public final class ServerContext { /** * Gets a service. This method is shorthand for {@code getServiceManager().getService(...)}. - * + * * @param clazz The service class. * @return The service, or {@code null} if it could not be found. */ @@ -54,7 +54,7 @@ public final class ServerContext { /** * Gets the service manager. - * + * * @return The service manager. */ public ServiceManager getServiceManager() { diff --git a/src/org/apollo/Service.java b/src/org/apollo/Service.java index 8b19ee74..6734dd53 100644 --- a/src/org/apollo/Service.java +++ b/src/org/apollo/Service.java @@ -4,7 +4,7 @@ import org.apollo.game.model.World; /** * Represents a service that the server provides for a {@link World}. - * + * * @author Graham */ public abstract class Service { @@ -30,7 +30,7 @@ public abstract class Service { /** * Gets the {@link ServerContext}. - * + * * @return The context. */ public final ServerContext getContext() { @@ -39,7 +39,7 @@ public abstract class Service { /** * Sets the {@link ServerContext}. - * + * * @param context The context. */ public final void setContext(ServerContext context) { diff --git a/src/org/apollo/ServiceManager.java b/src/org/apollo/ServiceManager.java index 736a84cc..3a66a516 100644 --- a/src/org/apollo/ServiceManager.java +++ b/src/org/apollo/ServiceManager.java @@ -14,7 +14,7 @@ import org.xml.sax.SAXException; /** * A class which manages {@link Service}s. - * + * * @author Graham */ public final class ServiceManager { @@ -27,11 +27,11 @@ public final class ServiceManager { /** * The service map. */ - private Map, Service> services = new HashMap<>(); + private final Map, Service> services = new HashMap<>(); /** * Creates and initializes the {@link ServiceManager}. - * + * * @param world The {@link World} to create the {@link Service}s for. * @throws IOException If there is an error reading from the xml file. * @throws SAXException If there is an error parsing the xml file. @@ -43,7 +43,7 @@ public final class ServiceManager { /** * Gets a service. - * + * * @param clazz The service class. * @return The service. */ @@ -54,7 +54,7 @@ public final class ServiceManager { /** * Initializes this service manager. - * + * * @param world The {@link World} to create the {@link Service}s for. * @throws SAXException If the service XML file could not be parsed. * @throws IOException If the file could not be accessed. @@ -91,7 +91,7 @@ public final class ServiceManager { /** * Registers a service. - * + * * @param clazz The service's class. * @param service The service. */ @@ -102,7 +102,7 @@ public final class ServiceManager { /** * Sets the context of all services. - * + * * @param ctx The server context. */ public void setContext(ServerContext ctx) { diff --git a/src/org/apollo/fs/FileDescriptor.java b/src/org/apollo/fs/FileDescriptor.java index 902bfb99..8d93914f 100644 --- a/src/org/apollo/fs/FileDescriptor.java +++ b/src/org/apollo/fs/FileDescriptor.java @@ -2,7 +2,7 @@ package org.apollo.fs; /** * A class which points to a file in the cache. - * + * * @author Graham */ public final class FileDescriptor { @@ -19,7 +19,7 @@ public final class FileDescriptor { /** * Creates the file descriptor. - * + * * @param type The file type. * @param file The file id. */ @@ -30,7 +30,7 @@ public final class FileDescriptor { /** * Gets the file id. - * + * * @return The file id. */ public int getFile() { @@ -39,7 +39,7 @@ public final class FileDescriptor { /** * Gets the file type. - * + * * @return The file type. */ public int getType() { diff --git a/src/org/apollo/fs/FileSystemConstants.java b/src/org/apollo/fs/FileSystemConstants.java index 630b5fd4..39ab1887 100644 --- a/src/org/apollo/fs/FileSystemConstants.java +++ b/src/org/apollo/fs/FileSystemConstants.java @@ -2,7 +2,7 @@ package org.apollo.fs; /** * Holds file system related constants. - * + * * @author Graham */ public final class FileSystemConstants { diff --git a/src/org/apollo/fs/Index.java b/src/org/apollo/fs/Index.java index c112c616..66610ca1 100644 --- a/src/org/apollo/fs/Index.java +++ b/src/org/apollo/fs/Index.java @@ -4,14 +4,14 @@ import com.google.common.base.Preconditions; /** * An {@link Index} points to a file in the {@code main_file_cache.dat} file. - * + * * @author Graham */ public final class Index { /** * Decodes a buffer into an index. - * + * * @param buffer The buffer. * @return The decoded {@link Index}. * @throws IllegalArgumentException If the buffer length is invalid. @@ -37,7 +37,7 @@ public final class Index { /** * Creates the index. - * + * * @param size The size of the file. * @param block The first block of the file. */ @@ -48,7 +48,7 @@ public final class Index { /** * Gets the first block of the file. - * + * * @return The first block of the file. */ public int getBlock() { @@ -57,7 +57,7 @@ public final class Index { /** * Gets the size of the file. - * + * * @return The size of the file. */ public int getSize() { diff --git a/src/org/apollo/fs/IndexedFileSystem.java b/src/org/apollo/fs/IndexedFileSystem.java index a890b8eb..179bdbbd 100644 --- a/src/org/apollo/fs/IndexedFileSystem.java +++ b/src/org/apollo/fs/IndexedFileSystem.java @@ -14,7 +14,7 @@ import com.google.common.base.Preconditions; /** * A file system based on top of the operating system's file system. It consists of a data file and index files. Index * files point to blocks in the data file, which contains the actual data. - * + * * @author Graham */ public final class IndexedFileSystem implements Closeable { @@ -32,7 +32,7 @@ public final class IndexedFileSystem implements Closeable { /** * The index files. */ - private RandomAccessFile[] indices = new RandomAccessFile[256]; + private final RandomAccessFile[] indices = new RandomAccessFile[256]; /** * Read only flag. @@ -41,7 +41,7 @@ public final class IndexedFileSystem implements Closeable { /** * Creates the file system with the specified base directory. - * + * * @param base The base directory. * @param readOnly Indicates whether the file system will be read only or not. * @throws FileNotFoundException If the data files could not be found. @@ -70,7 +70,7 @@ public final class IndexedFileSystem implements Closeable { /** * Automatically detect the layout of the specified directory. - * + * * @param base The base directory. * @throws FileNotFoundException If the data files could not be found. */ @@ -97,7 +97,7 @@ public final class IndexedFileSystem implements Closeable { /** * Gets the CRC table. - * + * * @return The CRC table. * @throws IOException If there is an error accessing files to create the table. * @throws IllegalStateException If this file system is not read-only. @@ -145,7 +145,7 @@ public final class IndexedFileSystem implements Closeable { /** * Gets a file. - * + * * @param descriptor The {@link FileDescriptor} pointing to the file. * @return A {@link ByteBuffer} containing the contents of the file. * @throws IOException If there is an error decoding the file. @@ -211,7 +211,7 @@ public final class IndexedFileSystem implements Closeable { /** * Gets a file. - * + * * @param type The file type. * @param file The file id. * @return A {@link ByteBuffer} which contains the contents of the file. @@ -223,7 +223,7 @@ public final class IndexedFileSystem implements Closeable { /** * Gets the number of files with the specified type. - * + * * @param type The type. * @return The number of files. * @throws IOException If there is an error getting the length of the specified index file. @@ -241,7 +241,7 @@ public final class IndexedFileSystem implements Closeable { /** * Gets the index of a file. - * + * * @param descriptor The {@link FileDescriptor} which points to the file. * @return The {@link Index}. * @throws IOException If there is an error reading from the index file. @@ -269,7 +269,7 @@ public final class IndexedFileSystem implements Closeable { /** * Checks if this {@link IndexedFileSystem} is read only. - * + * * @return {@code true} if so, {@code false} if not. */ public boolean isReadOnly() { diff --git a/src/org/apollo/fs/archive/Archive.java b/src/org/apollo/fs/archive/Archive.java index 76448df9..dcd6fee5 100644 --- a/src/org/apollo/fs/archive/Archive.java +++ b/src/org/apollo/fs/archive/Archive.java @@ -9,14 +9,14 @@ import org.apollo.util.CompressionUtil; /** * Represents an archive. - * + * * @author Graham */ public final class Archive { /** * Decodes the archive in the specified buffer. - * + * * @param buffer The buffer. * @return The archive. * @throws IOException If there is an error decompressing the archive. @@ -72,7 +72,7 @@ public final class Archive { /** * Creates a new archive. - * + * * @param entries The entries in this archive. */ public Archive(ArchiveEntry[] entries) { @@ -81,7 +81,7 @@ public final class Archive { /** * Gets an {@link ArchiveEntry} by its name. - * + * * @param name The name. * @return The entry. * @throws FileNotFoundException If the entry could not be found. @@ -99,7 +99,7 @@ public final class Archive { /** * Hashes the specified string into an integer used to identify an {@link ArchiveEntry}. - * + * * @param name The name of the entry. * @return The hash. */ diff --git a/src/org/apollo/fs/archive/ArchiveEntry.java b/src/org/apollo/fs/archive/ArchiveEntry.java index a8a9ffbf..253987c8 100644 --- a/src/org/apollo/fs/archive/ArchiveEntry.java +++ b/src/org/apollo/fs/archive/ArchiveEntry.java @@ -4,7 +4,7 @@ import java.nio.ByteBuffer; /** * Represents a single entry in an {@link Archive}. - * + * * @author Graham */ public final class ArchiveEntry { @@ -21,7 +21,7 @@ public final class ArchiveEntry { /** * Creates a new archive entry. - * + * * @param identifier The identifier. * @param buffer The buffer. */ @@ -32,7 +32,7 @@ public final class ArchiveEntry { /** * Gets the buffer of this entry. - * + * * @return This buffer of this entry. */ public ByteBuffer getBuffer() { @@ -41,7 +41,7 @@ public final class ArchiveEntry { /** * Gets the identifier of this entry. - * + * * @return The identifier of this entry. */ public int getIdentifier() { diff --git a/src/org/apollo/fs/decoder/GameObjectDecoder.java b/src/org/apollo/fs/decoder/GameObjectDecoder.java index d7ec481a..fbb3583f 100644 --- a/src/org/apollo/fs/decoder/GameObjectDecoder.java +++ b/src/org/apollo/fs/decoder/GameObjectDecoder.java @@ -26,7 +26,7 @@ import com.google.common.collect.Iterables; /** * Parses static object definitions, which include map tiles and landscapes. - * + * * @author Ryley * @author Major */ @@ -59,7 +59,7 @@ public final class GameObjectDecoder { /** * Creates the GameObjectDecoder. - * + * * @param fs The {@link IndexedFileSystem}. * @param regions The {@link RegionRepository}. */ @@ -70,7 +70,7 @@ public final class GameObjectDecoder { /** * Decodes the GameObjects from their MapDefinitions. - * + * * @param world The {@link World} containing the StaticGameObjects. * @return The decoded objects. * @throws IOException If there is an error decoding the {@link MapDefinition}s. @@ -99,7 +99,7 @@ public final class GameObjectDecoder { /** * Blocks tiles covered by a GameObject, if applicable. - * + * * @param object The {@link GameObject}. * @param position The position of the GameObject. */ @@ -133,7 +133,7 @@ public final class GameObjectDecoder { if (block) { for (int dx = 0; dx < definition.getWidth(); dx++) { for (int dy = 0; dy < definition.getLength(); dy++) { - int localX = (x % Region.SIZE) + dx, localY = (y % Region.SIZE) + dy; + int localX = x % Region.SIZE + dx, localY = y % Region.SIZE + dy; if (localX > 7 || localY > 7) { int nextLocalX = localX > 7 ? x + localX - 7 : x + localX; @@ -141,11 +141,13 @@ public final class GameObjectDecoder { Position nextPosition = new Position(nextLocalX, nextLocalY); Region next = regions.fromPosition(nextPosition); - int nextX = (nextPosition.getX() % Region.SIZE) + dx, nextY = (nextPosition.getY() % Region.SIZE) + dy; - if (nextX > 7) + int nextX = nextPosition.getX() % Region.SIZE + dx, nextY = nextPosition.getY() % Region.SIZE + dy; + if (nextX > 7) { nextX -= 7; - if (nextY > 7) + } + if (nextY > 7) { nextY -= 7; + } next.getMatrix(height).block(nextX, nextY); continue; @@ -159,7 +161,7 @@ public final class GameObjectDecoder { /** * Decodes the attributes of a terrain file, blocking the tile if necessary. - * + * * @param attributes The terrain attributes. * @param position The {@link Position} of the tile whose attributes are being decoded. */ @@ -181,14 +183,14 @@ public final class GameObjectDecoder { } if (block) { - int localX = (x % Region.SIZE), localY = (y % Region.SIZE); + int localX = x % Region.SIZE, localY = y % Region.SIZE; current.block(localX, localY); } } /** * Decodes object data stored in the specified {@link ByteBuffer}. - * + * * @param world The {@link World} containing the StaticGameObjects. * @param buffer The ByteBuffer. * @param x The x coordinate of the top left tile of the map file. @@ -209,7 +211,7 @@ public final class GameObjectDecoder { int localY = packed & 0x3F; int localX = packed >> 6 & 0x3F; - int height = (packed >> 12) & 0x3; + int height = packed >> 12 & 0x3; int attributes = buffer.get() & 0xFF; int type = attributes >> 2; @@ -229,7 +231,7 @@ public final class GameObjectDecoder { /** * Decodes terrain data stored in the specified {@link ByteBuffer}. - * + * * @param buffer The ByteBuffer. * @param x The x coordinate of the top left tile of the map file. * @param y The y coordinate of the top left tile of the map file. diff --git a/src/org/apollo/fs/decoder/ItemDefinitionDecoder.java b/src/org/apollo/fs/decoder/ItemDefinitionDecoder.java index 9124041f..7596e74d 100644 --- a/src/org/apollo/fs/decoder/ItemDefinitionDecoder.java +++ b/src/org/apollo/fs/decoder/ItemDefinitionDecoder.java @@ -10,7 +10,7 @@ import org.apollo.util.BufferUtil; /** * Decodes item data from the {@code obj.dat} file into {@link ItemDefinition}s. - * + * * @author Graham */ public final class ItemDefinitionDecoder { @@ -22,7 +22,7 @@ public final class ItemDefinitionDecoder { /** * Creates the item definition decoder. - * + * * @param fs The indexed file system. */ public ItemDefinitionDecoder(IndexedFileSystem fs) { @@ -31,7 +31,7 @@ public final class ItemDefinitionDecoder { /** * Decodes the item definitions. - * + * * @return The item definitions. * @throws IOException If an I/O error occurs. */ @@ -58,7 +58,7 @@ public final class ItemDefinitionDecoder { /** * Decodes a single definition. - * + * * @param id The item's id. * @param buffer The buffer. * @return The {@link ItemDefinition}. diff --git a/src/org/apollo/fs/decoder/MapFileDecoder.java b/src/org/apollo/fs/decoder/MapFileDecoder.java index 56be7d18..44e8ee96 100644 --- a/src/org/apollo/fs/decoder/MapFileDecoder.java +++ b/src/org/apollo/fs/decoder/MapFileDecoder.java @@ -12,7 +12,7 @@ import org.apollo.game.model.area.Region; /** * Decodes {@link MapDefinition}s from the {@link IndexedFileSystem}. - * + * * @author Ryley * @author Major */ @@ -82,7 +82,7 @@ public final class MapFileDecoder { /** * Creates the {@link MapDefinition}. - * + * * @param packedCoordinates The packed coordinates. * @param terrain The terrain file id. * @param objects The object file id. @@ -97,7 +97,7 @@ public final class MapFileDecoder { /** * Gets the packed coordinates. - * + * * @return The packed coordinates. */ public int getPackedCoordinates() { @@ -106,7 +106,7 @@ public final class MapFileDecoder { /** * Gets the id of the file containing the terrain data. - * + * * @return The file id. */ public int getTerrainFile() { @@ -115,7 +115,7 @@ public final class MapFileDecoder { /** * Gets the id of the file containing the object data. - * + * * @return The file id. */ public int getObjectFile() { @@ -124,7 +124,7 @@ public final class MapFileDecoder { /** * Returns whether or not this MapDefinition is for a members-only area of the world. - * + * * @return {@code true} if this MapDefinition is for a members-only area, {@code false} if not. */ public boolean isMembersOnly() { diff --git a/src/org/apollo/fs/decoder/NpcDefinitionDecoder.java b/src/org/apollo/fs/decoder/NpcDefinitionDecoder.java index 743a2342..c7244b04 100644 --- a/src/org/apollo/fs/decoder/NpcDefinitionDecoder.java +++ b/src/org/apollo/fs/decoder/NpcDefinitionDecoder.java @@ -11,7 +11,7 @@ import org.apollo.util.BufferUtil; /** * Decodes npc data from the {@code npc.dat} file into {@link NpcDefinition}s. - * + * * @author Major */ public final class NpcDefinitionDecoder { @@ -23,7 +23,7 @@ public final class NpcDefinitionDecoder { /** * Creates the npc definition decoder. - * + * * @param fs The indexed file system. */ public NpcDefinitionDecoder(IndexedFileSystem fs) { @@ -32,7 +32,7 @@ public final class NpcDefinitionDecoder { /** * Decodes the npc definitions. - * + * * @return An array of all parsed npc definitions. * @throws IOException If an I/O error occurs. */ @@ -59,7 +59,7 @@ public final class NpcDefinitionDecoder { /** * Decodes a single definition. - * + * * @param id The npc's id. * @param buffer The buffer. * @return The {@link NpcDefinition}. @@ -121,24 +121,20 @@ public final class NpcDefinitionDecoder { } else if (opcode == 102 || opcode == 103) { buffer.getShort(); } else if (opcode == 106) { - @SuppressWarnings("unused") - int morphVariableBitsIndex = wrap(buffer.getShort()); - @SuppressWarnings("unused") - int morphismCount = wrap(buffer.getShort()); + wrap(buffer.getShort()); + wrap(buffer.getShort()); int count = buffer.get() & 0xFF; int[] morphisms = new int[count + 1]; Arrays.setAll(morphisms, index -> wrap(buffer.getShort())); } else if (opcode == 107) { - @SuppressWarnings("unused") - boolean clickable = false; } } } /** * Wraps a morphism value around, returning -1 if the specified value is 65,535. - * + * * @param value The value. * @return -1 if {@code value} is 65,535, otherwise {@code value}. */ diff --git a/src/org/apollo/fs/decoder/ObjectDefinitionDecoder.java b/src/org/apollo/fs/decoder/ObjectDefinitionDecoder.java index ac998c30..fe231040 100644 --- a/src/org/apollo/fs/decoder/ObjectDefinitionDecoder.java +++ b/src/org/apollo/fs/decoder/ObjectDefinitionDecoder.java @@ -10,7 +10,7 @@ import org.apollo.util.BufferUtil; /** * Decodes object data from the {@code loc.dat} file into {@link ObjectDefinition}s. - * + * * @author Major */ public final class ObjectDefinitionDecoder { @@ -22,7 +22,7 @@ public final class ObjectDefinitionDecoder { /** * Creates the decoder. - * + * * @param fs The {@link IndexedFileSystem}. */ public ObjectDefinitionDecoder(IndexedFileSystem fs) { @@ -31,7 +31,7 @@ public final class ObjectDefinitionDecoder { /** * Decodes all of the data into {@link ObjectDefinition}s. - * + * * @return The definitions. * @throws IOException If an error occurs when decoding the archive or finding an entry. */ @@ -57,7 +57,7 @@ public final class ObjectDefinitionDecoder { /** * Decodes data from the cache into an {@link ObjectDefinition}. - * + * * @param id The id of the object. * @param data The {@link ByteBuffer} containing the data. * @return The object definition. diff --git a/src/org/apollo/game/GameConstants.java b/src/org/apollo/game/GameConstants.java index 270427d2..f44f7497 100644 --- a/src/org/apollo/game/GameConstants.java +++ b/src/org/apollo/game/GameConstants.java @@ -2,7 +2,7 @@ package org.apollo.game; /** * Contains game-related constants. - * + * * @author Graham */ public final class GameConstants { diff --git a/src/org/apollo/game/GamePulseHandler.java b/src/org/apollo/game/GamePulseHandler.java index 2222cda0..d9ba67a2 100644 --- a/src/org/apollo/game/GamePulseHandler.java +++ b/src/org/apollo/game/GamePulseHandler.java @@ -5,7 +5,7 @@ import java.util.logging.Logger; /** * A class which handles the logic for each pulse of the {@link GameService}. - * + * * @author Graham */ public final class GamePulseHandler implements Runnable { @@ -22,7 +22,7 @@ public final class GamePulseHandler implements Runnable { /** * Creates the game pulse handler object. - * + * * @param service The {@link GameService}. */ protected GamePulseHandler(GameService service) { diff --git a/src/org/apollo/game/GameService.java b/src/org/apollo/game/GameService.java index b85a7b91..7424b81a 100644 --- a/src/org/apollo/game/GameService.java +++ b/src/org/apollo/game/GameService.java @@ -28,7 +28,7 @@ import com.google.common.util.concurrent.ThreadFactoryBuilder; /** * The {@link GameService} class schedules and manages the execution of the {@link GamePulseHandler} class. - * + * * @author Graham */ public final class GameService extends Service { @@ -61,7 +61,7 @@ public final class GameService extends Service { /** * Creates the GameService. - * + * * @param world The {@link World} the GameService is for. * @throws Exception If an error occurs during initialization. */ @@ -72,7 +72,7 @@ public final class GameService extends Service { /** * Finalizes the unregistration of a player. - * + * * @param player The player. */ public void finalizePlayerUnregistration(Player player) { @@ -83,7 +83,7 @@ public final class GameService extends Service { /** * Gets the MessageHandlerChainSet - * + * * @return The set of MessageHandlerChain's. */ public MessageHandlerChainSet getMessageHandlerChainSet() { @@ -112,7 +112,7 @@ public final class GameService extends Service { /** * Registers a {@link Player} (may block!). - * + * * @param player The Player. * @param session The {@link GameSession} of the Player. * @return A {@link RegistrationStatus}. @@ -133,7 +133,7 @@ public final class GameService extends Service { /** * Shuts down this game service. - * + * * @param natural Whether or not the shutdown was expected. */ public void shutdown(boolean natural) { @@ -148,7 +148,7 @@ public final class GameService extends Service { /** * Unregisters a player. Returns immediately. The player is unregistered at the start of the next cycle. - * + * * @param player The player. */ public void unregisterPlayer(Player player) { @@ -173,7 +173,7 @@ public final class GameService extends Service { /** * Initializes the game service. - * + * * @throws IOException If there is an error accessing the file. * @throws SAXException If there is an error parsing the file. * @throws ReflectiveOperationException If a MessageHandler could not be created. diff --git a/src/org/apollo/game/action/Action.java b/src/org/apollo/game/action/Action.java index 20b56023..6702bae6 100644 --- a/src/org/apollo/game/action/Action.java +++ b/src/org/apollo/game/action/Action.java @@ -9,7 +9,7 @@ import org.apollo.game.scheduling.ScheduledTask; * ALL actions MUST implement the {@link #equals(Object)} method. This is to check if * two actions are identical: if they are, then the new action does not replace the old one (so spam/accidental clicking * won't cancel your action, and start another from scratch). - * + * * @author Graham * @param The type of mob. */ @@ -27,7 +27,7 @@ public abstract class Action extends ScheduledTask { /** * Creates a new action. - * + * * @param delay The delay in pulses. * @param immediate A flag indicating if the action should happen immediately. * @param mob The mob performing the action. @@ -39,7 +39,7 @@ public abstract class Action extends ScheduledTask { /** * Gets the mob which performed the action. - * + * * @return The mob. */ public final T getMob() { diff --git a/src/org/apollo/game/action/DistancedAction.java b/src/org/apollo/game/action/DistancedAction.java index 83b69c26..d626106a 100644 --- a/src/org/apollo/game/action/DistancedAction.java +++ b/src/org/apollo/game/action/DistancedAction.java @@ -5,7 +5,7 @@ import org.apollo.game.model.entity.Mob; /** * An @{link Action} which fires when a distance requirement is met. - * + * * @author Blake * @author Graham * @param The type of {@link Mob}. @@ -39,7 +39,7 @@ public abstract class DistancedAction extends Action { /** * Creates a new DistancedAction. - * + * * @param delay The delay between executions once the distance threshold is reached. * @param immediate Whether or not this action fires immediately after the distance threshold is reached. * @param mob The mob. diff --git a/src/org/apollo/game/command/Command.java b/src/org/apollo/game/command/Command.java index b5bf90b4..70eb8f3e 100644 --- a/src/org/apollo/game/command/Command.java +++ b/src/org/apollo/game/command/Command.java @@ -2,7 +2,7 @@ package org.apollo.game.command; /** * Represents a command. - * + * * @author Graham */ public final class Command { @@ -19,7 +19,7 @@ public final class Command { /** * Creates the command. - * + * * @param name The name of the command. * @param arguments The command's arguments. */ @@ -30,7 +30,7 @@ public final class Command { /** * Gets the command's arguments. - * + * * @return The command's arguments. */ public String[] getArguments() { @@ -39,7 +39,7 @@ public final class Command { /** * Gets the name of the command. - * + * * @return The name of the command. */ public String getName() { diff --git a/src/org/apollo/game/command/CommandDispatcher.java b/src/org/apollo/game/command/CommandDispatcher.java index 2dbeb852..70c76962 100644 --- a/src/org/apollo/game/command/CommandDispatcher.java +++ b/src/org/apollo/game/command/CommandDispatcher.java @@ -8,7 +8,7 @@ import org.apollo.game.model.entity.Player; /** * A class that dispatches {@link Command}s to {@link CommandListener}s. - * + * * @author Graham */ public final class CommandDispatcher { @@ -20,7 +20,7 @@ public final class CommandDispatcher { /** * Initialises this CommandDispatcher. - * + * * @param authors The {@link Set} of plugin authors. */ public void init(Set authors) { @@ -29,7 +29,7 @@ public final class CommandDispatcher { /** * Dispatches a command to the appropriate listener. - * + * * @param player The player. * @param command The command. */ @@ -42,7 +42,7 @@ public final class CommandDispatcher { /** * Registers a listener with the dispatcher. - * + * * @param command The command's name. * @param listener The listener. */ diff --git a/src/org/apollo/game/command/CommandListener.java b/src/org/apollo/game/command/CommandListener.java index 97202fa1..68e6a5c5 100644 --- a/src/org/apollo/game/command/CommandListener.java +++ b/src/org/apollo/game/command/CommandListener.java @@ -5,7 +5,7 @@ import org.apollo.game.model.entity.setting.PrivilegeLevel; /** * An interface which should be implemented to listen to {@link Command}s. - * + * * @author Graham * @author Major */ @@ -25,7 +25,7 @@ public abstract class CommandListener { /** * Creates a new command listener. - * + * * @param level The required {@link PrivilegeLevel}. */ public CommandListener(PrivilegeLevel level) { @@ -34,7 +34,7 @@ public abstract class CommandListener { /** * Executes the action for this command. - * + * * @param player The player. * @param command The command. */ @@ -42,7 +42,7 @@ public abstract class CommandListener { /** * Executes a privileged command. - * + * * @param player The player. * @param command The command. */ diff --git a/src/org/apollo/game/command/CreditsCommandListener.java b/src/org/apollo/game/command/CreditsCommandListener.java index 0983b36f..1363bf62 100644 --- a/src/org/apollo/game/command/CreditsCommandListener.java +++ b/src/org/apollo/game/command/CreditsCommandListener.java @@ -10,16 +10,16 @@ import com.google.common.collect.ImmutableSet; /** * Implements a {@code ::credits} command that lists the authors of all plugins used in the server. - * + * * @author Graham */ public final class CreditsCommandListener extends CommandListener { - + /** * The Set of authors. */ private final Set authors; - + /** * Creates the CreditsCommandListener. * diff --git a/src/org/apollo/game/message/Message.java b/src/org/apollo/game/message/Message.java index 13b0c59f..4c863efa 100644 --- a/src/org/apollo/game/message/Message.java +++ b/src/org/apollo/game/message/Message.java @@ -2,7 +2,7 @@ package org.apollo.game.message; /** * A message sent by the client that can be intercepted. - * + * * @author Graham * @author Major */ @@ -22,7 +22,7 @@ public abstract class Message { /** * Returns whether or not the Message chain has been terminated. - * + * * @return {@code true} if the Message chain has been terminated, otherwise {@code false}. */ public final boolean terminated() { diff --git a/src/org/apollo/game/message/MessageHandler.java b/src/org/apollo/game/message/MessageHandler.java index ec787281..4b8a1218 100644 --- a/src/org/apollo/game/message/MessageHandler.java +++ b/src/org/apollo/game/message/MessageHandler.java @@ -5,7 +5,7 @@ import org.apollo.game.model.entity.Player; /** * Listens for {@link Message}s received from the client. - * + * * @author Graham * @author Ryley * @param The type of Message this class is listening for. @@ -28,7 +28,7 @@ public abstract class MessageHandler { /** * Handles the Message that was received. - * + * * @param player The player to handle the Message for. * @param message The Message. */ diff --git a/src/org/apollo/game/message/MessageHandlerChain.java b/src/org/apollo/game/message/MessageHandlerChain.java index 413a4ecf..767242ea 100644 --- a/src/org/apollo/game/message/MessageHandlerChain.java +++ b/src/org/apollo/game/message/MessageHandlerChain.java @@ -9,7 +9,7 @@ import com.google.common.base.MoreObjects; /** * A chain of {@link MessageHandler}s - * + * * @author Graham * @author Ryley * @param The Message type this chain represents. @@ -28,7 +28,7 @@ public final class MessageHandlerChain { /** * Constructs a new {@link MessageHandlerChain}. - * + * * @param type The Class type of this chain. */ public MessageHandlerChain(Class type) { @@ -37,7 +37,7 @@ public final class MessageHandlerChain { /** * Adds the specified {@link MessageHandler} to this chain. - * + * * @param handler The MessageHandler. */ public void addHandler(MessageHandler handler) { @@ -46,7 +46,7 @@ public final class MessageHandlerChain { /** * Notifies each {@link MessageHandler} in this chain that a {@link Message} has been received. - * + * * @param player The Player to handle this message for. * @param message The Message. * @return {@code true} if and only if the Message propagated down the chain without being terminated, otherwise diff --git a/src/org/apollo/game/message/MessageHandlerChainSet.java b/src/org/apollo/game/message/MessageHandlerChainSet.java index 5f2f5582..c1a80a5f 100644 --- a/src/org/apollo/game/message/MessageHandlerChainSet.java +++ b/src/org/apollo/game/message/MessageHandlerChainSet.java @@ -7,7 +7,7 @@ import org.apollo.game.model.entity.Player; /** * A group of {@link MessageHandlerChain}s classified by the {@link Message} type. - * + * * @author Graham * @author Ryley * @author Major @@ -21,7 +21,7 @@ public final class MessageHandlerChainSet { /** * Notifies the appropriate {@link MessageHandlerChain} that a {@link Message} has been received. - * + * * @param message The Message. * @return {@code true} if the Message propagated down the chain without being terminated or if the chain for the * Message was not found, otherwise {@code false}. @@ -29,12 +29,12 @@ public final class MessageHandlerChainSet { public boolean notify(Player player, M message) { @SuppressWarnings("unchecked") MessageHandlerChain chain = (MessageHandlerChain) chains.get(message.getClass()); - return (chain == null) || chain.notify(player, message); + return chain == null || chain.notify(player, message); } /** * Places the {@link MessageHandlerChain} into this set. - * + * * @param clazz The {@link Class} to associate the MessageHandlerChain with. * @param handler The MessageHandlerChain. */ diff --git a/src/org/apollo/game/message/handler/BankButtonMessageHandler.java b/src/org/apollo/game/message/handler/BankButtonMessageHandler.java index 730b4e3e..27f122f3 100644 --- a/src/org/apollo/game/message/handler/BankButtonMessageHandler.java +++ b/src/org/apollo/game/message/handler/BankButtonMessageHandler.java @@ -7,7 +7,7 @@ import org.apollo.game.model.entity.Player; /** * A {@link MessageHandler} that responds to {@link ButtonMessage}s for withdrawing items as notes. - * + * * @author Graham */ public final class BankButtonMessageHandler extends MessageHandler { diff --git a/src/org/apollo/game/message/handler/BankMessageHandler.java b/src/org/apollo/game/message/handler/BankMessageHandler.java index f6c7d7a3..8b8c87c2 100644 --- a/src/org/apollo/game/message/handler/BankMessageHandler.java +++ b/src/org/apollo/game/message/handler/BankMessageHandler.java @@ -12,14 +12,14 @@ import org.apollo.game.model.inter.bank.BankWithdrawEnterAmountListener; /** * A {@link MessageHandler} that handles withdrawing and depositing items from/to a player's bank. - * + * * @author Graham */ public final class BankMessageHandler extends MessageHandler { /** * Converts an option to an amount. - * + * * @param option The option. * @return The amount. * @throws IllegalArgumentException If the option is invalid. @@ -63,7 +63,7 @@ public final class BankMessageHandler extends MessageHandler /** * Handles a deposit action. - * + * * @param player The player. * @param message The message. */ @@ -80,7 +80,7 @@ public final class BankMessageHandler extends MessageHandler /** * Handles a withdraw action. - * + * * @param player The player. * @param message The message. */ diff --git a/src/org/apollo/game/message/handler/ChatMessageHandler.java b/src/org/apollo/game/message/handler/ChatMessageHandler.java index a8bdaf4c..0432075d 100644 --- a/src/org/apollo/game/message/handler/ChatMessageHandler.java +++ b/src/org/apollo/game/message/handler/ChatMessageHandler.java @@ -8,7 +8,7 @@ import org.apollo.game.sync.block.SynchronizationBlock; /** * A {@link MessageHandler} that broadcasts public chat messages. - * + * * @author Graham */ public final class ChatMessageHandler extends MessageHandler { diff --git a/src/org/apollo/game/message/handler/ChatVerificationHandler.java b/src/org/apollo/game/message/handler/ChatVerificationHandler.java index 7b0a8902..c0ddb3b2 100644 --- a/src/org/apollo/game/message/handler/ChatVerificationHandler.java +++ b/src/org/apollo/game/message/handler/ChatVerificationHandler.java @@ -7,7 +7,7 @@ import org.apollo.game.model.entity.Player; /** * A {@link MessageHandler} that verifies {@link ChatMessage}s. - * + * * @author Graham */ public final class ChatVerificationHandler extends MessageHandler { diff --git a/src/org/apollo/game/message/handler/ClosedInterfaceMessageHandler.java b/src/org/apollo/game/message/handler/ClosedInterfaceMessageHandler.java index 50dbacff..03f53067 100644 --- a/src/org/apollo/game/message/handler/ClosedInterfaceMessageHandler.java +++ b/src/org/apollo/game/message/handler/ClosedInterfaceMessageHandler.java @@ -7,7 +7,7 @@ import org.apollo.game.model.entity.Player; /** * A {@link MessageHandler} for the {@link ClosedInterfaceMessage}. - * + * * @author Graham */ public final class ClosedInterfaceMessageHandler extends MessageHandler { diff --git a/src/org/apollo/game/message/handler/CommandMessageHandler.java b/src/org/apollo/game/message/handler/CommandMessageHandler.java index 7f1983e5..64f729b3 100644 --- a/src/org/apollo/game/message/handler/CommandMessageHandler.java +++ b/src/org/apollo/game/message/handler/CommandMessageHandler.java @@ -9,7 +9,7 @@ import org.apollo.game.model.entity.Player; /** * A {@link MessageHandler} that dispatches {@link CommandMessage}s. - * + * * @author Graham */ public final class CommandMessageHandler extends MessageHandler { diff --git a/src/org/apollo/game/message/handler/DialogueButtonHandler.java b/src/org/apollo/game/message/handler/DialogueButtonHandler.java index f348f990..b5497289 100644 --- a/src/org/apollo/game/message/handler/DialogueButtonHandler.java +++ b/src/org/apollo/game/message/handler/DialogueButtonHandler.java @@ -9,7 +9,7 @@ import org.apollo.game.model.inter.InterfaceType; /** * A {@link MessageHandler} which intercepts button clicks on dialogues, and forwards the message to the current * listener. - * + * * @author Chris Fletcher */ public final class DialogueButtonHandler extends MessageHandler { diff --git a/src/org/apollo/game/message/handler/DialogueContinueMessageHandler.java b/src/org/apollo/game/message/handler/DialogueContinueMessageHandler.java index afdb57a9..99a57d51 100644 --- a/src/org/apollo/game/message/handler/DialogueContinueMessageHandler.java +++ b/src/org/apollo/game/message/handler/DialogueContinueMessageHandler.java @@ -8,7 +8,7 @@ import org.apollo.game.model.inter.InterfaceType; /** * A {@link MessageHandler} for the {@link DialogueContinueMessage}. - * + * * @author Chris Fletcher */ public final class DialogueContinueMessageHandler extends MessageHandler { diff --git a/src/org/apollo/game/message/handler/EnteredAmountMessageHandler.java b/src/org/apollo/game/message/handler/EnteredAmountMessageHandler.java index 6e9d2117..9ba5bf99 100644 --- a/src/org/apollo/game/message/handler/EnteredAmountMessageHandler.java +++ b/src/org/apollo/game/message/handler/EnteredAmountMessageHandler.java @@ -7,7 +7,7 @@ import org.apollo.game.model.entity.Player; /** * A {@link MessageHandler} for the {@link EnteredAmountMessage}. - * + * * @author Graham */ public final class EnteredAmountMessageHandler extends MessageHandler { diff --git a/src/org/apollo/game/message/handler/EquipItemHandler.java b/src/org/apollo/game/message/handler/EquipItemHandler.java index c9441c2e..c7d3e81e 100644 --- a/src/org/apollo/game/message/handler/EquipItemHandler.java +++ b/src/org/apollo/game/message/handler/EquipItemHandler.java @@ -14,13 +14,13 @@ import org.apollo.util.LanguageUtil; /** * A {@link MessageHandler} that equips items. - * + * * @author Major * @author Graham * @author Ryley */ public final class EquipItemHandler extends MessageHandler { - + /** * The option used when equipping an item. */ @@ -98,8 +98,7 @@ public final class EquipItemHandler extends MessageHandler { return; } - if (definition.getSlot() == EquipmentConstants.SHIELD && weapon != null - && EquipmentDefinition.lookup(weapon.getId()).isTwoHanded()) { + if (definition.getSlot() == EquipmentConstants.SHIELD && weapon != null && EquipmentDefinition.lookup(weapon.getId()).isTwoHanded()) { equipment.set(EquipmentConstants.SHIELD, inventory.reset(inventorySlot)); inventory.add(equipment.reset(EquipmentConstants.WEAPON)); return; diff --git a/src/org/apollo/game/message/handler/ItemOnItemVerificationHandler.java b/src/org/apollo/game/message/handler/ItemOnItemVerificationHandler.java index fe202073..596d65f1 100644 --- a/src/org/apollo/game/message/handler/ItemOnItemVerificationHandler.java +++ b/src/org/apollo/game/message/handler/ItemOnItemVerificationHandler.java @@ -11,7 +11,7 @@ import org.apollo.game.model.inv.SynchronizationInventoryListener; /** * A {@link MessageHandler} that verifies the target item in {@link ItemOnItemMessage}s. - * + * * @author Chris Fletcher */ public final class ItemOnItemVerificationHandler extends MessageHandler { diff --git a/src/org/apollo/game/message/handler/ItemOnObjectVerificationHandler.java b/src/org/apollo/game/message/handler/ItemOnObjectVerificationHandler.java index 33e530f8..ea543d69 100644 --- a/src/org/apollo/game/message/handler/ItemOnObjectVerificationHandler.java +++ b/src/org/apollo/game/message/handler/ItemOnObjectVerificationHandler.java @@ -11,7 +11,7 @@ import org.apollo.game.model.inv.SynchronizationInventoryListener; /** * A {@link MessageHandler} that verifies {@link ItemOnObjectMessage}s. - * + * * @author Major */ public final class ItemOnObjectVerificationHandler extends MessageHandler { @@ -27,8 +27,7 @@ public final class ItemOnObjectVerificationHandler extends MessageHandleriff the specified id does not already have a mapping. - * + * * @param id The id of the interface. * @param supplier The {@link InventorySupplier}. */ diff --git a/src/org/apollo/game/message/handler/ObjectActionVerificationHandler.java b/src/org/apollo/game/message/handler/ObjectActionVerificationHandler.java index e9b2bd3f..a7b37c9f 100644 --- a/src/org/apollo/game/message/handler/ObjectActionVerificationHandler.java +++ b/src/org/apollo/game/message/handler/ObjectActionVerificationHandler.java @@ -15,14 +15,14 @@ import org.apollo.game.model.entity.obj.GameObject; /** * A verification {@link MessageHandler} for the {@link ObjectActionMessage}. - * + * * @author Major */ public final class ObjectActionVerificationHandler extends MessageHandler { /** * Indicates whether or not the {@link List} of {@link GameObject}s contains the object with the specified id. - * + * * @param id The id of the object. * @param objects The list of objects. * @return {@code true} if the list does contain the object with the specified id, otherwise {@code false}. diff --git a/src/org/apollo/game/message/handler/PlayerActionVerificationHandler.java b/src/org/apollo/game/message/handler/PlayerActionVerificationHandler.java index 25020c45..b1fa3ee8 100644 --- a/src/org/apollo/game/message/handler/PlayerActionVerificationHandler.java +++ b/src/org/apollo/game/message/handler/PlayerActionVerificationHandler.java @@ -8,7 +8,7 @@ import org.apollo.util.MobRepository; /** * A verification {@link MessageHandler} for the {@link PlayerActionMessage}. - * + * * @author Major */ public final class PlayerActionVerificationHandler extends MessageHandler { diff --git a/src/org/apollo/game/message/handler/PlayerDesignMessageHandler.java b/src/org/apollo/game/message/handler/PlayerDesignMessageHandler.java index 2df3b92b..df5ad3d6 100644 --- a/src/org/apollo/game/message/handler/PlayerDesignMessageHandler.java +++ b/src/org/apollo/game/message/handler/PlayerDesignMessageHandler.java @@ -8,7 +8,7 @@ import org.apollo.game.model.entity.Player; /** * A {@link MessageHandler} that handles {@link PlayerDesignMessage}s. - * + * * @author Graham */ public final class PlayerDesignMessageHandler extends MessageHandler { diff --git a/src/org/apollo/game/message/handler/PlayerDesignVerificationHandler.java b/src/org/apollo/game/message/handler/PlayerDesignVerificationHandler.java index 84d2b2e5..5e6bc704 100644 --- a/src/org/apollo/game/message/handler/PlayerDesignVerificationHandler.java +++ b/src/org/apollo/game/message/handler/PlayerDesignVerificationHandler.java @@ -9,7 +9,7 @@ import org.apollo.game.model.entity.setting.Gender; /** * A {@link MessageHandler} that verifies {@link PlayerDesignMessage}s. - * + * * @author Graham */ public final class PlayerDesignVerificationHandler extends MessageHandler { @@ -32,7 +32,7 @@ public final class PlayerDesignVerificationHandler extends MessageHandler { diff --git a/src/org/apollo/game/message/handler/WalkMessageHandler.java b/src/org/apollo/game/message/handler/WalkMessageHandler.java index 903d4b9a..707385a4 100644 --- a/src/org/apollo/game/message/handler/WalkMessageHandler.java +++ b/src/org/apollo/game/message/handler/WalkMessageHandler.java @@ -9,7 +9,7 @@ import org.apollo.game.model.entity.WalkingQueue; /** * A {@link MessageHandler} that handles {@link WalkMessage}s. - * + * * @author Graham */ public final class WalkMessageHandler extends MessageHandler { diff --git a/src/org/apollo/game/message/impl/AddFriendMessage.java b/src/org/apollo/game/message/impl/AddFriendMessage.java index 19c888bb..13d6452d 100644 --- a/src/org/apollo/game/message/impl/AddFriendMessage.java +++ b/src/org/apollo/game/message/impl/AddFriendMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent by the client when a player adds someone to their friends list. - * + * * @author Major */ public final class AddFriendMessage extends Message { @@ -16,7 +16,7 @@ public final class AddFriendMessage extends Message { /** * Creates a new befriend user message. - * + * * @param username The befriended player's username. */ public AddFriendMessage(String username) { @@ -25,7 +25,7 @@ public final class AddFriendMessage extends Message { /** * Gets the username of the befriended player. - * + * * @return The username. */ public String getUsername() { diff --git a/src/org/apollo/game/message/impl/AddIgnoreMessage.java b/src/org/apollo/game/message/impl/AddIgnoreMessage.java index 7c825df8..6cc43091 100644 --- a/src/org/apollo/game/message/impl/AddIgnoreMessage.java +++ b/src/org/apollo/game/message/impl/AddIgnoreMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent by the client when a player adds someone to their ignore list. - * + * * @author Major */ public final class AddIgnoreMessage extends Message { @@ -16,7 +16,7 @@ public final class AddIgnoreMessage extends Message { /** * Creates a new ignore player message. - * + * * @param username The ignored player's username. */ public AddIgnoreMessage(String username) { @@ -25,7 +25,7 @@ public final class AddIgnoreMessage extends Message { /** * Gets the username of the ignored player. - * + * * @return The username. */ public String getUsername() { diff --git a/src/org/apollo/game/message/impl/ArrowKeyMessage.java b/src/org/apollo/game/message/impl/ArrowKeyMessage.java index 5db0efda..99df8bd9 100644 --- a/src/org/apollo/game/message/impl/ArrowKeyMessage.java +++ b/src/org/apollo/game/message/impl/ArrowKeyMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent by the client when the user has pressed an arrow key. - * + * * @author Major */ public final class ArrowKeyMessage extends Message { @@ -21,7 +21,7 @@ public final class ArrowKeyMessage extends Message { /** * Creates a new arrow key message. - * + * * @param roll The camera roll. * @param yaw The camera yaw. */ @@ -32,7 +32,7 @@ public final class ArrowKeyMessage extends Message { /** * Gets the roll of the camera. - * + * * @return The roll. */ public int getRoll() { @@ -41,7 +41,7 @@ public final class ArrowKeyMessage extends Message { /** * Gets the yaw of the camera. - * + * * @return The yaw. */ public int getYaw() { diff --git a/src/org/apollo/game/message/impl/ButtonMessage.java b/src/org/apollo/game/message/impl/ButtonMessage.java index 8de71050..36c20cae 100644 --- a/src/org/apollo/game/message/impl/ButtonMessage.java +++ b/src/org/apollo/game/message/impl/ButtonMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent by the client when a player clicks a button. - * + * * @author Graham */ public final class ButtonMessage extends Message { @@ -16,7 +16,7 @@ public final class ButtonMessage extends Message { /** * Creates the button message. - * + * * @param widgetId The widget id. */ public ButtonMessage(int widgetId) { @@ -25,7 +25,7 @@ public final class ButtonMessage extends Message { /** * Gets the widget id. - * + * * @return The widget id. */ public int getWidgetId() { diff --git a/src/org/apollo/game/message/impl/ChatMessage.java b/src/org/apollo/game/message/impl/ChatMessage.java index 8b6b3b56..164432de 100644 --- a/src/org/apollo/game/message/impl/ChatMessage.java +++ b/src/org/apollo/game/message/impl/ChatMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent by the client to send a public chat message to other players. - * + * * @author Graham */ public final class ChatMessage extends Message { @@ -31,7 +31,7 @@ public final class ChatMessage extends Message { /** * Creates a new chat message. - * + * * @param message The message. * @param compressedMessage The compressed message. * @param color The text color. @@ -46,7 +46,7 @@ public final class ChatMessage extends Message { /** * Gets the compressed message. - * + * * @return The compressed message. */ public byte[] getCompressedMessage() { @@ -55,7 +55,7 @@ public final class ChatMessage extends Message { /** * Gets the message. - * + * * @return The message. */ public String getMessage() { @@ -64,7 +64,7 @@ public final class ChatMessage extends Message { /** * Gets the text color. - * + * * @return The text color. */ public int getTextColor() { @@ -73,7 +73,7 @@ public final class ChatMessage extends Message { /** * Gets the text effects. - * + * * @return The text effects. */ public int getTextEffects() { diff --git a/src/org/apollo/game/message/impl/ClearRegionMessage.java b/src/org/apollo/game/message/impl/ClearRegionMessage.java index f37c127e..765266fb 100644 --- a/src/org/apollo/game/message/impl/ClearRegionMessage.java +++ b/src/org/apollo/game/message/impl/ClearRegionMessage.java @@ -23,7 +23,7 @@ public final class ClearRegionMessage extends Message { /** * Creates the ClearRegionMessage. - * + * * @param player The {@link Position} of the Player this {@link Message} is being sent to. * @param region The {@link RegionCoordinates} of the Region being cleared. */ @@ -34,7 +34,7 @@ public final class ClearRegionMessage extends Message { /** * Gets the {@link Position} of the Player this {@link Message} is being sent to.. - * + * * @return The Position. */ public Position getPlayerPosition() { @@ -43,7 +43,7 @@ public final class ClearRegionMessage extends Message { /** * Gets the {@link Position} of the Region being cleared. - * + * * @return The Position. */ public Position getRegionPosition() { diff --git a/src/org/apollo/game/message/impl/CloseInterfaceMessage.java b/src/org/apollo/game/message/impl/CloseInterfaceMessage.java index 79cba224..a0fc3c08 100644 --- a/src/org/apollo/game/message/impl/CloseInterfaceMessage.java +++ b/src/org/apollo/game/message/impl/CloseInterfaceMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent to the client that closes the open interface. - * + * * @author Graham */ public final class CloseInterfaceMessage extends Message { diff --git a/src/org/apollo/game/message/impl/ClosedInterfaceMessage.java b/src/org/apollo/game/message/impl/ClosedInterfaceMessage.java index 9b8c9348..89db7eea 100644 --- a/src/org/apollo/game/message/impl/ClosedInterfaceMessage.java +++ b/src/org/apollo/game/message/impl/ClosedInterfaceMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent by the client when the current interface is closed. - * + * * @author Graham */ public final class ClosedInterfaceMessage extends Message { diff --git a/src/org/apollo/game/message/impl/CommandMessage.java b/src/org/apollo/game/message/impl/CommandMessage.java index 977bf39a..11ff2912 100644 --- a/src/org/apollo/game/message/impl/CommandMessage.java +++ b/src/org/apollo/game/message/impl/CommandMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent by the client to send a {@code ::} command. - * + * * @author Graham */ public final class CommandMessage extends Message { @@ -16,7 +16,7 @@ public final class CommandMessage extends Message { /** * Creates the command message. - * + * * @param command The command. */ public CommandMessage(String command) { @@ -25,7 +25,7 @@ public final class CommandMessage extends Message { /** * Gets the command. - * + * * @return The command. */ public String getCommand() { diff --git a/src/org/apollo/game/message/impl/ConfigMessage.java b/src/org/apollo/game/message/impl/ConfigMessage.java index 0a68b271..a71413e5 100644 --- a/src/org/apollo/game/message/impl/ConfigMessage.java +++ b/src/org/apollo/game/message/impl/ConfigMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent to the client to adjust a certain config or attribute setting. - * + * * @author Chris Fletcher */ public final class ConfigMessage extends Message { @@ -21,7 +21,7 @@ public final class ConfigMessage extends Message { /** * Creates a new config message. - * + * * @param id The config's identifier. * @param value The value. */ @@ -32,7 +32,7 @@ public final class ConfigMessage extends Message { /** * Gets the config's identifier. - * + * * @return The config id. */ public int getId() { @@ -41,7 +41,7 @@ public final class ConfigMessage extends Message { /** * Gets the config's value. - * + * * @return The config value. */ public int getValue() { diff --git a/src/org/apollo/game/message/impl/DialogueContinueMessage.java b/src/org/apollo/game/message/impl/DialogueContinueMessage.java index 7c6798e7..0b916053 100644 --- a/src/org/apollo/game/message/impl/DialogueContinueMessage.java +++ b/src/org/apollo/game/message/impl/DialogueContinueMessage.java @@ -5,7 +5,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent by the client when the player clicks the "Click here to continue" button on a dialogue * interface. - * + * * @author Chris Fletcher */ public final class DialogueContinueMessage extends Message { @@ -17,7 +17,7 @@ public final class DialogueContinueMessage extends Message { /** * Creates a new dialogue continue message. - * + * * @param interfaceId The interface id. */ public DialogueContinueMessage(int interfaceId) { @@ -26,7 +26,7 @@ public final class DialogueContinueMessage extends Message { /** * Gets the interface id of the button. - * + * * @return The interface id. */ public int getInterfaceId() { diff --git a/src/org/apollo/game/message/impl/DisplayCrossbonesMessage.java b/src/org/apollo/game/message/impl/DisplayCrossbonesMessage.java index bc3d7c38..cedf96ec 100644 --- a/src/org/apollo/game/message/impl/DisplayCrossbonesMessage.java +++ b/src/org/apollo/game/message/impl/DisplayCrossbonesMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent to the client to display crossbones when the player enters a multi-combat zone. - * + * * @author Major */ public final class DisplayCrossbonesMessage extends Message { @@ -16,7 +16,7 @@ public final class DisplayCrossbonesMessage extends Message { /** * Creates a display crossbones message. - * + * * @param display Whether or not the crossbones should be displayed. */ public DisplayCrossbonesMessage(boolean display) { @@ -25,7 +25,7 @@ public final class DisplayCrossbonesMessage extends Message { /** * Indicates whether the crossbones will be displayed. - * + * * @return {@code true} if the crossbones will be displayed, otherwise {@code false}. */ public boolean isDisplayed() { diff --git a/src/org/apollo/game/message/impl/DisplayTabInterfaceMessage.java b/src/org/apollo/game/message/impl/DisplayTabInterfaceMessage.java index ce93187d..3588e23c 100644 --- a/src/org/apollo/game/message/impl/DisplayTabInterfaceMessage.java +++ b/src/org/apollo/game/message/impl/DisplayTabInterfaceMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent to the client to change the currently displayed tab interface. - * + * * @author Chris Fletcher */ public final class DisplayTabInterfaceMessage extends Message { @@ -16,7 +16,7 @@ public final class DisplayTabInterfaceMessage extends Message { /** * Creates a new display tab interface message. - * + * * @param tab The index of the tab to display. */ public DisplayTabInterfaceMessage(int tab) { @@ -25,7 +25,7 @@ public final class DisplayTabInterfaceMessage extends Message { /** * Gets the index of the tab to display. - * + * * @return The tab index. */ public int getTab() { diff --git a/src/org/apollo/game/message/impl/EnterAmountMessage.java b/src/org/apollo/game/message/impl/EnterAmountMessage.java index a26d7fb5..faa88813 100644 --- a/src/org/apollo/game/message/impl/EnterAmountMessage.java +++ b/src/org/apollo/game/message/impl/EnterAmountMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent to the client to open up the enter amount interface. - * + * * @author Graham */ public final class EnterAmountMessage extends Message { diff --git a/src/org/apollo/game/message/impl/EnteredAmountMessage.java b/src/org/apollo/game/message/impl/EnteredAmountMessage.java index 0da1c84b..861d399a 100644 --- a/src/org/apollo/game/message/impl/EnteredAmountMessage.java +++ b/src/org/apollo/game/message/impl/EnteredAmountMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent by the client when the player has entered an amount. - * + * * @author Graham */ public final class EnteredAmountMessage extends Message { @@ -16,7 +16,7 @@ public final class EnteredAmountMessage extends Message { /** * Creates the entered amount message. - * + * * @param amount The amount. */ public EnteredAmountMessage(int amount) { @@ -25,7 +25,7 @@ public final class EnteredAmountMessage extends Message { /** * Gets the amount. - * + * * @return The amount. */ public int getAmount() { diff --git a/src/org/apollo/game/message/impl/FifthItemActionMessage.java b/src/org/apollo/game/message/impl/FifthItemActionMessage.java index d3934715..846b5da7 100644 --- a/src/org/apollo/game/message/impl/FifthItemActionMessage.java +++ b/src/org/apollo/game/message/impl/FifthItemActionMessage.java @@ -2,14 +2,14 @@ package org.apollo.game.message.impl; /** * The fifth {@link ItemActionMessage}. - * + * * @author Graham */ public final class FifthItemActionMessage extends ItemActionMessage { /** * Creates the fifth item action message. - * + * * @param interfaceId The interface id. * @param id The item id. * @param slot The item slot. diff --git a/src/org/apollo/game/message/impl/FifthItemOptionMessage.java b/src/org/apollo/game/message/impl/FifthItemOptionMessage.java index 0826d39a..2f61d064 100644 --- a/src/org/apollo/game/message/impl/FifthItemOptionMessage.java +++ b/src/org/apollo/game/message/impl/FifthItemOptionMessage.java @@ -2,14 +2,14 @@ package org.apollo.game.message.impl; /** * The fifth {@link ItemOptionMessage}. - * + * * @author Chris Fletcher */ public final class FifthItemOptionMessage extends ItemOptionMessage { /** * Creates the fifth item option message. - * + * * @param interfaceId The interface id. * @param id The id. * @param slot The slot. diff --git a/src/org/apollo/game/message/impl/FifthNpcActionMessage.java b/src/org/apollo/game/message/impl/FifthNpcActionMessage.java index 02347bcb..509b3208 100644 --- a/src/org/apollo/game/message/impl/FifthNpcActionMessage.java +++ b/src/org/apollo/game/message/impl/FifthNpcActionMessage.java @@ -2,7 +2,7 @@ package org.apollo.game.message.impl; /** * The fifth {@link NpcActionMessage}. - * + * * @author Major * @author Stuart */ diff --git a/src/org/apollo/game/message/impl/FifthPlayerActionMessage.java b/src/org/apollo/game/message/impl/FifthPlayerActionMessage.java index 73934b79..8b0ddfa2 100644 --- a/src/org/apollo/game/message/impl/FifthPlayerActionMessage.java +++ b/src/org/apollo/game/message/impl/FifthPlayerActionMessage.java @@ -2,14 +2,14 @@ package org.apollo.game.message.impl; /** * The fifth {@link PlayerActionMessage}. - * + * * @author Major */ public final class FifthPlayerActionMessage extends PlayerActionMessage { /** * Creates a fifth player action message. - * + * * @param playerIndex The index of the clicked player. */ public FifthPlayerActionMessage(int playerIndex) { diff --git a/src/org/apollo/game/message/impl/FirstItemActionMessage.java b/src/org/apollo/game/message/impl/FirstItemActionMessage.java index cb399cd4..649bd4ab 100644 --- a/src/org/apollo/game/message/impl/FirstItemActionMessage.java +++ b/src/org/apollo/game/message/impl/FirstItemActionMessage.java @@ -2,14 +2,14 @@ package org.apollo.game.message.impl; /** * The first {@link ItemActionMessage}. - * + * * @author Graham */ public final class FirstItemActionMessage extends ItemActionMessage { /** * Creates the first item action message. - * + * * @param interfaceId The interface id. * @param id The item id. * @param slot The item slot. diff --git a/src/org/apollo/game/message/impl/FirstItemOptionMessage.java b/src/org/apollo/game/message/impl/FirstItemOptionMessage.java index 72b1125b..31f005eb 100644 --- a/src/org/apollo/game/message/impl/FirstItemOptionMessage.java +++ b/src/org/apollo/game/message/impl/FirstItemOptionMessage.java @@ -2,14 +2,14 @@ package org.apollo.game.message.impl; /** * The first {@link ItemOptionMessage}. - * + * * @author Chris Fletcher */ public final class FirstItemOptionMessage extends ItemOptionMessage { /** * Creates the first item option message. - * + * * @param interfaceId The interface id. * @param id The id. * @param slot The slot. diff --git a/src/org/apollo/game/message/impl/FirstNpcActionMessage.java b/src/org/apollo/game/message/impl/FirstNpcActionMessage.java index 9578c82c..ec334660 100644 --- a/src/org/apollo/game/message/impl/FirstNpcActionMessage.java +++ b/src/org/apollo/game/message/impl/FirstNpcActionMessage.java @@ -2,14 +2,14 @@ package org.apollo.game.message.impl; /** * The first {@link NpcActionMessage}. - * + * * @author Major */ public final class FirstNpcActionMessage extends NpcActionMessage { /** * Creates a new first npc action message. - * + * * @param index The index of the npc. */ public FirstNpcActionMessage(int index) { diff --git a/src/org/apollo/game/message/impl/FirstObjectActionMessage.java b/src/org/apollo/game/message/impl/FirstObjectActionMessage.java index cef59087..7b408837 100644 --- a/src/org/apollo/game/message/impl/FirstObjectActionMessage.java +++ b/src/org/apollo/game/message/impl/FirstObjectActionMessage.java @@ -4,14 +4,14 @@ import org.apollo.game.model.Position; /** * The first {@link ObjectActionMessage}. - * + * * @author Graham */ public final class FirstObjectActionMessage extends ObjectActionMessage { /** * Creates the first object action message. - * + * * @param id The id. * @param position The position. */ diff --git a/src/org/apollo/game/message/impl/FirstPlayerActionMessage.java b/src/org/apollo/game/message/impl/FirstPlayerActionMessage.java index c1261202..2aeade66 100644 --- a/src/org/apollo/game/message/impl/FirstPlayerActionMessage.java +++ b/src/org/apollo/game/message/impl/FirstPlayerActionMessage.java @@ -2,14 +2,14 @@ package org.apollo.game.message.impl; /** * The first {@link PlayerActionMessage}. - * + * * @author Major */ public final class FirstPlayerActionMessage extends PlayerActionMessage { /** * Creates a first player action message. - * + * * @param playerIndex The index of the clicked player. */ public FirstPlayerActionMessage(int playerIndex) { diff --git a/src/org/apollo/game/message/impl/FlaggedMouseEventMessage.java b/src/org/apollo/game/message/impl/FlaggedMouseEventMessage.java index 9f427d19..2763842b 100644 --- a/src/org/apollo/game/message/impl/FlaggedMouseEventMessage.java +++ b/src/org/apollo/game/message/impl/FlaggedMouseEventMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent by the client when the player clicks with their mouse (or mousekeys etc). - * + * * @author Major */ public final class FlaggedMouseEventMessage extends Message { @@ -32,7 +32,7 @@ public final class FlaggedMouseEventMessage extends Message { /** * Creates a new mouse click message. - * + * * @param clickCount The number of clicks on this point. * @param x The x coordinate of the mouse click. * @param y The y coordinate of the mouse click. @@ -47,7 +47,7 @@ public final class FlaggedMouseEventMessage extends Message { /** * Gets the number of clicks on this point - maximum value of 2047. - * + * * @return The number of clicks. */ public int getClickCount() { @@ -56,7 +56,7 @@ public final class FlaggedMouseEventMessage extends Message { /** * The x coordinate of the click. - * + * * @return The x coordinate. */ public int getX() { @@ -65,7 +65,7 @@ public final class FlaggedMouseEventMessage extends Message { /** * The y coordinate of the click. - * + * * @return The y coordinate. */ public int getY() { @@ -75,7 +75,7 @@ public final class FlaggedMouseEventMessage extends Message { /** * Gets the value indicating whether the {@link #x} and {@link #y} values represent the deviation from the last * click or an actual point. - * + * * @return The value. */ public boolean getDelta() { diff --git a/src/org/apollo/game/message/impl/FlashTabInterfaceMessage.java b/src/org/apollo/game/message/impl/FlashTabInterfaceMessage.java index e6fb19d7..12d482d8 100644 --- a/src/org/apollo/game/message/impl/FlashTabInterfaceMessage.java +++ b/src/org/apollo/game/message/impl/FlashTabInterfaceMessage.java @@ -25,7 +25,7 @@ public final class FlashTabInterfaceMessage extends Message { /** * Gets the id of the tab to flash. - * + * * @return The id. */ public int getTab() { diff --git a/src/org/apollo/game/message/impl/FlashingTabClickedMessage.java b/src/org/apollo/game/message/impl/FlashingTabClickedMessage.java index ae7e1056..12682651 100644 --- a/src/org/apollo/game/message/impl/FlashingTabClickedMessage.java +++ b/src/org/apollo/game/message/impl/FlashingTabClickedMessage.java @@ -25,7 +25,7 @@ public final class FlashingTabClickedMessage extends Message { /** * Gets the index of the tab that was clicked. - * + * * @return The tab index. */ public int getTab() { diff --git a/src/org/apollo/game/message/impl/FocusUpdateMessage.java b/src/org/apollo/game/message/impl/FocusUpdateMessage.java index 85e1c521..ed27ca28 100644 --- a/src/org/apollo/game/message/impl/FocusUpdateMessage.java +++ b/src/org/apollo/game/message/impl/FocusUpdateMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent by the client to indicate a change in the client's focus (i.e. if it is the active window). - * + * * @author Major */ public final class FocusUpdateMessage extends Message { @@ -16,7 +16,7 @@ public final class FocusUpdateMessage extends Message { /** * Creates a new focus update message. - * + * * @param focused The data received. */ public FocusUpdateMessage(boolean focused) { @@ -25,7 +25,7 @@ public final class FocusUpdateMessage extends Message { /** * Indicates whether or not the client is focused. - * + * * @return {@code true} if the client is focused, otherwise {@code false}. */ public boolean isFocused() { diff --git a/src/org/apollo/game/message/impl/ForwardPrivateChatMessage.java b/src/org/apollo/game/message/impl/ForwardPrivateChatMessage.java index b31d5397..98a8c204 100644 --- a/src/org/apollo/game/message/impl/ForwardPrivateChatMessage.java +++ b/src/org/apollo/game/message/impl/ForwardPrivateChatMessage.java @@ -5,7 +5,7 @@ import org.apollo.game.model.entity.setting.PrivilegeLevel; /** * A {@link Message} sent to the client that forwards a private chat. - * + * * @author Major */ public final class ForwardPrivateChatMessage extends Message { @@ -27,20 +27,20 @@ public final class ForwardPrivateChatMessage extends Message { /** * Creates a new forward private message message. - * + * * @param username The username of the player sending the message. * @param level The {@link PrivilegeLevel} of the player sending the message. * @param message The compressed message. */ public ForwardPrivateChatMessage(String username, PrivilegeLevel level, byte[] message) { this.username = username; - this.privilege = level; + privilege = level; this.message = message; } /** * Gets the username of the sender. - * + * * @return The username. */ public String getSenderUsername() { @@ -49,7 +49,7 @@ public final class ForwardPrivateChatMessage extends Message { /** * Gets the {@link PrivilegeLevel} of the sender. - * + * * @return The privilege level. */ public PrivilegeLevel getSenderPrivilege() { @@ -58,7 +58,7 @@ public final class ForwardPrivateChatMessage extends Message { /** * Gets the compressed message. - * + * * @return The message. */ public byte[] getCompressedMessage() { diff --git a/src/org/apollo/game/message/impl/FourthItemActionMessage.java b/src/org/apollo/game/message/impl/FourthItemActionMessage.java index 7f969520..19b31a9e 100644 --- a/src/org/apollo/game/message/impl/FourthItemActionMessage.java +++ b/src/org/apollo/game/message/impl/FourthItemActionMessage.java @@ -2,14 +2,14 @@ package org.apollo.game.message.impl; /** * The fourth {@link ItemActionMessage}. - * + * * @author Graham */ public final class FourthItemActionMessage extends ItemActionMessage { /** * Creates the fourth item action message. - * + * * @param interfaceId The interface id. * @param id The item id. * @param slot The item slot. diff --git a/src/org/apollo/game/message/impl/FourthItemOptionMessage.java b/src/org/apollo/game/message/impl/FourthItemOptionMessage.java index cdc8e6d8..4143efd4 100644 --- a/src/org/apollo/game/message/impl/FourthItemOptionMessage.java +++ b/src/org/apollo/game/message/impl/FourthItemOptionMessage.java @@ -2,14 +2,14 @@ package org.apollo.game.message.impl; /** * The fourth {@link ItemOptionMessage}. - * + * * @author Chris Fletcher */ public final class FourthItemOptionMessage extends ItemOptionMessage { /** * Creates the fourth item option message. - * + * * @param interfaceId The interface id. * @param id The id. * @param slot The slot. diff --git a/src/org/apollo/game/message/impl/FourthNpcActionMessage.java b/src/org/apollo/game/message/impl/FourthNpcActionMessage.java index d0babf44..7471dc38 100644 --- a/src/org/apollo/game/message/impl/FourthNpcActionMessage.java +++ b/src/org/apollo/game/message/impl/FourthNpcActionMessage.java @@ -2,7 +2,7 @@ package org.apollo.game.message.impl; /** * The fourth {@link NpcActionMessage}. - * + * * @author Major * @author Stuart */ @@ -10,7 +10,7 @@ public final class FourthNpcActionMessage extends NpcActionMessage { /** * Creates the FourthNpcActionMessage. - * + * * @param index The index of the Npc. */ public FourthNpcActionMessage(int index) { diff --git a/src/org/apollo/game/message/impl/FourthPlayerActionMessage.java b/src/org/apollo/game/message/impl/FourthPlayerActionMessage.java index 9454bfa7..576bc6b5 100644 --- a/src/org/apollo/game/message/impl/FourthPlayerActionMessage.java +++ b/src/org/apollo/game/message/impl/FourthPlayerActionMessage.java @@ -2,14 +2,14 @@ package org.apollo.game.message.impl; /** * The fourth {@link PlayerActionMessage}. - * + * * @author Major */ public final class FourthPlayerActionMessage extends PlayerActionMessage { /** * Creates a fourth player action message. - * + * * @param playerIndex The index of the clicked player. */ public FourthPlayerActionMessage(int playerIndex) { diff --git a/src/org/apollo/game/message/impl/FriendServerStatusMessage.java b/src/org/apollo/game/message/impl/FriendServerStatusMessage.java index 4960b853..6c64fbc7 100644 --- a/src/org/apollo/game/message/impl/FriendServerStatusMessage.java +++ b/src/org/apollo/game/message/impl/FriendServerStatusMessage.java @@ -5,7 +5,7 @@ import org.apollo.game.model.entity.setting.ServerStatus; /** * A {@link Message} sent to the client to update the friend server status. - * + * * @author Major */ public final class FriendServerStatusMessage extends Message { @@ -17,7 +17,7 @@ public final class FriendServerStatusMessage extends Message { /** * Creates a new friend server status message. - * + * * @param status The status. */ public FriendServerStatusMessage(ServerStatus status) { @@ -26,7 +26,7 @@ public final class FriendServerStatusMessage extends Message { /** * Gets the status code of the friend server. - * + * * @return The status code. */ public int getStatusCode() { diff --git a/src/org/apollo/game/message/impl/GroupedRegionUpdateMessage.java b/src/org/apollo/game/message/impl/GroupedRegionUpdateMessage.java index 3dc299ee..087b4152 100644 --- a/src/org/apollo/game/message/impl/GroupedRegionUpdateMessage.java +++ b/src/org/apollo/game/message/impl/GroupedRegionUpdateMessage.java @@ -1,11 +1,11 @@ package org.apollo.game.message.impl; +import java.util.List; + import org.apollo.game.message.Message; import org.apollo.game.model.Position; import org.apollo.game.model.area.RegionCoordinates; -import java.util.List; - /** * A {@link Message} sent to the client that contains multiple * @@ -30,20 +30,20 @@ public final class GroupedRegionUpdateMessage extends Message { /** * Creates the GroupedRegionUpdateMessage. - * + * * @param lastKnownRegion The last known region {@link Position} of the Player. * @param coordinates The {@link RegionCoordinates} of the Region being updated. * @param messages The {@link List} of {@link RegionUpdateMessage}s. */ public GroupedRegionUpdateMessage(Position lastKnownRegion, RegionCoordinates coordinates, List messages) { this.lastKnownRegion = lastKnownRegion; - this.region = new Position(coordinates.getAbsoluteX(), coordinates.getAbsoluteY()); + region = new Position(coordinates.getAbsoluteX(), coordinates.getAbsoluteY()); this.messages = messages; } /** * Gets the {@link Position} of the Player. - * + * * @return The Position. */ public Position getLastKnownRegion() { @@ -52,7 +52,7 @@ public final class GroupedRegionUpdateMessage extends Message { /** * Gets the {@link List} of {@link RegionUpdateMessage}s. - * + * * @return The Collection. */ public List getMessages() { @@ -61,7 +61,7 @@ public final class GroupedRegionUpdateMessage extends Message { /** * Gets the {@link Position} of the Region these updates affect. - * + * * @return The Position. */ public Position getRegionPosition() { diff --git a/src/org/apollo/game/message/impl/HintIconMessage.java b/src/org/apollo/game/message/impl/HintIconMessage.java index b99c958e..a6b9a8d4 100644 --- a/src/org/apollo/game/message/impl/HintIconMessage.java +++ b/src/org/apollo/game/message/impl/HintIconMessage.java @@ -47,7 +47,7 @@ public final class HintIconMessage extends Message { /** * Gets the value of this type. - * + * * @return The value. */ public int getValue() { @@ -58,7 +58,7 @@ public final class HintIconMessage extends Message { /** * Creates a HintIconMessage for the Npc with the specified index. - * + * * @param index The index of the Npc. * @return The HintIconMessage. */ @@ -68,7 +68,7 @@ public final class HintIconMessage extends Message { /** * Creates a HintIconMessage for the Player with the specified index. - * + * * @param index The index of the Player. * @return The HintIconMessage. */ @@ -78,7 +78,7 @@ public final class HintIconMessage extends Message { /** * Creates a HintIconMessage that removes the current Npc hint icon. - * + * * @return The HintIconMessage. */ public static HintIconMessage resetNpc() { @@ -87,7 +87,7 @@ public final class HintIconMessage extends Message { /** * Creates a HintIconMessage that removes the current Player hint icon. - * + * * @return The HintIconMessage. */ public static HintIconMessage resetPlayer() { diff --git a/src/org/apollo/game/message/impl/IdAssignmentMessage.java b/src/org/apollo/game/message/impl/IdAssignmentMessage.java index 72e50362..4b04b77c 100644 --- a/src/org/apollo/game/message/impl/IdAssignmentMessage.java +++ b/src/org/apollo/game/message/impl/IdAssignmentMessage.java @@ -5,7 +5,7 @@ import org.apollo.game.model.entity.setting.MembershipStatus; /** * A {@link Message} sent to the client that specifies the local id and membership status of the current player. - * + * * @author Graham */ public final class IdAssignmentMessage extends Message { @@ -22,7 +22,7 @@ public final class IdAssignmentMessage extends Message { /** * Creates the local id message. - * + * * @param id The id. * @param members The MembershipStatus. */ @@ -33,7 +33,7 @@ public final class IdAssignmentMessage extends Message { /** * Gets the id. - * + * * @return The id. */ public int getId() { @@ -42,7 +42,7 @@ public final class IdAssignmentMessage extends Message { /** * Gets whether or not the Player is a {@link MembershipStatus#PAID paying member}. - * + * * @return {@code true} if the Player is a paying member, {@code false} if not. */ public boolean isMembers() { diff --git a/src/org/apollo/game/message/impl/IgnoreListMessage.java b/src/org/apollo/game/message/impl/IgnoreListMessage.java index 29ec2767..8389c4ab 100644 --- a/src/org/apollo/game/message/impl/IgnoreListMessage.java +++ b/src/org/apollo/game/message/impl/IgnoreListMessage.java @@ -6,7 +6,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent to the client that updates the ignored user list. - * + * * @author Major */ public final class IgnoreListMessage extends Message { @@ -18,7 +18,7 @@ public final class IgnoreListMessage extends Message { /** * Creates a new ignore list message. - * + * * @param usernames The {@link List} of usernames to send. */ public IgnoreListMessage(List usernames) { @@ -27,7 +27,7 @@ public final class IgnoreListMessage extends Message { /** * Gets the list of ignored usernames. - * + * * @return The usernames. */ public List getUsernames() { diff --git a/src/org/apollo/game/message/impl/InventoryItemMessage.java b/src/org/apollo/game/message/impl/InventoryItemMessage.java index 49af4b5c..3c92e26c 100644 --- a/src/org/apollo/game/message/impl/InventoryItemMessage.java +++ b/src/org/apollo/game/message/impl/InventoryItemMessage.java @@ -5,7 +5,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} 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 message, and so cannot be used to determine when one of those messages is fired. - * + * * @author Chris Fletcher */ public abstract class InventoryItemMessage extends Message { @@ -32,7 +32,7 @@ public abstract class InventoryItemMessage extends Message { /** * Creates the item action message. - * + * * @param option The option number. * @param interfaceId The interface id. * @param id The id. @@ -47,7 +47,7 @@ public abstract class InventoryItemMessage extends Message { /** * Gets the item id. - * + * * @return The item id. */ public final int getId() { @@ -56,7 +56,7 @@ public abstract class InventoryItemMessage extends Message { /** * Gets the interface id. - * + * * @return The interface id. */ public final int getInterfaceId() { @@ -65,7 +65,7 @@ public abstract class InventoryItemMessage extends Message { /** * Gets the option number. - * + * * @return The option number. */ public final int getOption() { @@ -74,7 +74,7 @@ public abstract class InventoryItemMessage extends Message { /** * Gets the slot. - * + * * @return The slot. */ public final int getSlot() { diff --git a/src/org/apollo/game/message/impl/ItemActionMessage.java b/src/org/apollo/game/message/impl/ItemActionMessage.java index 0ec8b5ef..e636f94d 100644 --- a/src/org/apollo/game/message/impl/ItemActionMessage.java +++ b/src/org/apollo/game/message/impl/ItemActionMessage.java @@ -6,14 +6,14 @@ import org.apollo.game.message.Message; * A {@link Message} sent by the client that represents some sort of action on an item. Note that the actual message * sent by the client is one of the five item action messages, but this is the message that should be intercepted (and * the option verified). - * + * * @author Chris Fletcher */ public abstract class ItemActionMessage extends InventoryItemMessage { /** * Creates the item action message. - * + * * @param option The option number. * @param interfaceId The interface id. * @param id The id. diff --git a/src/org/apollo/game/message/impl/ItemOnItemMessage.java b/src/org/apollo/game/message/impl/ItemOnItemMessage.java index 62b4c17f..164595fb 100644 --- a/src/org/apollo/game/message/impl/ItemOnItemMessage.java +++ b/src/org/apollo/game/message/impl/ItemOnItemMessage.java @@ -2,7 +2,7 @@ package org.apollo.game.message.impl; /** * A {@link InventoryItemMessage} sent by the client when a player uses one inventory item on another. - * + * * @author Chris Fletcher */ public final class ItemOnItemMessage extends InventoryItemMessage { @@ -24,7 +24,7 @@ public final class ItemOnItemMessage extends InventoryItemMessage { /** * Creates a new item-on-item message. - * + * * @param usedInterface The interface id of the used item. * @param usedId The id of the used item. * @param usedSlot The slot of the target item. @@ -41,7 +41,7 @@ public final class ItemOnItemMessage extends InventoryItemMessage { /** * Gets the id of the target item. - * + * * @return The target item's interface id. */ public int getTargetId() { @@ -50,7 +50,7 @@ public final class ItemOnItemMessage extends InventoryItemMessage { /** * Gets the interface id of the target item. - * + * * @return The target item's interface id. */ public int getTargetInterfaceId() { @@ -59,7 +59,7 @@ public final class ItemOnItemMessage extends InventoryItemMessage { /** * Gets the slot of the target item. - * + * * @return The slot of the target item. */ public int getTargetSlot() { diff --git a/src/org/apollo/game/message/impl/ItemOnObjectMessage.java b/src/org/apollo/game/message/impl/ItemOnObjectMessage.java index 48ca26fe..60586247 100644 --- a/src/org/apollo/game/message/impl/ItemOnObjectMessage.java +++ b/src/org/apollo/game/message/impl/ItemOnObjectMessage.java @@ -5,7 +5,7 @@ import org.apollo.game.model.Position; /** * A {@link Message} sent by the client when an item is used on an object. - * + * * @author Major */ public final class ItemOnObjectMessage extends InventoryItemMessage { @@ -22,7 +22,7 @@ public final class ItemOnObjectMessage extends InventoryItemMessage { /** * Creates an item on object message. - * + * * @param interfaceId The interface id. * @param itemId The item id. * @param itemSlot The slot the item is in. @@ -33,12 +33,12 @@ public final class ItemOnObjectMessage extends InventoryItemMessage { public ItemOnObjectMessage(int interfaceId, int itemId, int itemSlot, int objectId, int x, int y) { super(0, interfaceId, itemId, itemSlot); this.objectId = objectId; - this.position = new Position(x, y); + position = new Position(x, y); } /** * Gets the object id. - * + * * @return The object id. */ public int getObjectId() { @@ -47,7 +47,7 @@ public final class ItemOnObjectMessage extends InventoryItemMessage { /** * Gets the position of the object. - * + * * @return The position. */ public Position getPosition() { diff --git a/src/org/apollo/game/message/impl/ItemOptionMessage.java b/src/org/apollo/game/message/impl/ItemOptionMessage.java index 626c7e0e..3a7641df 100644 --- a/src/org/apollo/game/message/impl/ItemOptionMessage.java +++ b/src/org/apollo/game/message/impl/ItemOptionMessage.java @@ -4,14 +4,14 @@ package org.apollo.game.message.impl; * An {@link InventoryItemMessage} sent by the client when an item's option is clicked (e.g. equip, eat, drink, etc). * Note that the actual message sent by the client is one of the five item option messages, but this is the message that * should be intercepted (and the option verified). - * + * * @author Chris Fletcher */ public abstract class ItemOptionMessage extends InventoryItemMessage { /** * Creates the item option message. - * + * * @param option The option number. * @param interfaceId The interface id. * @param id The id. diff --git a/src/org/apollo/game/message/impl/KeepAliveMessage.java b/src/org/apollo/game/message/impl/KeepAliveMessage.java index 24e11f7b..c74efc5f 100644 --- a/src/org/apollo/game/message/impl/KeepAliveMessage.java +++ b/src/org/apollo/game/message/impl/KeepAliveMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} periodically sent by the client to keep a connection alive. - * + * * @author Graham */ public final class KeepAliveMessage extends Message { @@ -23,7 +23,7 @@ public final class KeepAliveMessage extends Message { /** * Gets the time when this message was created. - * + * * @return The time when this message was created. */ public long getCreatedAt() { diff --git a/src/org/apollo/game/message/impl/LogoutMessage.java b/src/org/apollo/game/message/impl/LogoutMessage.java index 16e147c6..89a0b241 100644 --- a/src/org/apollo/game/message/impl/LogoutMessage.java +++ b/src/org/apollo/game/message/impl/LogoutMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent to the client that cleanly logs it out. - * + * * @author Graham */ public final class LogoutMessage extends Message { diff --git a/src/org/apollo/game/message/impl/MagicOnItemMessage.java b/src/org/apollo/game/message/impl/MagicOnItemMessage.java index 068e6140..75ee2767 100644 --- a/src/org/apollo/game/message/impl/MagicOnItemMessage.java +++ b/src/org/apollo/game/message/impl/MagicOnItemMessage.java @@ -2,7 +2,7 @@ package org.apollo.game.message.impl; /** * A {@link InventoryItemMessage} sent by the client when a player casts a spell on an inventory item. - * + * * @author Chris Fletcher */ public final class MagicOnItemMessage extends InventoryItemMessage { @@ -14,7 +14,7 @@ public final class MagicOnItemMessage extends InventoryItemMessage { /** * Creates a new magic on item message. - * + * * @param interfaceId The interface id. * @param id The item id. * @param slot The item slot. @@ -27,7 +27,7 @@ public final class MagicOnItemMessage extends InventoryItemMessage { /** * Gets the spell id. - * + * * @return The spell id. */ public int getSpellId() { diff --git a/src/org/apollo/game/message/impl/MobAnimationResetMessage.java b/src/org/apollo/game/message/impl/MobAnimationResetMessage.java index 3ad14e18..a8d3f88f 100644 --- a/src/org/apollo/game/message/impl/MobAnimationResetMessage.java +++ b/src/org/apollo/game/message/impl/MobAnimationResetMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent to the client to reset the animations of every mob. - * + * * @author Major */ public final class MobAnimationResetMessage extends Message { diff --git a/src/org/apollo/game/message/impl/NpcActionMessage.java b/src/org/apollo/game/message/impl/NpcActionMessage.java index 67173a42..eee877ac 100644 --- a/src/org/apollo/game/message/impl/NpcActionMessage.java +++ b/src/org/apollo/game/message/impl/NpcActionMessage.java @@ -6,7 +6,7 @@ import org.apollo.game.message.Message; * A {@link Message} sent by the client representing the clicking of an npc menu action. Note that the actual message * sent by the client is one of the three npc action messages, but this is the message that should be intercepted (and * the option verified). - * + * * @author Major */ public abstract class NpcActionMessage extends Message { @@ -23,7 +23,7 @@ public abstract class NpcActionMessage extends Message { /** * Creates an npc action message. - * + * * @param option The option number. * @param index The index of the npc. */ @@ -34,7 +34,7 @@ public abstract class NpcActionMessage extends Message { /** * Gets the menu action number (i.e. the action message 'option') clicked. - * + * * @return The option number. */ public int getOption() { @@ -43,7 +43,7 @@ public abstract class NpcActionMessage extends Message { /** * Gets the index of the npc clicked. - * + * * @return The npc index. */ public int getIndex() { diff --git a/src/org/apollo/game/message/impl/NpcSynchronizationMessage.java b/src/org/apollo/game/message/impl/NpcSynchronizationMessage.java index e474b83e..8c78dac5 100644 --- a/src/org/apollo/game/message/impl/NpcSynchronizationMessage.java +++ b/src/org/apollo/game/message/impl/NpcSynchronizationMessage.java @@ -9,7 +9,7 @@ import org.apollo.game.sync.seg.SynchronizationSegment; /** * A {@link Message} sent to the client to synchronize npcs with players. - * + * * @author Major */ public final class NpcSynchronizationMessage extends Message { @@ -31,7 +31,7 @@ public final class NpcSynchronizationMessage extends Message { /** * Creates a new {@link NpcSynchronizationMessage}. - * + * * @param position The position of the {@link Npc}. * @param segments The list of segments. * @param localNpcs The amount of local npcs. @@ -44,7 +44,7 @@ public final class NpcSynchronizationMessage extends Message { /** * Gets the number of local npcs. - * + * * @return The number of local npcs. */ public int getLocalNpcCount() { @@ -53,7 +53,7 @@ public final class NpcSynchronizationMessage extends Message { /** * Gets the npc's position. - * + * * @return The npc's position. */ public Position getPosition() { @@ -62,7 +62,7 @@ public final class NpcSynchronizationMessage extends Message { /** * Gets the synchronization segments. - * + * * @return The segments. */ public List getSegments() { diff --git a/src/org/apollo/game/message/impl/ObjectActionMessage.java b/src/org/apollo/game/message/impl/ObjectActionMessage.java index ffbc210b..8233cc7f 100644 --- a/src/org/apollo/game/message/impl/ObjectActionMessage.java +++ b/src/org/apollo/game/message/impl/ObjectActionMessage.java @@ -7,7 +7,7 @@ import org.apollo.game.model.Position; * A {@link Message} sent by the client that represents some sort of action on an object. Note that the actual message * sent by the client is one of the five object action messages, but this is the message that should be intercepted (and * the option verified). - * + * * @author Graham */ public abstract class ObjectActionMessage extends Message { @@ -29,7 +29,7 @@ public abstract class ObjectActionMessage extends Message { /** * Creates a new object action message. - * + * * @param option The option number. * @param id The id of the object. * @param position The position of the object. @@ -42,7 +42,7 @@ public abstract class ObjectActionMessage extends Message { /** * Gets the id of the object. - * + * * @return The id of the object. */ public int getId() { @@ -51,7 +51,7 @@ public abstract class ObjectActionMessage extends Message { /** * Gets the option number. - * + * * @return The option number. */ public int getOption() { @@ -60,7 +60,7 @@ public abstract class ObjectActionMessage extends Message { /** * Gets the position of the object. - * + * * @return The position of the object. */ public Position getPosition() { diff --git a/src/org/apollo/game/message/impl/OpenDialogueInterfaceMessage.java b/src/org/apollo/game/message/impl/OpenDialogueInterfaceMessage.java index 4ce7e5ac..48e6a705 100644 --- a/src/org/apollo/game/message/impl/OpenDialogueInterfaceMessage.java +++ b/src/org/apollo/game/message/impl/OpenDialogueInterfaceMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent to the client that opens a dialogue interface (an interface that appears in the chat box). - * + * * @author Chris Fletcher */ public final class OpenDialogueInterfaceMessage extends Message { @@ -16,7 +16,7 @@ public final class OpenDialogueInterfaceMessage extends Message { /** * Creates a new message with the specified interface id. - * + * * @param interfaceId The interface id. */ public OpenDialogueInterfaceMessage(int interfaceId) { @@ -25,7 +25,7 @@ public final class OpenDialogueInterfaceMessage extends Message { /** * Gets the interface id. - * + * * @return The interface id. */ public int getInterfaceId() { diff --git a/src/org/apollo/game/message/impl/OpenDialogueOverlayMessage.java b/src/org/apollo/game/message/impl/OpenDialogueOverlayMessage.java index b785f569..46291f83 100644 --- a/src/org/apollo/game/message/impl/OpenDialogueOverlayMessage.java +++ b/src/org/apollo/game/message/impl/OpenDialogueOverlayMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent to the client that opens a dialogue interface (an interface that appears in the chat box). - * + * * @author Chris Fletcher */ public final class OpenDialogueOverlayMessage extends Message { @@ -16,7 +16,7 @@ public final class OpenDialogueOverlayMessage extends Message { /** * Creates a new message with the specified interface id. - * + * * @param interfaceId The interface id. */ public OpenDialogueOverlayMessage(int interfaceId) { @@ -25,7 +25,7 @@ public final class OpenDialogueOverlayMessage extends Message { /** * Gets the interface id. - * + * * @return The interface id. */ public int getInterfaceId() { diff --git a/src/org/apollo/game/message/impl/OpenInterfaceMessage.java b/src/org/apollo/game/message/impl/OpenInterfaceMessage.java index 64a48ed3..f2a8e189 100644 --- a/src/org/apollo/game/message/impl/OpenInterfaceMessage.java +++ b/src/org/apollo/game/message/impl/OpenInterfaceMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent to the client that opens an interface. - * + * * @author Graham */ public final class OpenInterfaceMessage extends Message { @@ -16,7 +16,7 @@ public final class OpenInterfaceMessage extends Message { /** * Creates the message with the specified interface id. - * + * * @param id The interface id. */ public OpenInterfaceMessage(int id) { @@ -25,7 +25,7 @@ public final class OpenInterfaceMessage extends Message { /** * Gets the interface id. - * + * * @return The interface id. */ public int getId() { diff --git a/src/org/apollo/game/message/impl/OpenInterfaceSidebarMessage.java b/src/org/apollo/game/message/impl/OpenInterfaceSidebarMessage.java index 66775c5d..5db52354 100644 --- a/src/org/apollo/game/message/impl/OpenInterfaceSidebarMessage.java +++ b/src/org/apollo/game/message/impl/OpenInterfaceSidebarMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent to the client to open an interface and a sidebar. - * + * * @author Graham */ public final class OpenInterfaceSidebarMessage extends Message { @@ -21,7 +21,7 @@ public final class OpenInterfaceSidebarMessage extends Message { /** * Creates the OpenInterfaceSidebarMessage. - * + * * @param interfaceId The interface id. * @param sidebarId The sidebar id. */ @@ -32,7 +32,7 @@ public final class OpenInterfaceSidebarMessage extends Message { /** * Gets the interface id. - * + * * @return The interface id. */ public int getInterfaceId() { @@ -41,7 +41,7 @@ public final class OpenInterfaceSidebarMessage extends Message { /** * Gets the sidebar id. - * + * * @return The sidebar id. */ public int getSidebarId() { diff --git a/src/org/apollo/game/message/impl/OpenOverlayMessage.java b/src/org/apollo/game/message/impl/OpenOverlayMessage.java index 79c029d6..76ea44d9 100644 --- a/src/org/apollo/game/message/impl/OpenOverlayMessage.java +++ b/src/org/apollo/game/message/impl/OpenOverlayMessage.java @@ -16,7 +16,7 @@ public final class OpenOverlayMessage extends Message { /** * Creates the OpenSidebarMessage. - * + * * @param overlayId The overlay id. */ public OpenOverlayMessage(int overlayId) { @@ -25,7 +25,7 @@ public final class OpenOverlayMessage extends Message { /** * Gets the overlay id. - * + * * @return The overlay id. */ public int getOverlayId() { diff --git a/src/org/apollo/game/message/impl/OpenSidebarMessage.java b/src/org/apollo/game/message/impl/OpenSidebarMessage.java index 1f3a41d8..81755a4f 100644 --- a/src/org/apollo/game/message/impl/OpenSidebarMessage.java +++ b/src/org/apollo/game/message/impl/OpenSidebarMessage.java @@ -16,7 +16,7 @@ public final class OpenSidebarMessage extends Message { /** * Creates the OpenSidebarMessage. - * + * * @param sidebarId The sidebar id. */ public OpenSidebarMessage(int sidebarId) { @@ -25,7 +25,7 @@ public final class OpenSidebarMessage extends Message { /** * Gets the sidebar id. - * + * * @return The sidebar id. */ public int getSidebarId() { diff --git a/src/org/apollo/game/message/impl/PlayerActionMessage.java b/src/org/apollo/game/message/impl/PlayerActionMessage.java index 7f109c5d..99faa421 100644 --- a/src/org/apollo/game/message/impl/PlayerActionMessage.java +++ b/src/org/apollo/game/message/impl/PlayerActionMessage.java @@ -6,7 +6,7 @@ import org.apollo.game.message.Message; * A {@link Message} sent by the client representing the clicking of a player menu action. Note that the actual message * sent by the client is one of the five player action messages, but this is the message that should be intercepted (and * the option verified). - * + * * @author Major */ public abstract class PlayerActionMessage extends Message { @@ -23,7 +23,7 @@ public abstract class PlayerActionMessage extends Message { /** * Creates a player action message. - * + * * @param option The option number. * @param index The index of the player. */ @@ -34,7 +34,7 @@ public abstract class PlayerActionMessage extends Message { /** * Gets the menu action number (i.e. the action message 'option') clicked. - * + * * @return The option number. */ public int getOption() { @@ -43,7 +43,7 @@ public abstract class PlayerActionMessage extends Message { /** * Gets the index of the clicked player. - * + * * @return The index. */ public int getIndex() { diff --git a/src/org/apollo/game/message/impl/PlayerDesignMessage.java b/src/org/apollo/game/message/impl/PlayerDesignMessage.java index bad236aa..d729d372 100644 --- a/src/org/apollo/game/message/impl/PlayerDesignMessage.java +++ b/src/org/apollo/game/message/impl/PlayerDesignMessage.java @@ -5,7 +5,7 @@ import org.apollo.game.model.Appearance; /** * A {@link Message} sent by the client when the player modifies their design. - * + * * @author Graham */ public final class PlayerDesignMessage extends Message { @@ -17,7 +17,7 @@ public final class PlayerDesignMessage extends Message { /** * Creates the player design message. - * + * * @param appearance The appearance. */ public PlayerDesignMessage(Appearance appearance) { @@ -26,7 +26,7 @@ public final class PlayerDesignMessage extends Message { /** * Gets the appearance. - * + * * @return The appearance. */ public Appearance getAppearance() { diff --git a/src/org/apollo/game/message/impl/PlayerSynchronizationMessage.java b/src/org/apollo/game/message/impl/PlayerSynchronizationMessage.java index 1f017a3c..01ebed4d 100644 --- a/src/org/apollo/game/message/impl/PlayerSynchronizationMessage.java +++ b/src/org/apollo/game/message/impl/PlayerSynchronizationMessage.java @@ -8,7 +8,7 @@ import org.apollo.game.sync.seg.SynchronizationSegment; /** * A {@link Message} sent to the client to synchronize players. - * + * * @author Graham */ public final class PlayerSynchronizationMessage extends Message { @@ -45,7 +45,7 @@ public final class PlayerSynchronizationMessage extends Message { /** * Creates the player synchronization message. - * + * * @param lastKnownRegion The last known region. * @param position The player's current position. * @param regionChanged A flag indicating if the region has changed. @@ -64,7 +64,7 @@ public final class PlayerSynchronizationMessage extends Message { /** * Gets the last known region. - * + * * @return The last known region. */ public Position getLastKnownRegion() { @@ -73,7 +73,7 @@ public final class PlayerSynchronizationMessage extends Message { /** * Gets the number of local players. - * + * * @return The number of local players. */ public int getLocalPlayers() { @@ -82,7 +82,7 @@ public final class PlayerSynchronizationMessage extends Message { /** * Gets the player's position. - * + * * @return The player's position. */ public Position getPosition() { @@ -91,7 +91,7 @@ public final class PlayerSynchronizationMessage extends Message { /** * Gets the current player's segment. - * + * * @return The current player's segment. */ public SynchronizationSegment getSegment() { @@ -100,7 +100,7 @@ public final class PlayerSynchronizationMessage extends Message { /** * Gets the synchronization segments. - * + * * @return The segments. */ public List getSegments() { @@ -109,7 +109,7 @@ public final class PlayerSynchronizationMessage extends Message { /** * Checks if the region has changed. - * + * * @return {@code true} if so, {@code false} if not. */ public boolean hasRegionChanged() { diff --git a/src/org/apollo/game/message/impl/PrivacyOptionMessage.java b/src/org/apollo/game/message/impl/PrivacyOptionMessage.java index c84f8812..8753219c 100644 --- a/src/org/apollo/game/message/impl/PrivacyOptionMessage.java +++ b/src/org/apollo/game/message/impl/PrivacyOptionMessage.java @@ -6,7 +6,7 @@ import org.apollo.game.model.entity.setting.PrivacyState; /** * A {@link Message} 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 */ @@ -29,7 +29,7 @@ public final class PrivacyOptionMessage extends Message { /** * Creates a privacy option message. - * + * * @param chatPrivacy The privacy state of the player's chat. * @param friendPrivacy The privacy state of the player's friend chat. * @param tradePrivacy The privacy state of the player's trade chat. @@ -42,7 +42,7 @@ public final class PrivacyOptionMessage extends Message { /** * Gets the chat {@link PrivacyState}. - * + * * @return The privacy state. */ public PrivacyState getChatPrivacy() { @@ -51,7 +51,7 @@ public final class PrivacyOptionMessage extends Message { /** * Gets the friend {@link PrivacyState}. - * + * * @return The privacy state. */ public PrivacyState getFriendPrivacy() { @@ -60,7 +60,7 @@ public final class PrivacyOptionMessage extends Message { /** * Gets the trade {@link PrivacyState}. - * + * * @return The privacy state. */ public PrivacyState getTradePrivacy() { diff --git a/src/org/apollo/game/message/impl/PrivateChatMessage.java b/src/org/apollo/game/message/impl/PrivateChatMessage.java index e672877d..0c251d40 100644 --- a/src/org/apollo/game/message/impl/PrivateChatMessage.java +++ b/src/org/apollo/game/message/impl/PrivateChatMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent by the client to send private chat to another player. - * + * * @author Major */ public final class PrivateChatMessage extends Message { @@ -26,7 +26,7 @@ public final class PrivateChatMessage extends Message { /** * Creates a new private chat message. - * + * * @param username The username of the player the message is being sent to. * @param chat The chat string. * @param compressedChat The chat string, in a compressed form. @@ -39,7 +39,7 @@ public final class PrivateChatMessage extends Message { /** * Gets the chat string being sent. - * + * * @return The chat string. */ public String getChat() { @@ -48,7 +48,7 @@ public final class PrivateChatMessage extends Message { /** * Gets the compressed chat string. - * + * * @return The compressed chat string. */ public byte[] getCompressedChat() { @@ -57,7 +57,7 @@ public final class PrivateChatMessage extends Message { /** * Gets the username of the player the chat string is being sent to. - * + * * @return The username. */ public String getUsername() { diff --git a/src/org/apollo/game/message/impl/RegionChangeMessage.java b/src/org/apollo/game/message/impl/RegionChangeMessage.java index 724ca354..599f49af 100644 --- a/src/org/apollo/game/message/impl/RegionChangeMessage.java +++ b/src/org/apollo/game/message/impl/RegionChangeMessage.java @@ -5,7 +5,7 @@ import org.apollo.game.model.Position; /** * A {@link Message} sent to the client instructing it to load the specified region. - * + * * @author Graham */ public final class RegionChangeMessage extends Message { @@ -17,7 +17,7 @@ public final class RegionChangeMessage extends Message { /** * Creates the region changed message. - * + * * @param position The position of the region. */ public RegionChangeMessage(Position position) { @@ -26,7 +26,7 @@ public final class RegionChangeMessage extends Message { /** * Gets the position of the region to load. - * + * * @return The position of the region to load. */ public Position getPosition() { diff --git a/src/org/apollo/game/message/impl/RegionUpdateMessage.java b/src/org/apollo/game/message/impl/RegionUpdateMessage.java index 33a631c1..d5d69468 100644 --- a/src/org/apollo/game/message/impl/RegionUpdateMessage.java +++ b/src/org/apollo/game/message/impl/RegionUpdateMessage.java @@ -34,7 +34,7 @@ public abstract class RegionUpdateMessage extends Message implements Comparable< /** * Gets the priority of this RegionUpdateMessage, to use when sorting. - * + * * @return The priority. Should be either 1 (low) or 0 (high). */ public abstract int priority(); diff --git a/src/org/apollo/game/message/impl/RemoveFriendMessage.java b/src/org/apollo/game/message/impl/RemoveFriendMessage.java index 025ec7be..7a9ea4fb 100644 --- a/src/org/apollo/game/message/impl/RemoveFriendMessage.java +++ b/src/org/apollo/game/message/impl/RemoveFriendMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent by the client when a player removes someone from their friends list. - * + * * @author Major */ public final class RemoveFriendMessage extends Message { @@ -16,7 +16,7 @@ public final class RemoveFriendMessage extends Message { /** * Creates a new defriend user message. - * + * * @param username The defriended player's username. */ public RemoveFriendMessage(String username) { @@ -25,7 +25,7 @@ public final class RemoveFriendMessage extends Message { /** * Gets the username of the defriended player. - * + * * @return The username. */ public String getUsername() { diff --git a/src/org/apollo/game/message/impl/RemoveIgnoreMessage.java b/src/org/apollo/game/message/impl/RemoveIgnoreMessage.java index 5cb5995e..ceedcca1 100644 --- a/src/org/apollo/game/message/impl/RemoveIgnoreMessage.java +++ b/src/org/apollo/game/message/impl/RemoveIgnoreMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent by the client when a player removes someone from their ignore list. - * + * * @author Major */ public final class RemoveIgnoreMessage extends Message { @@ -16,7 +16,7 @@ public final class RemoveIgnoreMessage extends Message { /** * Creates a new unignore player message. - * + * * @param username The unignored player's username. */ public RemoveIgnoreMessage(String username) { @@ -25,7 +25,7 @@ public final class RemoveIgnoreMessage extends Message { /** * Gets the username of the unignored player. - * + * * @return The username. */ public String getUsername() { diff --git a/src/org/apollo/game/message/impl/RemoveObjectMessage.java b/src/org/apollo/game/message/impl/RemoveObjectMessage.java index f475014f..1283a38f 100644 --- a/src/org/apollo/game/message/impl/RemoveObjectMessage.java +++ b/src/org/apollo/game/message/impl/RemoveObjectMessage.java @@ -5,7 +5,7 @@ import org.apollo.game.model.entity.obj.GameObject; /** * A {@link Message} sent to the client to remove an object from a tile. - * + * * @author Major */ public final class RemoveObjectMessage extends RegionUpdateMessage { @@ -27,14 +27,14 @@ public final class RemoveObjectMessage extends RegionUpdateMessage { /** * Creates the RemoveObjectMessage. - * + * * @param object The {@link GameObject} to send. * @param positionOffset The offset of the GameObject's Position from the Region's top-left position. */ public RemoveObjectMessage(GameObject object, int positionOffset) { this.positionOffset = positionOffset; - this.type = object.getType(); - this.orientation = object.getOrientation(); + type = object.getType(); + orientation = object.getOrientation(); } @Override @@ -49,7 +49,7 @@ public final class RemoveObjectMessage extends RegionUpdateMessage { /** * Gets the orientation of the object. - * + * * @return The orientation. */ public int getOrientation() { @@ -67,7 +67,7 @@ public final class RemoveObjectMessage extends RegionUpdateMessage { /** * Gets the type of the object. - * + * * @return The type. */ public int getType() { diff --git a/src/org/apollo/game/message/impl/RemoveTileItemMessage.java b/src/org/apollo/game/message/impl/RemoveTileItemMessage.java index 1117aa11..84a882ec 100644 --- a/src/org/apollo/game/message/impl/RemoveTileItemMessage.java +++ b/src/org/apollo/game/message/impl/RemoveTileItemMessage.java @@ -5,7 +5,7 @@ import org.apollo.game.model.Item; /** * A {@link Message} sent to the client to remove an item from a tile. - * + * * @author Major */ public final class RemoveTileItemMessage extends RegionUpdateMessage { @@ -22,7 +22,7 @@ public final class RemoveTileItemMessage extends RegionUpdateMessage { /** * Creates the RemoveTileItemMessage. - * + * * @param id The id of the {@link Item} to remove. * @param positionOffset The offset from the 'base' position. */ @@ -33,7 +33,7 @@ public final class RemoveTileItemMessage extends RegionUpdateMessage { /** * Creates the RemoveTileItemMessage. - * + * * @param item The {@link Item} to remove. * @param positionOffset The offset from the 'base' position. */ @@ -53,7 +53,7 @@ public final class RemoveTileItemMessage extends RegionUpdateMessage { /** * Gets the id of the item to remove. - * + * * @return The id. */ public int getId() { @@ -62,7 +62,7 @@ public final class RemoveTileItemMessage extends RegionUpdateMessage { /** * Gets the offset from the 'base' position. - * + * * @return The offset. */ public int getPositionOffset() { diff --git a/src/org/apollo/game/message/impl/SecondItemActionMessage.java b/src/org/apollo/game/message/impl/SecondItemActionMessage.java index a9731053..b12dfad9 100644 --- a/src/org/apollo/game/message/impl/SecondItemActionMessage.java +++ b/src/org/apollo/game/message/impl/SecondItemActionMessage.java @@ -2,14 +2,14 @@ package org.apollo.game.message.impl; /** * The second {@link ItemActionMessage}. - * + * * @author Graham */ public final class SecondItemActionMessage extends ItemActionMessage { /** * Creates the second item action message. - * + * * @param interfaceId The interface id. * @param id The item id. * @param slot The item slot. diff --git a/src/org/apollo/game/message/impl/SecondItemOptionMessage.java b/src/org/apollo/game/message/impl/SecondItemOptionMessage.java index 3f7341f9..2722ac92 100644 --- a/src/org/apollo/game/message/impl/SecondItemOptionMessage.java +++ b/src/org/apollo/game/message/impl/SecondItemOptionMessage.java @@ -2,14 +2,14 @@ package org.apollo.game.message.impl; /** * The second {@link ItemOptionMessage}. - * + * * @author Chris Fletcher */ public final class SecondItemOptionMessage extends ItemOptionMessage { /** * Creates the second item option message. - * + * * @param interfaceId The interface id. * @param id The id. * @param slot The slot. diff --git a/src/org/apollo/game/message/impl/SecondNpcActionMessage.java b/src/org/apollo/game/message/impl/SecondNpcActionMessage.java index 679daf73..d64a11e0 100644 --- a/src/org/apollo/game/message/impl/SecondNpcActionMessage.java +++ b/src/org/apollo/game/message/impl/SecondNpcActionMessage.java @@ -2,14 +2,14 @@ package org.apollo.game.message.impl; /** * The second {@link NpcActionMessage}. - * + * * @author Major */ public final class SecondNpcActionMessage extends NpcActionMessage { /** * Creates a new second npc action message. - * + * * @param index The index of the npc. */ public SecondNpcActionMessage(int index) { diff --git a/src/org/apollo/game/message/impl/SecondObjectActionMessage.java b/src/org/apollo/game/message/impl/SecondObjectActionMessage.java index 43b76c03..c9f2b80e 100644 --- a/src/org/apollo/game/message/impl/SecondObjectActionMessage.java +++ b/src/org/apollo/game/message/impl/SecondObjectActionMessage.java @@ -4,14 +4,14 @@ import org.apollo.game.model.Position; /** * The second {@link ObjectActionMessage}. - * + * * @author Graham */ public final class SecondObjectActionMessage extends ObjectActionMessage { /** * Creates the second object action message. - * + * * @param id The id. * @param position The position. */ diff --git a/src/org/apollo/game/message/impl/SecondPlayerActionMessage.java b/src/org/apollo/game/message/impl/SecondPlayerActionMessage.java index 577cb18d..04fbf115 100644 --- a/src/org/apollo/game/message/impl/SecondPlayerActionMessage.java +++ b/src/org/apollo/game/message/impl/SecondPlayerActionMessage.java @@ -2,14 +2,14 @@ package org.apollo.game.message.impl; /** * The second {@link PlayerActionMessage}. - * + * * @author Major */ public final class SecondPlayerActionMessage extends PlayerActionMessage { /** * Creates a second player action message. - * + * * @param playerIndex The index of the clicked player. */ public SecondPlayerActionMessage(int playerIndex) { diff --git a/src/org/apollo/game/message/impl/SendFriendMessage.java b/src/org/apollo/game/message/impl/SendFriendMessage.java index e6f11089..32da9afd 100644 --- a/src/org/apollo/game/message/impl/SendFriendMessage.java +++ b/src/org/apollo/game/message/impl/SendFriendMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent to the client to add a player to the friend list. - * + * * @author Major */ public final class SendFriendMessage extends Message { @@ -21,7 +21,7 @@ public final class SendFriendMessage extends Message { /** * Creates a new send friend message. - * + * * @param username The username of the friend. * @param world The world the friend is in. */ @@ -32,7 +32,7 @@ public final class SendFriendMessage extends Message { /** * Gets the username of the friend. - * + * * @return The username. */ public String getUsername() { @@ -41,7 +41,7 @@ public final class SendFriendMessage extends Message { /** * Gets the world id the friend is in. - * + * * @return The world id. */ public int getWorld() { diff --git a/src/org/apollo/game/message/impl/SendObjectMessage.java b/src/org/apollo/game/message/impl/SendObjectMessage.java index f075a75b..47d2ea80 100644 --- a/src/org/apollo/game/message/impl/SendObjectMessage.java +++ b/src/org/apollo/game/message/impl/SendObjectMessage.java @@ -5,7 +5,7 @@ import org.apollo.game.model.entity.obj.GameObject; /** * A {@link Message} sent to the client to spawn an object. - * + * * @author Major */ public final class SendObjectMessage extends RegionUpdateMessage { @@ -32,15 +32,15 @@ public final class SendObjectMessage extends RegionUpdateMessage { /** * Creates the SendObjectMessage. - * + * * @param object The {@link GameObject} to send. * @param positionOffset The offset of the object's position from the region's central position. */ public SendObjectMessage(GameObject object, int positionOffset) { - this.id = object.getId(); + id = object.getId(); this.positionOffset = positionOffset; - this.type = object.getType(); - this.orientation = object.getOrientation(); + type = object.getType(); + orientation = object.getOrientation(); } @Override @@ -68,7 +68,7 @@ public final class SendObjectMessage extends RegionUpdateMessage { /** * Gets the orientation of the object. - * + * * @return The orientation. */ public int getOrientation() { @@ -86,7 +86,7 @@ public final class SendObjectMessage extends RegionUpdateMessage { /** * Gets the orientation of the object. - * + * * @return The type. */ public int getType() { diff --git a/src/org/apollo/game/message/impl/SendPublicTileItemMessage.java b/src/org/apollo/game/message/impl/SendPublicTileItemMessage.java index 282fcd80..d82c8d75 100644 --- a/src/org/apollo/game/message/impl/SendPublicTileItemMessage.java +++ b/src/org/apollo/game/message/impl/SendPublicTileItemMessage.java @@ -5,7 +5,7 @@ import org.apollo.game.model.Item; /** * A {@link Message} sent to the client to display an item on a tile for every player. - * + * * @author Major */ public final class SendPublicTileItemMessage extends RegionUpdateMessage { @@ -27,7 +27,7 @@ public final class SendPublicTileItemMessage extends RegionUpdateMessage { /** * Creates the SendPublicTileItemMessage. - * + * * @param item The item to add to the tile. * @param index The index of the player who dropped the item. * @param positionOffset The offset from the 'base' position. @@ -50,7 +50,7 @@ public final class SendPublicTileItemMessage extends RegionUpdateMessage { /** * Gets the amount of the item. - * + * * @return The amount. */ public int getAmount() { @@ -59,7 +59,7 @@ public final class SendPublicTileItemMessage extends RegionUpdateMessage { /** * Gets the id of the item. - * + * * @return The id. */ public int getId() { @@ -68,7 +68,7 @@ public final class SendPublicTileItemMessage extends RegionUpdateMessage { /** * Gets the index of the player who dropped the item. - * + * * @return The index. */ public int getIndex() { @@ -77,7 +77,7 @@ public final class SendPublicTileItemMessage extends RegionUpdateMessage { /** * Gets the offset from the 'base' position. - * + * * @return The offset. */ public int getPositionOffset() { diff --git a/src/org/apollo/game/message/impl/SendTileItemMessage.java b/src/org/apollo/game/message/impl/SendTileItemMessage.java index 73018849..82769472 100644 --- a/src/org/apollo/game/message/impl/SendTileItemMessage.java +++ b/src/org/apollo/game/message/impl/SendTileItemMessage.java @@ -5,7 +5,7 @@ import org.apollo.game.model.Item; /** * A {@link Message} sent to the client that adds an item to a tile. - * + * * @author Major */ public final class SendTileItemMessage extends RegionUpdateMessage { @@ -22,7 +22,7 @@ public final class SendTileItemMessage extends RegionUpdateMessage { /** * Creates the SendTileItemMessage. - * + * * @param item The item to add to the tile. * @param positionOffset The offset from the 'base' position. */ @@ -33,7 +33,7 @@ public final class SendTileItemMessage extends RegionUpdateMessage { /** * Gets the id of the item. - * + * * @return The id. */ public int getId() { @@ -42,7 +42,7 @@ public final class SendTileItemMessage extends RegionUpdateMessage { /** * Gets the amount of the item. - * + * * @return The amount. */ public int getAmount() { @@ -51,7 +51,7 @@ public final class SendTileItemMessage extends RegionUpdateMessage { /** * Gets the offset from the 'base' position. - * + * * @return The offset. */ public int getPositionOffset() { diff --git a/src/org/apollo/game/message/impl/ServerChatMessage.java b/src/org/apollo/game/message/impl/ServerChatMessage.java index ec2df797..2f0a335f 100644 --- a/src/org/apollo/game/message/impl/ServerChatMessage.java +++ b/src/org/apollo/game/message/impl/ServerChatMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent to the client to display a server chat message. - * + * * @author Graham */ public final class ServerChatMessage extends Message { @@ -16,7 +16,7 @@ public final class ServerChatMessage extends Message { /** * Creates a server chat message. - * + * * @param message The chat message. */ public ServerChatMessage(String message) { @@ -25,7 +25,7 @@ public final class ServerChatMessage extends Message { /** * Creates a server chat message. - * + * * @param message The chat message. * @param filterable Whether or not the message can be filtered. */ @@ -35,7 +35,7 @@ public final class ServerChatMessage extends Message { /** * Gets the chat message. - * + * * @return The chat message. */ public String getMessage() { diff --git a/src/org/apollo/game/message/impl/SetPlayerActionMessage.java b/src/org/apollo/game/message/impl/SetPlayerActionMessage.java index c933e198..2f8c0804 100644 --- a/src/org/apollo/game/message/impl/SetPlayerActionMessage.java +++ b/src/org/apollo/game/message/impl/SetPlayerActionMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent by the client to add an action to the menu when a player right-clicks another. - * + * * @author Major */ public final class SetPlayerActionMessage extends Message { @@ -26,7 +26,7 @@ public final class SetPlayerActionMessage extends Message { /** * Creates the set player action message. - * + * * @param text The action text. * @param slot The menu slot. */ @@ -36,7 +36,7 @@ public final class SetPlayerActionMessage extends Message { /** * Creates the set player action message. - * + * * @param text The action text. * @param slot The menu slot. * @param primaryInteraction Whether or not the action is the primary action. @@ -44,12 +44,12 @@ public final class SetPlayerActionMessage extends Message { public SetPlayerActionMessage(String text, int slot, boolean primaryInteraction) { this.text = text; this.slot = slot; - this.primaryAction = primaryInteraction; + primaryAction = primaryInteraction; } /** * Gets the action text. - * + * * @return The text. */ public String getText() { @@ -58,7 +58,7 @@ public final class SetPlayerActionMessage extends Message { /** * Gets the menu slot this action occupies. - * + * * @return The slot. */ public int getSlot() { @@ -68,7 +68,7 @@ public final class SetPlayerActionMessage extends Message { /** * Whether or not this action is the primary one (i.e. should be displayed when the player hovers over the other * player). - * + * * @return {@code true} if this action is the primary action, {@code false} if not. */ public boolean isPrimaryAction() { diff --git a/src/org/apollo/game/message/impl/SetUpdatedRegionMessage.java b/src/org/apollo/game/message/impl/SetUpdatedRegionMessage.java index c335aa96..564811fd 100644 --- a/src/org/apollo/game/message/impl/SetUpdatedRegionMessage.java +++ b/src/org/apollo/game/message/impl/SetUpdatedRegionMessage.java @@ -6,7 +6,7 @@ import org.apollo.game.model.area.RegionCoordinates; /** * A {@link Message} sent to the client to set the coordinates of the Region currently being updated. - * + * * @author Major */ public final class SetUpdatedRegionMessage extends Message { @@ -23,7 +23,7 @@ public final class SetUpdatedRegionMessage extends Message { /** * Creates the SetUpdatedRegionMessage. - * + * * @param player The {@link Position} of the Player this {@link Message} is being sent to. * @param region The {@link RegionCoordinates} of the Region being set. */ @@ -34,7 +34,7 @@ public final class SetUpdatedRegionMessage extends Message { /** * Gets the {@link Position} of the Player this {@link Message} is being sent to.. - * + * * @return The Position. */ public Position getPlayerPosition() { @@ -43,7 +43,7 @@ public final class SetUpdatedRegionMessage extends Message { /** * Gets the {@link Position} of the Region being cleared. - * + * * @return The Position. */ public Position getRegionPosition() { diff --git a/src/org/apollo/game/message/impl/SetWidgetItemModelMessage.java b/src/org/apollo/game/message/impl/SetWidgetItemModelMessage.java index aa406c3d..9e5a70cf 100644 --- a/src/org/apollo/game/message/impl/SetWidgetItemModelMessage.java +++ b/src/org/apollo/game/message/impl/SetWidgetItemModelMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent to the client to set a widget's displayed item model. - * + * * @author Chris Fletcher */ public final class SetWidgetItemModelMessage extends Message { @@ -26,7 +26,7 @@ public final class SetWidgetItemModelMessage extends Message { /** * Creates a new set interface item model message. - * + * * @param interfaceId The interface's id. * @param modelId The model's (item) id. * @param zoom The zoom level. @@ -39,7 +39,7 @@ public final class SetWidgetItemModelMessage extends Message { /** * Gets the interface's id. - * + * * @return The id. */ public int getInterfaceId() { @@ -48,7 +48,7 @@ public final class SetWidgetItemModelMessage extends Message { /** * Gets the model's (item) id. - * + * * @return The id. */ public int getModelId() { @@ -57,7 +57,7 @@ public final class SetWidgetItemModelMessage extends Message { /** * Gets the zoom level. - * + * * @return The zoom. */ public int getZoom() { diff --git a/src/org/apollo/game/message/impl/SetWidgetModelAnimationMessage.java b/src/org/apollo/game/message/impl/SetWidgetModelAnimationMessage.java index 30a491a0..f1600bce 100644 --- a/src/org/apollo/game/message/impl/SetWidgetModelAnimationMessage.java +++ b/src/org/apollo/game/message/impl/SetWidgetModelAnimationMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent to the client to set a widget's displayed mob's animation. - * + * * @author Chris Fletcher */ public final class SetWidgetModelAnimationMessage extends Message { @@ -21,7 +21,7 @@ public final class SetWidgetModelAnimationMessage extends Message { /** * Creates a new set interface npc model's animation message. - * + * * @param interfaceId The interface id. * @param animation The model's animation id. */ @@ -32,7 +32,7 @@ public final class SetWidgetModelAnimationMessage extends Message { /** * Gets the model's mood id. - * + * * @return The model's mood id. */ public int getAnimation() { @@ -41,7 +41,7 @@ public final class SetWidgetModelAnimationMessage extends Message { /** * Gets the interface id. - * + * * @return The interface id. */ public int getInterfaceId() { diff --git a/src/org/apollo/game/message/impl/SetWidgetNpcModelMessage.java b/src/org/apollo/game/message/impl/SetWidgetNpcModelMessage.java index 1add8bb3..31bbd0b7 100644 --- a/src/org/apollo/game/message/impl/SetWidgetNpcModelMessage.java +++ b/src/org/apollo/game/message/impl/SetWidgetNpcModelMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent to the client to set a widget's displayed npc model. - * + * * @author Chris Fletcher */ public final class SetWidgetNpcModelMessage extends Message { @@ -21,7 +21,7 @@ public final class SetWidgetNpcModelMessage extends Message { /** * Creates a new set interface NPC model message. - * + * * @param interfaceId The interface's id. * @param modelId The model's (NPC) id. */ @@ -32,7 +32,7 @@ public final class SetWidgetNpcModelMessage extends Message { /** * Gets the interface's id. - * + * * @return The id. */ public int getInterfaceId() { @@ -41,7 +41,7 @@ public final class SetWidgetNpcModelMessage extends Message { /** * Gets the model's (NPC) id. - * + * * @return The id. */ public int getModelId() { diff --git a/src/org/apollo/game/message/impl/SetWidgetPlayerModelMessage.java b/src/org/apollo/game/message/impl/SetWidgetPlayerModelMessage.java index 3a7890c0..53eeb6e3 100644 --- a/src/org/apollo/game/message/impl/SetWidgetPlayerModelMessage.java +++ b/src/org/apollo/game/message/impl/SetWidgetPlayerModelMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent to the client to set a widget's displayed player model. - * + * * @author Chris Fletcher */ public final class SetWidgetPlayerModelMessage extends Message { @@ -16,7 +16,7 @@ public final class SetWidgetPlayerModelMessage extends Message { /** * Creates a new set interface player model message. - * + * * @param interfaceId The interface's id. */ public SetWidgetPlayerModelMessage(int interfaceId) { @@ -25,7 +25,7 @@ public final class SetWidgetPlayerModelMessage extends Message { /** * Gets the interface's id. - * + * * @return The id. */ public int getInterfaceId() { diff --git a/src/org/apollo/game/message/impl/SetWidgetTextMessage.java b/src/org/apollo/game/message/impl/SetWidgetTextMessage.java index 7700981a..d5bede6b 100644 --- a/src/org/apollo/game/message/impl/SetWidgetTextMessage.java +++ b/src/org/apollo/game/message/impl/SetWidgetTextMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent to the client to set a widget's text. - * + * * @author Graham */ public final class SetWidgetTextMessage extends Message { @@ -21,7 +21,7 @@ public final class SetWidgetTextMessage extends Message { /** * Creates the set interface text message. - * + * * @param interfaceId The interface's id. * @param text The interface's text. */ @@ -32,7 +32,7 @@ public final class SetWidgetTextMessage extends Message { /** * Gets the interface id. - * + * * @return The interface id. */ public int getInterfaceId() { @@ -41,7 +41,7 @@ public final class SetWidgetTextMessage extends Message { /** * Gets the interface's text. - * + * * @return The interface's text. */ public String getText() { diff --git a/src/org/apollo/game/message/impl/SetWidgetVisibilityMessage.java b/src/org/apollo/game/message/impl/SetWidgetVisibilityMessage.java index 8cfe885f..245cc749 100644 --- a/src/org/apollo/game/message/impl/SetWidgetVisibilityMessage.java +++ b/src/org/apollo/game/message/impl/SetWidgetVisibilityMessage.java @@ -5,7 +5,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} 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 */ public final class SetWidgetVisibilityMessage extends Message { @@ -22,7 +22,7 @@ public final class SetWidgetVisibilityMessage extends Message { /** * Creates the interface component state message. - * + * * @param component The compononent id. * @param visible The flag for showing or hiding the component. */ @@ -33,7 +33,7 @@ public final class SetWidgetVisibilityMessage extends Message { /** * Gets the id of the interface component. - * + * * @return The component id. */ public int getWidgetId() { @@ -42,7 +42,7 @@ public final class SetWidgetVisibilityMessage extends Message { /** * Gets the visible flag. - * + * * @return {@code true} if the component has been set to visible, {@code false} if not. */ public boolean isVisible() { diff --git a/src/org/apollo/game/message/impl/SpamPacketMessage.java b/src/org/apollo/game/message/impl/SpamPacketMessage.java index 804e7684..1f26eb1f 100644 --- a/src/org/apollo/game/message/impl/SpamPacketMessage.java +++ b/src/org/apollo/game/message/impl/SpamPacketMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent by the client after a short period of time containing random data. - * + * * @author Major */ public final class SpamPacketMessage extends Message { @@ -16,7 +16,7 @@ public final class SpamPacketMessage extends Message { /** * Creates a new spam packet message. - * + * * @param data The data sent. */ public SpamPacketMessage(byte[] data) { @@ -25,7 +25,7 @@ public final class SpamPacketMessage extends Message { /** * Gets the data sent. - * + * * @return The data. */ public byte[] getData() { diff --git a/src/org/apollo/game/message/impl/SwitchItemMessage.java b/src/org/apollo/game/message/impl/SwitchItemMessage.java index 02c5d753..0dc4b49e 100644 --- a/src/org/apollo/game/message/impl/SwitchItemMessage.java +++ b/src/org/apollo/game/message/impl/SwitchItemMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent by the client when two items are switched. - * + * * @author Graham */ public final class SwitchItemMessage extends Message { @@ -31,7 +31,7 @@ public final class SwitchItemMessage extends Message { /** * Creates a new switch item message. - * + * * @param interfaceId The interface id. * @param inserting A flag indicating if the interface is in 'insert' mode instead of swap mode. * @param oldSlot The old slot. @@ -46,7 +46,7 @@ public final class SwitchItemMessage extends Message { /** * Gets the interface id. - * + * * @return The interface id. */ public int getInterfaceId() { @@ -55,7 +55,7 @@ public final class SwitchItemMessage extends Message { /** * Gets the new slot. - * + * * @return The new slot. */ public int getNewSlot() { @@ -64,7 +64,7 @@ public final class SwitchItemMessage extends Message { /** * Gets the old slot. - * + * * @return The old slot. */ public int getOldSlot() { @@ -73,7 +73,7 @@ public final class SwitchItemMessage extends Message { /** * Checks if this message is in insertion mode. - * + * * @return The insertion flag. */ public boolean isInserting() { @@ -82,7 +82,7 @@ public final class SwitchItemMessage extends Message { /** * Checks if this message is in swap mode. - * + * * @return The swap flag. */ public boolean isSwapping() { diff --git a/src/org/apollo/game/message/impl/SwitchTabInterfaceMessage.java b/src/org/apollo/game/message/impl/SwitchTabInterfaceMessage.java index 9516cac9..44bb3141 100644 --- a/src/org/apollo/game/message/impl/SwitchTabInterfaceMessage.java +++ b/src/org/apollo/game/message/impl/SwitchTabInterfaceMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent to the client to change the interface of a tab. - * + * * @author Graham */ public final class SwitchTabInterfaceMessage extends Message { @@ -21,7 +21,7 @@ public final class SwitchTabInterfaceMessage extends Message { /** * Creates the switch interface message. - * + * * @param tab The tab id. * @param interfaceId The interface id. */ @@ -32,7 +32,7 @@ public final class SwitchTabInterfaceMessage extends Message { /** * Gets the interface id. - * + * * @return The interface id. */ public int getInterfaceId() { @@ -41,7 +41,7 @@ public final class SwitchTabInterfaceMessage extends Message { /** * Gets the tab id. - * + * * @return The tab id. */ public int getTabId() { diff --git a/src/org/apollo/game/message/impl/TakeTileItemMessage.java b/src/org/apollo/game/message/impl/TakeTileItemMessage.java index c0dbd62b..a02e7d22 100644 --- a/src/org/apollo/game/message/impl/TakeTileItemMessage.java +++ b/src/org/apollo/game/message/impl/TakeTileItemMessage.java @@ -5,7 +5,7 @@ import org.apollo.game.model.Position; /** * A {@link Message} sent by the client to pick up an item on a tile. - * + * * @author Major */ public final class TakeTileItemMessage extends Message { @@ -22,7 +22,7 @@ public final class TakeTileItemMessage extends Message { /** * Creates a new take tile item message. - * + * * @param id The id of the item. * @param position The position of the tile. */ @@ -33,7 +33,7 @@ public final class TakeTileItemMessage extends Message { /** * Gets the id of the item. - * + * * @return The id. */ public int getId() { @@ -42,7 +42,7 @@ public final class TakeTileItemMessage extends Message { /** * Gets the position of the tile. - * + * * @return The position. */ public Position getPosition() { diff --git a/src/org/apollo/game/message/impl/ThirdItemActionMessage.java b/src/org/apollo/game/message/impl/ThirdItemActionMessage.java index e371bdcf..1c48fa2a 100644 --- a/src/org/apollo/game/message/impl/ThirdItemActionMessage.java +++ b/src/org/apollo/game/message/impl/ThirdItemActionMessage.java @@ -2,14 +2,14 @@ package org.apollo.game.message.impl; /** * The third {@link ItemActionMessage}. - * + * * @author Graham */ public final class ThirdItemActionMessage extends ItemActionMessage { /** * Creates the third item action message. - * + * * @param interfaceId The interface id. * @param id The item id. * @param slot The item slot. diff --git a/src/org/apollo/game/message/impl/ThirdItemOptionMessage.java b/src/org/apollo/game/message/impl/ThirdItemOptionMessage.java index 0df3fe86..fc1b1a67 100644 --- a/src/org/apollo/game/message/impl/ThirdItemOptionMessage.java +++ b/src/org/apollo/game/message/impl/ThirdItemOptionMessage.java @@ -2,14 +2,14 @@ package org.apollo.game.message.impl; /** * The third {@link ItemOptionMessage}. - * + * * @author Chris Fletcher */ public final class ThirdItemOptionMessage extends ItemOptionMessage { /** * Creates the third item option message. - * + * * @param interfaceId The interface id. * @param id The id. * @param slot The slot. diff --git a/src/org/apollo/game/message/impl/ThirdNpcActionMessage.java b/src/org/apollo/game/message/impl/ThirdNpcActionMessage.java index 9685f9b0..2cdf2ac0 100644 --- a/src/org/apollo/game/message/impl/ThirdNpcActionMessage.java +++ b/src/org/apollo/game/message/impl/ThirdNpcActionMessage.java @@ -2,14 +2,14 @@ package org.apollo.game.message.impl; /** * The third {@link NpcActionMessage}. - * + * * @author Major */ public final class ThirdNpcActionMessage extends NpcActionMessage { /** * Creates a new third npc action message. - * + * * @param index The index of the npc. */ public ThirdNpcActionMessage(int index) { diff --git a/src/org/apollo/game/message/impl/ThirdObjectActionMessage.java b/src/org/apollo/game/message/impl/ThirdObjectActionMessage.java index 3dbe2aff..0f012e57 100644 --- a/src/org/apollo/game/message/impl/ThirdObjectActionMessage.java +++ b/src/org/apollo/game/message/impl/ThirdObjectActionMessage.java @@ -4,14 +4,14 @@ import org.apollo.game.model.Position; /** * The third {@link ObjectActionMessage}. - * + * * @author Graham */ public final class ThirdObjectActionMessage extends ObjectActionMessage { /** * Creates the third object action message. - * + * * @param id The id. * @param position The position. */ diff --git a/src/org/apollo/game/message/impl/ThirdPlayerActionMessage.java b/src/org/apollo/game/message/impl/ThirdPlayerActionMessage.java index c3e1e125..b19608bb 100644 --- a/src/org/apollo/game/message/impl/ThirdPlayerActionMessage.java +++ b/src/org/apollo/game/message/impl/ThirdPlayerActionMessage.java @@ -2,14 +2,14 @@ package org.apollo.game.message.impl; /** * The third {@link PlayerActionMessage}. - * + * * @author Major */ public final class ThirdPlayerActionMessage extends PlayerActionMessage { /** * Creates a third player action message. - * + * * @param playerIndex The index of the clicked player. */ public ThirdPlayerActionMessage(int playerIndex) { diff --git a/src/org/apollo/game/message/impl/UpdateItemsMessage.java b/src/org/apollo/game/message/impl/UpdateItemsMessage.java index 6b508f34..1bcab98a 100644 --- a/src/org/apollo/game/message/impl/UpdateItemsMessage.java +++ b/src/org/apollo/game/message/impl/UpdateItemsMessage.java @@ -5,7 +5,7 @@ import org.apollo.game.model.Item; /** * A {@link Message} sent to the client that updates all the items in an interface. - * + * * @author Graham */ public final class UpdateItemsMessage extends Message { @@ -22,7 +22,7 @@ public final class UpdateItemsMessage extends Message { /** * Creates the update inventory interface message. - * + * * @param interfaceId The interface id. * @param items The items. */ @@ -33,7 +33,7 @@ public final class UpdateItemsMessage extends Message { /** * Gets the interface id. - * + * * @return The interface id. */ public int getInterfaceId() { @@ -42,7 +42,7 @@ public final class UpdateItemsMessage extends Message { /** * Gets the items. - * + * * @return The items. */ public Item[] getItems() { diff --git a/src/org/apollo/game/message/impl/UpdateRunEnergyMessage.java b/src/org/apollo/game/message/impl/UpdateRunEnergyMessage.java index 6edde6f6..23f60cb4 100644 --- a/src/org/apollo/game/message/impl/UpdateRunEnergyMessage.java +++ b/src/org/apollo/game/message/impl/UpdateRunEnergyMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent to the client to update the remaining run energy value. - * + * * @author Major */ public final class UpdateRunEnergyMessage extends Message { @@ -16,7 +16,7 @@ public final class UpdateRunEnergyMessage extends Message { /** * Creates a new update run energy message. - * + * * @param energy The energy. */ public UpdateRunEnergyMessage(int energy) { @@ -25,7 +25,7 @@ public final class UpdateRunEnergyMessage extends Message { /** * Gets the amount of run energy. - * + * * @return The energy. */ public int getEnergy() { diff --git a/src/org/apollo/game/message/impl/UpdateSkillMessage.java b/src/org/apollo/game/message/impl/UpdateSkillMessage.java index 5cda75e3..4b0b3a25 100644 --- a/src/org/apollo/game/message/impl/UpdateSkillMessage.java +++ b/src/org/apollo/game/message/impl/UpdateSkillMessage.java @@ -5,7 +5,7 @@ import org.apollo.game.model.entity.Skill; /** * A {@link Message} sent to the client to update a player's skill level. - * + * * @author Graham */ public final class UpdateSkillMessage extends Message { @@ -22,7 +22,7 @@ public final class UpdateSkillMessage extends Message { /** * Creates an update skill message. - * + * * @param id The id. * @param skill The skill. */ @@ -33,7 +33,7 @@ public final class UpdateSkillMessage extends Message { /** * Gets the skill's id. - * + * * @return The skill's id. */ public int getId() { @@ -42,7 +42,7 @@ public final class UpdateSkillMessage extends Message { /** * Gets the skill. - * + * * @return The skill. */ public Skill getSkill() { diff --git a/src/org/apollo/game/message/impl/UpdateSlottedItemsMessage.java b/src/org/apollo/game/message/impl/UpdateSlottedItemsMessage.java index 6947ecc3..e44d18a1 100644 --- a/src/org/apollo/game/message/impl/UpdateSlottedItemsMessage.java +++ b/src/org/apollo/game/message/impl/UpdateSlottedItemsMessage.java @@ -5,7 +5,7 @@ import org.apollo.game.model.inv.SlottedItem; /** * A {@link Message} sent to the client that updates a single item in an interface. - * + * * @author Graham */ public final class UpdateSlottedItemsMessage extends Message { @@ -22,7 +22,7 @@ public final class UpdateSlottedItemsMessage extends Message { /** * Creates the update item in interface message. - * + * * @param interfaceId The interface id. * @param items The slotted items. */ @@ -33,7 +33,7 @@ public final class UpdateSlottedItemsMessage extends Message { /** * Gets the interface id. - * + * * @return The interface id. */ public int getInterfaceId() { @@ -42,7 +42,7 @@ public final class UpdateSlottedItemsMessage extends Message { /** * Gets an array of slotted items. - * + * * @return The slotted items. */ public SlottedItem[] getSlottedItems() { diff --git a/src/org/apollo/game/message/impl/UpdateTileItemMessage.java b/src/org/apollo/game/message/impl/UpdateTileItemMessage.java index 566d5161..81bc3427 100644 --- a/src/org/apollo/game/message/impl/UpdateTileItemMessage.java +++ b/src/org/apollo/game/message/impl/UpdateTileItemMessage.java @@ -5,7 +5,7 @@ import org.apollo.game.model.Item; /** * A {@link Message} sent to the client to update the amount of an item display on a tile. - * + * * @author Major */ public final class UpdateTileItemMessage extends RegionUpdateMessage { @@ -27,7 +27,7 @@ public final class UpdateTileItemMessage extends RegionUpdateMessage { /** * Creates a new message that updates the previous amount of the item. - * + * * @param item The item to be placed. * @param previousAmount The previous amount of the item. */ @@ -37,7 +37,7 @@ public final class UpdateTileItemMessage extends RegionUpdateMessage { /** * Creates a new set tile item message. - * + * * @param item The item to be placed. * @param previousAmount The previous amount of the item. * @param positionOffset The offset from the client's base position. @@ -60,7 +60,7 @@ public final class UpdateTileItemMessage extends RegionUpdateMessage { /** * Gets the amount of the item. - * + * * @return The amount. */ public int getAmount() { @@ -69,7 +69,7 @@ public final class UpdateTileItemMessage extends RegionUpdateMessage { /** * Gets the id of the item. - * + * * @return The item. */ public int getId() { @@ -78,7 +78,7 @@ public final class UpdateTileItemMessage extends RegionUpdateMessage { /** * Gets the offset from the client's base position. - * + * * @return The offset. */ public int getPositionOffset() { @@ -87,7 +87,7 @@ public final class UpdateTileItemMessage extends RegionUpdateMessage { /** * Gets the previous amount of the item. - * + * * @return The previous amount. */ public int getPreviousAmount() { diff --git a/src/org/apollo/game/message/impl/UpdateWeightMessage.java b/src/org/apollo/game/message/impl/UpdateWeightMessage.java index 551968fe..e7cb5f3e 100644 --- a/src/org/apollo/game/message/impl/UpdateWeightMessage.java +++ b/src/org/apollo/game/message/impl/UpdateWeightMessage.java @@ -4,7 +4,7 @@ import org.apollo.game.message.Message; /** * A {@link Message} sent to the client to update the player's weight. - * + * * @author Major */ public final class UpdateWeightMessage extends Message { @@ -16,7 +16,7 @@ public final class UpdateWeightMessage extends Message { /** * Creates the update weight message. - * + * * @param weight The weight of the player. */ public UpdateWeightMessage(int weight) { @@ -25,7 +25,7 @@ public final class UpdateWeightMessage extends Message { /** * Gets the weight of the player. - * + * * @return The weight. */ public int getWeight() { diff --git a/src/org/apollo/game/message/impl/WalkMessage.java b/src/org/apollo/game/message/impl/WalkMessage.java index fde16843..ac73adde 100644 --- a/src/org/apollo/game/message/impl/WalkMessage.java +++ b/src/org/apollo/game/message/impl/WalkMessage.java @@ -7,7 +7,7 @@ import com.google.common.base.Preconditions; /** * A {@link Message} sent by the client to request that the player walks somewhere. - * + * * @author Graham */ public final class WalkMessage extends Message { @@ -15,7 +15,7 @@ public final class WalkMessage extends Message { /** * The running flag. */ - private boolean run; + private final boolean run; /** * The steps. @@ -24,7 +24,7 @@ public final class WalkMessage extends Message { /** * Creates the message. - * + * * @param steps The steps array. * @param run The run flag. */ @@ -36,7 +36,7 @@ public final class WalkMessage extends Message { /** * Gets the steps array. - * + * * @return An array of steps. */ public Position[] getSteps() { @@ -45,7 +45,7 @@ public final class WalkMessage extends Message { /** * Checks if the steps should be ran (ctrl+click). - * + * * @return {@code true} if so, {@code false} otherwise. */ public boolean isRunning() { diff --git a/src/org/apollo/game/model/Animation.java b/src/org/apollo/game/model/Animation.java index a648d93b..a2dab3c8 100644 --- a/src/org/apollo/game/model/Animation.java +++ b/src/org/apollo/game/model/Animation.java @@ -2,7 +2,7 @@ package org.apollo.game.model; /** * Represents an animation. - * + * * @author Graham */ public final class Animation { @@ -164,7 +164,7 @@ public final class Animation { /** * Creates a new animation with no delay. - * + * * @param id The id. */ public Animation(int id) { @@ -173,7 +173,7 @@ public final class Animation { /** * Creates a new animation. - * + * * @param id The id. * @param delay The delay. */ @@ -184,7 +184,7 @@ public final class Animation { /** * Gets the animation's delay. - * + * * @return The animation's delay. */ public int getDelay() { @@ -193,7 +193,7 @@ public final class Animation { /** * Gets the animation's id. - * + * * @return The animation's id. */ public int getId() { diff --git a/src/org/apollo/game/model/Appearance.java b/src/org/apollo/game/model/Appearance.java index 6bb6a961..12febc75 100644 --- a/src/org/apollo/game/model/Appearance.java +++ b/src/org/apollo/game/model/Appearance.java @@ -6,7 +6,7 @@ import com.google.common.base.Preconditions; /** * Represents the appearance of a player. - * + * * @author Graham */ public final class Appearance { @@ -34,7 +34,7 @@ public final class Appearance { /** * Creates the appearance with the specified gender, style and colors. - * + * * @param gender The gender. * @param style The style. * @param colors The colors. @@ -53,7 +53,7 @@ public final class Appearance { /** * Gets the player's colors. - * + * * @return The player's colors. */ public int[] getColors() { @@ -62,7 +62,7 @@ public final class Appearance { /** * Gets the gender of the player. - * + * * @return The gender of the player. */ public Gender getGender() { @@ -71,7 +71,7 @@ public final class Appearance { /** * Gets the player's styles. - * + * * @return The player's styles. */ public int[] getStyle() { @@ -81,7 +81,7 @@ public final class Appearance { /** * Checks if the player is female. - * + * * @return {@code true} if so, {@code false} if not. */ public boolean isFemale() { @@ -90,7 +90,7 @@ public final class Appearance { /** * Checks if the player is male. - * + * * @return {@code true} if so, {@code false} if not. */ public boolean isMale() { diff --git a/src/org/apollo/game/model/Direction.java b/src/org/apollo/game/model/Direction.java index 61015ca3..e3123e94 100644 --- a/src/org/apollo/game/model/Direction.java +++ b/src/org/apollo/game/model/Direction.java @@ -2,7 +2,7 @@ package org.apollo.game.model; /** * Represents a single movement direction. - * + * * @author Graham */ public enum Direction { @@ -59,7 +59,7 @@ public enum Direction { /** * Creates a direction from the differences between X and Y. - * + * * @param deltaX The difference between two X coordinates. * @param deltaY The difference between two Y coordinates. * @return The direction. @@ -93,7 +93,7 @@ public enum Direction { /** * Checks if the direction represented by the two delta values can connect two points together in a single * direction. - * + * * @param deltaX The difference in X coordinates. * @param deltaY The difference in X coordinates. * @return {@code true} if so, {@code false} if not. @@ -109,7 +109,7 @@ public enum Direction { /** * Creates the direction. - * + * * @param intValue The direction as an integer. */ private Direction(int intValue) { @@ -118,7 +118,7 @@ public enum Direction { /** * Gets the direction as an integer which the client can understand. - * + * * @return The movement as an integer. */ public int toInteger() { diff --git a/src/org/apollo/game/model/Graphic.java b/src/org/apollo/game/model/Graphic.java index fde393c3..048fe302 100644 --- a/src/org/apollo/game/model/Graphic.java +++ b/src/org/apollo/game/model/Graphic.java @@ -2,7 +2,7 @@ package org.apollo.game.model; /** * Represents a 'still graphic'. - * + * * @author Graham */ public final class Graphic { @@ -29,7 +29,7 @@ public final class Graphic { /** * Creates a new graphic with no delay and a height of zero. - * + * * @param id The id. */ public Graphic(int id) { @@ -38,7 +38,7 @@ public final class Graphic { /** * Creates a new graphic with a height of zero. - * + * * @param id The id. * @param delay The delay. */ @@ -48,7 +48,7 @@ public final class Graphic { /** * Creates a new graphic. - * + * * @param id The id. * @param delay The delay. * @param height The height. @@ -61,7 +61,7 @@ public final class Graphic { /** * Gets the graphic's delay. - * + * * @return The delay. */ public int getDelay() { @@ -70,7 +70,7 @@ public final class Graphic { /** * Gets the graphic's height. - * + * * @return The height. */ public int getHeight() { @@ -79,7 +79,7 @@ public final class Graphic { /** * Gets the graphic's id. - * + * * @return The id. */ public int getId() { diff --git a/src/org/apollo/game/model/Item.java b/src/org/apollo/game/model/Item.java index 9b51fe28..5ecd7506 100644 --- a/src/org/apollo/game/model/Item.java +++ b/src/org/apollo/game/model/Item.java @@ -7,7 +7,7 @@ import com.google.common.base.Preconditions; /** * Represents a single item. - * + * * @author Graham */ public final class Item { @@ -29,7 +29,7 @@ public final class Item { /** * Creates an item with an amount of {@code 1}. - * + * * @param id The item's id. */ public Item(int id) { @@ -38,7 +38,7 @@ public final class Item { /** * Creates an item with the specified the amount. - * + * * @param id The item's id. * @param amount The amount. * @throws IllegalArgumentException If the amount is negative. @@ -47,7 +47,7 @@ public final class Item { Preconditions.checkArgument(amount >= 0, "Amount cannot be negative."); this.id = id; this.amount = amount; - this.definition = ItemDefinition.lookup(id); + definition = ItemDefinition.lookup(id); } @Override @@ -62,7 +62,7 @@ public final class Item { /** * Gets the amount. - * + * * @return The amount. */ public int getAmount() { @@ -71,7 +71,7 @@ public final class Item { /** * Gets the {@link ItemDefinition} that describes this item. - * + * * @return The definition. */ public ItemDefinition getDefinition() { @@ -80,7 +80,7 @@ public final class Item { /** * Gets the id. - * + * * @return The id. */ public int getId() { diff --git a/src/org/apollo/game/model/Position.java b/src/org/apollo/game/model/Position.java index 7e57c5af..4ddbaf1f 100644 --- a/src/org/apollo/game/model/Position.java +++ b/src/org/apollo/game/model/Position.java @@ -8,7 +8,7 @@ import com.google.common.base.Preconditions; /** * Represents a position in the world. - * + * * @author Graham */ public final class Position { @@ -30,7 +30,7 @@ public final class Position { /** * Creates a position at the default height. - * + * * @param x The x coordinate. * @param y The y coordinate. */ @@ -40,7 +40,7 @@ public final class Position { /** * Creates a position with the specified height. - * + * * @param x The x coordinate. * @param y The y coordinate. * @param height The height. @@ -63,7 +63,7 @@ public final class Position { /** * Gets the x coordinate of the central region. - * + * * @return The x coordinate of the central region. */ public int getCentralRegionX() { @@ -72,7 +72,7 @@ public final class Position { /** * Gets the y coordinate of the central region. - * + * * @return The y coordinate of the central region. */ public int getCentralRegionY() { @@ -81,7 +81,7 @@ public final class Position { /** * Gets the distance between this position and another position. Only x and y are considered (i.e. 2 dimensions). - * + * * @param other The other position. * @return The distance. */ @@ -93,7 +93,7 @@ public final class Position { /** * Gets the height level. - * + * * @return The height level. */ public int getHeight() { @@ -102,7 +102,7 @@ public final class Position { /** * Gets the x coordinate inside the region of this position. - * + * * @return The local x coordinate. */ public int getLocalX() { @@ -111,7 +111,7 @@ public final class Position { /** * Gets the local x coordinate inside the region of the {@code base} position. - * + * * @param base The base position. * @return The local x coordinate. */ @@ -121,7 +121,7 @@ public final class Position { /** * Gets the y coordinate inside the region of this position. - * + * * @return The local y coordinate. */ public int getLocalY() { @@ -130,7 +130,7 @@ public final class Position { /** * Gets the local y coordinate inside the region of the {@code base} position. - * + * * @param base The base position. * @return The local y coordinate. */ @@ -140,7 +140,7 @@ public final class Position { /** * Gets the longest horizontal or vertical delta between the two positions. - * + * * @param other The other position. * @return The longest horizontal or vertical delta. */ @@ -152,7 +152,7 @@ public final class Position { /** * Returns the {@link RegionCoordinates} of the {@link Region} this position is inside. - * + * * @return The region coordinates. */ public RegionCoordinates getRegionCoordinates() { @@ -161,7 +161,7 @@ public final class Position { /** * Gets the x coordinate of the region this position is in. - * + * * @return The region x coordinate. */ public int getTopLeftRegionX() { @@ -170,7 +170,7 @@ public final class Position { /** * Gets the y coordinate of the region this position is in. - * + * * @return The region y coordinate. */ public int getTopLeftRegionY() { @@ -179,7 +179,7 @@ public final class Position { /** * Gets the x coordinate. - * + * * @return The x coordinate. */ public int getX() { @@ -188,11 +188,11 @@ public final class Position { /** * Gets the y coordinate. - * + * * @return The y coordinate. */ public int getY() { - return (packed >> 15) & 0x7FFF; + return packed >> 15 & 0x7FFF; } @Override @@ -202,7 +202,7 @@ public final class Position { /** * Returns whether or not this position is inside the specified {@link Region}. - * + * * @param region The region. * @return {@code true} if this position is inside the specified region, otherwise {@code false}. */ @@ -213,7 +213,7 @@ public final class Position { /** * Checks if the position is within distance of another. - * + * * @param other The other position. * @param distance The distance. * @return {@code true} if so, {@code false} if not. diff --git a/src/org/apollo/game/model/World.java b/src/org/apollo/game/model/World.java index e74d0fbc..f4ccaddc 100644 --- a/src/org/apollo/game/model/World.java +++ b/src/org/apollo/game/model/World.java @@ -43,14 +43,14 @@ import com.google.common.base.Preconditions; * The world class is a singleton which contains objects like the {@link MobRepository} for players and NPCs. It should * only contain things relevant to the in-game world and not classes which deal with I/O and such (these may be better * off inside some custom {@link Service} or other code, however, the circumstances are rare). - * + * * @author Graham */ public final class World { /** * Represents the different status codes for registering a player. - * + * * @author Graham */ public enum RegistrationStatus { @@ -80,7 +80,7 @@ public final class World { /** * The command dispatcher. */ - private CommandDispatcher commandDispatcher = new CommandDispatcher(); + private final CommandDispatcher commandDispatcher = new CommandDispatcher(); /** * The EventListenerChainSet for this World. @@ -136,7 +136,7 @@ public final class World { /** * Gets the command dispatcher. - * + * * @return The command dispatcher. */ public CommandDispatcher getCommandDispatcher() { @@ -145,7 +145,7 @@ public final class World { /** * Gets the npc repository. - * + * * @return The npc repository. */ public MobRepository getNpcRepository() { @@ -155,7 +155,7 @@ public final class World { /** * Gets the {@link Player} with the specified username. Note that this will return {@code null} if the player is * offline. - * + * * @param username The username. * @return The player. */ @@ -165,7 +165,7 @@ public final class World { /** * Gets the player repository. - * + * * @return The player repository. */ public MobRepository getPlayerRepository() { @@ -174,7 +174,7 @@ public final class World { /** * Gets the plugin manager. - * + * * @return The plugin manager. */ public PluginManager getPluginManager() { @@ -183,7 +183,7 @@ public final class World { /** * Gets this world's {@link RegionRepository}. - * + * * @return The RegionRepository. */ public RegionRepository getRegionRepository() { @@ -192,7 +192,7 @@ public final class World { /** * Gets the release number of this world. - * + * * @return The release number. */ public int getReleaseNumber() { @@ -201,14 +201,14 @@ public final class World { /** * Initialises the world by loading definitions from the specified file system. - * + * * @param release The release number. * @param fs The file system. * @param manager The plugin manager. TODO move this. * @throws Exception If any definitions could not be loaded or there was a failure when loading plugins. */ public void init(int release, IndexedFileSystem fs, PluginManager manager) throws Exception { - this.releaseNumber = release; + releaseNumber = release; ItemDefinitionDecoder itemDecoder = new ItemDefinitionDecoder(fs); ItemDefinition[] items = itemDecoder.decode(); @@ -247,7 +247,7 @@ public final class World { /** * Checks if the {@link Player} with the specified name is online. - * + * * @param username The name. * @return {@code true} if the player is online, otherwise {@code false}. */ @@ -257,7 +257,7 @@ public final class World { /** * Adds an {@link EventListener}, listening for an {@link Event} of the specified type. - * + * * @param type The type of the Event. * @param listener The EventListener. */ @@ -274,7 +274,7 @@ public final class World { /** * Registers the specified npc. - * + * * @param npc The npc. * @return {@code true} if the npc registered successfully, otherwise {@code false}. */ @@ -296,7 +296,7 @@ public final class World { /** * Registers the specified player. - * + * * @param player The player. * @return A {@link RegistrationStatus}. */ @@ -320,7 +320,7 @@ public final class World { /** * Schedules a new task. - * + * * @param task The {@link ScheduledTask}. * @return {@code true} if the task was added successfully. */ @@ -331,7 +331,7 @@ public final class World { /** * Spawns the specified {@link Entity}, which must not be a {@link Player} or an {@link Npc}, which have their own * register methods. - * + * * @param entity The Entity. */ public void spawn(Entity entity) { @@ -344,7 +344,7 @@ public final class World { /** * Submits the specified {@link Event}, passing it to the listeners.. - * + * * @param event The Event. * @return {@code true} if the Event should proceed, {@code false} if not. */ @@ -354,7 +354,7 @@ public final class World { /** * Unregisters the specified {@link Npc}. - * + * * @param npc The npc. */ public void unregister(final Npc npc) { @@ -369,7 +369,7 @@ public final class World { /** * Unregisters the specified player. - * + * * @param player The player. */ public void unregister(final Player player) { @@ -386,7 +386,7 @@ public final class World { /** * Adds entities to regions in the {@link RegionRepository}. - * + * * @param entities The entities. */ private void placeEntities(Entity... entities) { diff --git a/src/org/apollo/game/model/WorldConstants.java b/src/org/apollo/game/model/WorldConstants.java index 24388fa5..b76c47e3 100644 --- a/src/org/apollo/game/model/WorldConstants.java +++ b/src/org/apollo/game/model/WorldConstants.java @@ -2,7 +2,7 @@ package org.apollo.game.model; /** * Holds world-related constants. - * + * * @author Graham */ public final class WorldConstants { diff --git a/src/org/apollo/game/model/area/EntityUpdateType.java b/src/org/apollo/game/model/area/EntityUpdateType.java index 4ce50c7c..4f7365fa 100644 --- a/src/org/apollo/game/model/area/EntityUpdateType.java +++ b/src/org/apollo/game/model/area/EntityUpdateType.java @@ -2,7 +2,7 @@ package org.apollo.game.model.area; /** * A type of update that an Entity in a {@link Region} may have. - * + * * @author Major */ public enum EntityUpdateType { diff --git a/src/org/apollo/game/model/area/Region.java b/src/org/apollo/game/model/area/Region.java index e5caff4b..1a7c3662 100644 --- a/src/org/apollo/game/model/area/Region.java +++ b/src/org/apollo/game/model/area/Region.java @@ -26,7 +26,7 @@ import com.google.common.collect.ImmutableSet; /** * An 8x8 area of the map. - * + * * @author Major */ public final class Region { @@ -92,7 +92,7 @@ public final class Region { /** * Creates a new Region. - * + * * @param x The x coordinate of the Region. * @param y The y coordinate of the Region. */ @@ -102,7 +102,7 @@ public final class Region { /** * Creates a new Region with the specified {@link RegionCoordinates}. - * + * * @param coordinates The coordinates. */ public Region(RegionCoordinates coordinates) { @@ -118,7 +118,7 @@ public final class Region { /** * Adds a {@link Entity} from to Region. Note that this does not spawn the Entity, or do any other action other than * register it to this Region. - * + * * @param entity The Entity. * @throws IllegalArgumentException If the Entity does not belong in this Region. */ @@ -129,7 +129,7 @@ public final class Region { Set local = entities.computeIfAbsent(position, key -> new HashSet<>(DEFAULT_SET_SIZE)); local.add(entity); - if ((System.currentTimeMillis() - start) / 1000 > 10 && (entity instanceof GameObject)) { + if ((System.currentTimeMillis() - start) / 1000 > 10 && entity instanceof GameObject) { System.out.println("Adding entity " + entity + " to " + entity.getPosition()); } @@ -140,7 +140,7 @@ public final class Region { * Checks if this Region contains the specified Entity. *

* This method operates in constant time. - * + * * @param entity The Entity. * @return {@code true} if this Region contains the Entity, otherwise {@code false}. */ @@ -153,7 +153,7 @@ public final class Region { /** * Gets this Region's {@link RegionCoordinates}. - * + * * @return The Region coordinates. */ public RegionCoordinates getCoordinates() { @@ -163,20 +163,20 @@ public final class Region { /** * Gets a shallow copy of the {@link Set} of {@link Entity} objects at the specified {@link Position}. The returned * type will be immutable. - * + * * @param position The position containing the entities. * @return The list. */ public Set getEntities(Position position) { Set set = entities.get(position); - return (set == null) ? ImmutableSet.of() : ImmutableSet.copyOf(set); + return set == null ? ImmutableSet.of() : ImmutableSet.copyOf(set); } /** * Gets a shallow copy of the {@link Set} of {@link Entity}s with the specified {@link EntityType}(s). The returned * type will be immutable. Type will be inferred from the call, so ensure that the Entity type and the reference * correspond, or this method will fail at runtime. - * + * * @param position The {@link Position} containing the entities. * @param types The {@link EntityType}s. * @return The set of entities. @@ -195,7 +195,7 @@ public final class Region { /** * Gets the {@link CollisionMatrix} at the specified height level. - * + * * @param height The height level. * @return The CollisionMatrix. */ @@ -206,7 +206,7 @@ public final class Region { /** * Gets a {@link Set} containing {@link RegionUpdateMessage}s that add every {@link Entity} in this Region. - * + * * @param height The height level to get the Set of RegionUpdateMessages for. * @return The Set of RegionUpdateMessages. */ @@ -219,12 +219,12 @@ public final class Region { /** * Gets the updates that have occurred in the last tick in this Region, as a {@link Set} of * {@link RegionUpdateMessage}s. - * + * * @param height The height level to get the Set of RegionUpdateMessages for. * @return The Set of RegionUpdateMessages. */ public List getUpdates(int height) { - List original = this.updates.get(height); + List original = updates.get(height); List updates = new ArrayList<>(original); original.clear(); @@ -234,7 +234,7 @@ public final class Region { /** * Notifies the {@link RegionListener}s registered to this Region that an update has occurred. - * + * * @param entity The {@link Entity} that was updated. * @param type The {@link EntityUpdateType} that occurred. */ @@ -244,7 +244,7 @@ public final class Region { /** * Removes a {@link Entity} from this Region. - * + * * @param entity The Entity. * @throws IllegalArgumentException If the Entity does not belong in this Region, or if it was never added. */ @@ -269,7 +269,7 @@ public final class Region { /** * Returns whether or not an Entity of the specified {@link EntityType type} can traverse the tile at the specified * coordinate pair. - * + * * @param position The {@link Position} of the tile. * @param entity The {@link EntityType}. * @param direction The {@link Direction} the Entity is approaching from. @@ -284,7 +284,7 @@ public final class Region { /** * Checks that the specified {@link Position} is included in this Region. - * + * * @param position The position. * @throws IllegalArgumentException If the specified position is not included in this Region. */ @@ -294,7 +294,7 @@ public final class Region { /** * Records the specified {@link Entity} as being updated this pulse. - * + * * @param entity The Entity. * @param type The {@link EntityUpdateType}. * @throws UnsupportedOperationException If the specified Entity cannot be operated on in this manner. diff --git a/src/org/apollo/game/model/area/RegionCoordinates.java b/src/org/apollo/game/model/area/RegionCoordinates.java index 68f4c66a..61a9b361 100644 --- a/src/org/apollo/game/model/area/RegionCoordinates.java +++ b/src/org/apollo/game/model/area/RegionCoordinates.java @@ -7,7 +7,7 @@ import com.google.common.base.MoreObjects; /** * An immutable class representing the coordinates of a region, where the coordinates ({@code x, y}) are the top-left of * the region. - * + * * @author Graham * @author Major */ @@ -15,7 +15,7 @@ public final class RegionCoordinates { /** * Gets the RegionCoordinates for the specified {@link Position}. - * + * * @param position The Position. * @return The RegionCoordinates. */ @@ -35,7 +35,7 @@ public final class RegionCoordinates { /** * Creates the RegionCoordinates. - * + * * @param x The x coordinate. * @param y The y coordinate. */ @@ -56,7 +56,7 @@ public final class RegionCoordinates { /** * Gets the absolute x coordinate of this Region (which can be compared directly against {@link Position#getX()}. - * + * * @return The absolute x coordinate. */ public int getAbsoluteX() { @@ -65,7 +65,7 @@ public final class RegionCoordinates { /** * Gets the absolute y coordinate of this Region (which can be compared directly against {@link Position#getY()}. - * + * * @return The absolute y coordinate. */ public int getAbsoluteY() { @@ -74,7 +74,7 @@ public final class RegionCoordinates { /** * Gets the x coordinate (equivalent to the {@link Position#getTopLeftRegionX()} of a position within this region). - * + * * @return The x coordinate. */ public int getX() { @@ -83,7 +83,7 @@ public final class RegionCoordinates { /** * Gets the y coordinate (equivalent to the {@link Position#getTopLeftRegionY()} of a position within this region). - * + * * @return The y coordinate. */ public int getY() { diff --git a/src/org/apollo/game/model/area/RegionListener.java b/src/org/apollo/game/model/area/RegionListener.java index 74feb692..1f65195a 100644 --- a/src/org/apollo/game/model/area/RegionListener.java +++ b/src/org/apollo/game/model/area/RegionListener.java @@ -5,7 +5,7 @@ import org.apollo.game.model.entity.Entity; /** * A class that should be implemented by listeners that execute actions when an entity is added, moved, or removed from * a region. - * + * * @author Major */ @FunctionalInterface @@ -13,7 +13,7 @@ public interface RegionListener { /** * Executes the action for this listener. - * + * * @param region The {@link Region} that was updated. * @param entity The affected {@link Entity}. * @param type The type of {@link EntityUpdateType}. diff --git a/src/org/apollo/game/model/area/RegionRepository.java b/src/org/apollo/game/model/area/RegionRepository.java index 4be8adf4..693ce8cd 100644 --- a/src/org/apollo/game/model/area/RegionRepository.java +++ b/src/org/apollo/game/model/area/RegionRepository.java @@ -12,7 +12,7 @@ import com.google.common.collect.ImmutableList; /** * A repository of {@link Region}s, backed by a {@link HashMap} of {@link RegionCoordinates} that correspond to their * appropriate regions. - * + * * @author Major */ public final class RegionRepository { @@ -22,7 +22,7 @@ public final class RegionRepository { *

* Note that, internally, regions are added lazily (i.e. only when necessary). As such, repositories are (again, * internally) not actually immutable, so do not rely on such behaviour. - * + * * @return The RegionRepository. */ public static RegionRepository immutable() { @@ -31,7 +31,7 @@ public final class RegionRepository { /** * Returns a mutable RegionRepository, where {@link Region}s may be removed. - * + * * @return The RegionRepository. */ public static RegionRepository mutable() { @@ -50,7 +50,7 @@ public final class RegionRepository { /** * Creates a new RegionRepository. - * + * * @param permitRemoval If removal (of {@link Region}s) from this repository should be permitted. */ private RegionRepository(boolean permitRemoval) { @@ -59,7 +59,7 @@ public final class RegionRepository { /** * Adds a {@link Region} to the repository. - * + * * @param region The Region. * @throws IllegalArgumentException If the provided Region is null. * @throws UnsupportedOperationException If the coordinates of the provided Region are already mapped (and hence the @@ -76,7 +76,7 @@ public final class RegionRepository { /** * Indicates whether the supplied value (i.e. the {@link Region}) has a mapping. - * + * * @param region The Region. * @return {@code true} if this repository contains an entry with {@link RegionCoordinates} equal to the specified * Region, otherwise {@code false}. @@ -87,7 +87,7 @@ public final class RegionRepository { /** * Indicates whether the supplied key (i.e. the {@link RegionCoordinates}) has a mapping. - * + * * @param coordinates The coordinates. * @return {@code true} if the key is already mapped to a value (i.e. a {@link Region}), otherwise {@code false}. */ @@ -98,7 +98,7 @@ public final class RegionRepository { /** * Gets the {@link Region} that contains the specified {@link Position}. If the Region does not exist in this * repository then a new Region is created, submitted to the repository, and returned. - * + * * @param position The position. * @return The Region. */ @@ -109,7 +109,7 @@ public final class RegionRepository { /** * Gets a {@link Region} with the specified {@link RegionCoordinates}. If the Region does not exist in this * repository then a new Region is created, submitted to the repository, and returned. - * + * * @param coordinates The RegionCoordinates. * @return The Region. Will never be null. */ @@ -125,7 +125,7 @@ public final class RegionRepository { /** * Gets a shallow copy of the {@link List} of {@link Region}s. This will be an {@link ImmutableList}. - * + * * @return The List. */ public List getRegions() { @@ -135,7 +135,7 @@ public final class RegionRepository { /** * Removes a {@link Region} from the repository, if permitted. This method removes the entry that has a key * identical to the {@link RegionCoordinates} of the specified Region. - * + * * @param region The Region to remove. * @return {@code true} if the specified Region existed and was removed, {@code false} if not. * @throws UnsupportedOperationException If this method is called on a repository that does not permit removal. diff --git a/src/org/apollo/game/model/area/collision/CollisionFlag.java b/src/org/apollo/game/model/area/collision/CollisionFlag.java index f680013c..55272db1 100644 --- a/src/org/apollo/game/model/area/collision/CollisionFlag.java +++ b/src/org/apollo/game/model/area/collision/CollisionFlag.java @@ -51,17 +51,17 @@ public enum CollisionFlag { /** * Returns an array of CollisionFlags that indicate if the specified {@link EntityType} can be positioned on a tile. - * + * * @param type The EntityType. * @return The array of CollisionFlags. */ public static CollisionFlag[] forType(EntityType type) { - return (type == EntityType.PROJECTILE) ? projectiles() : mobs(); + return type == EntityType.PROJECTILE ? projectiles() : mobs(); } /** * Returns an array of CollisionFlags that indicate if a Mob can be positioned on a tile. - * + * * @return The array of CollisionFlags. */ public static CollisionFlag[] mobs() { @@ -70,7 +70,7 @@ public enum CollisionFlag { /** * Returns an array of CollisionFlags that indicate if a Projectile can be positioned on a tile. - * + * * @return The array of CollisionFlags. */ public static CollisionFlag[] projectiles() { @@ -93,7 +93,7 @@ public enum CollisionFlag { /** * Gets this CollisionFlag, as a {@code byte}. - * + * * @return The value, as a {@code byte}. */ public byte asByte() { @@ -102,7 +102,7 @@ public enum CollisionFlag { /** * Gets the index of the bit this flag is stored in. - * + * * @return The index of the bit. */ public int getBit() { diff --git a/src/org/apollo/game/model/area/collision/CollisionMatrix.java b/src/org/apollo/game/model/area/collision/CollisionMatrix.java index 7c57c153..e2cd2204 100644 --- a/src/org/apollo/game/model/area/collision/CollisionMatrix.java +++ b/src/org/apollo/game/model/area/collision/CollisionMatrix.java @@ -27,7 +27,7 @@ public final class CollisionMatrix { /** * Creates an array of CollisionMatrix objects, all of the specified width and length. - * + * * @param count The length of the array to create. * @param width The width of each CollisionMatrix. * @param length The length of each CollisionMatrix. @@ -69,7 +69,7 @@ public final class CollisionMatrix { /** * Returns whether or not all of the specified {@link CollisionFlag}s are set for the specified * coordinate pair. - * + * * @param x The x coordinate. * @param y The y coordinate. * @param flags The CollisionFlags. @@ -88,7 +88,7 @@ public final class CollisionMatrix { /** * Returns whether or not any of the specified {@link CollisionFlag}s are set for the specified * coordinate pair. - * + * * @param x The x coordinate. * @param y The y coordinate. * @param flags The CollisionFlags. @@ -106,7 +106,7 @@ public final class CollisionMatrix { /** * Completely blocks the tile at the specified coordinate pair. - * + * * @param x The x coordinate. * @param y The y coordinate. */ @@ -117,7 +117,7 @@ public final class CollisionMatrix { /** * Clears (i.e. sets to {@code false}) the value of the specified {@link CollisionFlag} for the specified coordinate * pair. - * + * * @param x The x coordinate. * @param y The y coordinate. * @param flag The CollisionFlag. @@ -128,7 +128,7 @@ public final class CollisionMatrix { /** * Returns whether or not the specified {@link CollisionFlag} is set for the specified coordinate pair. - * + * * @param x The x coordinate. * @param y The y coordinate. * @param flag The CollisionFlag. @@ -140,7 +140,7 @@ public final class CollisionMatrix { /** * Gets the value of the specified tile. - * + * * @param x The x coordinate of the tile. * @param y The y coordinate of the tile. * @return The value. @@ -151,7 +151,7 @@ public final class CollisionMatrix { /** * Resets the cell of the specified coordinate pair. - * + * * @param x The x coordinate. * @param y The y coordinate. */ @@ -161,7 +161,7 @@ public final class CollisionMatrix { /** * Sets the appropriate index for the specified coordinate pair to the specified value. - * + * * @param x The x coordinate. * @param y The y coordinate. * @param value The value. @@ -173,7 +173,7 @@ public final class CollisionMatrix { /** * Sets (i.e. sets to {@code true}) the value of the specified {@link CollisionFlag} for the specified coordinate * pair. - * + * * @param x The x coordinate. * @param y The y coordinate. * @param flag The CollisionFlag. @@ -190,7 +190,7 @@ public final class CollisionMatrix { /** * Returns whether or not an Entity of the specified {@link EntityType type} cannot traverse the tile at the * specified coordinate pair. - * + * * @param x The x coordinate. * @param y The y coordinate. * @param entity The {@link EntityType}. @@ -225,7 +225,7 @@ public final class CollisionMatrix { /** * Gets the index in the matrix for the specified coordinate pair. - * + * * @param x The x coordinate. * @param y The y coordinate. * @return The index. diff --git a/src/org/apollo/game/model/area/update/UpdateOperation.java b/src/org/apollo/game/model/area/update/UpdateOperation.java index 32127e5b..b2053b9e 100644 --- a/src/org/apollo/game/model/area/update/UpdateOperation.java +++ b/src/org/apollo/game/model/area/update/UpdateOperation.java @@ -13,7 +13,7 @@ import com.google.common.base.Preconditions; /** * An type that is contained in the snapshot of a {@link Region}, which consists of an {@link Entity} being added, * removed, or moved. - * + * * @author Major * @param The type of {@link Entity} in this type. */ @@ -49,7 +49,7 @@ public abstract class UpdateOperation { /** * Returns this UpdateOperation as a {@link Message}. - * + * * @return The Message. */ public final RegionUpdateMessage toMessage() { @@ -67,7 +67,7 @@ public abstract class UpdateOperation { /** * Returns a {@link RegionUpdateMessage} that adds the {@link Entity} in this UpdateOperation. - * + * * @param offset The offset of the {@link Position} of the Entity from the Position of the {@link Region}. * @return The RegionUpdateMessage. */ @@ -75,7 +75,7 @@ public abstract class UpdateOperation { /** * Returns a {@link RegionUpdateMessage} that removes the {@link Entity} in this UpdateOperation. - * + * * @param offset The offset of the {@link Position} of the Entity from the Position of the {@link Region}. * @return The RegionUpdateMessage. */ @@ -83,7 +83,7 @@ public abstract class UpdateOperation { /** * Gets the position offset for the specified {@link Position}. - * + * * @param position The Position. * @return The position offset. */ @@ -95,7 +95,7 @@ public abstract class UpdateOperation { Preconditions.checkArgument(dx >= 0 && dx < Region.SIZE, position + " not in expected Region of " + region + "."); Preconditions.checkArgument(dy >= 0 && dy < Region.SIZE, position + " not in expected Region of " + region + "."); - return (dx << 4) | dy; + return dx << 4 | dy; } } \ No newline at end of file diff --git a/src/org/apollo/game/model/def/EquipmentDefinition.java b/src/org/apollo/game/model/def/EquipmentDefinition.java index 84e66d69..914782dd 100644 --- a/src/org/apollo/game/model/def/EquipmentDefinition.java +++ b/src/org/apollo/game/model/def/EquipmentDefinition.java @@ -10,7 +10,7 @@ import com.google.common.base.Preconditions; /** * Represents a type of {@link Item} which may be equipped. - * + * * @author Graham */ public final class EquipmentDefinition { @@ -22,7 +22,7 @@ public final class EquipmentDefinition { /** * Gets the total number of equipment definitions. - * + * * @return The count. */ public static int count() { @@ -31,7 +31,7 @@ public final class EquipmentDefinition { /** * Initialises the equipment definitions. - * + * * @param definitions The definitions. * @throws RuntimeException If there is an id mismatch. */ @@ -49,7 +49,7 @@ public final class EquipmentDefinition { /** * Gets an equipment definition by its id. - * + * * @param id The id. * @return {@code null} if the item is not equipment, the definition otherwise. * @throws IndexOutOfBoundsException If the id is out of bounds. @@ -67,7 +67,7 @@ public final class EquipmentDefinition { /** * The array of skill requirement levels. */ - private int[] levels = { 1, 1, 1, 1, 1, 1, 1 }; + private final int[] levels = { 1, 1, 1, 1, 1, 1, 1 }; /** * The slot this equipment goes into. @@ -81,7 +81,7 @@ public final class EquipmentDefinition { /** * Creates a new equipment definition. - * + * * @param id The id. */ public EquipmentDefinition(int id) { @@ -90,7 +90,7 @@ public final class EquipmentDefinition { /** * Gets the minimum attack level required to equip this item. - * + * * @return The level. */ public int getAttackLevel() { @@ -99,7 +99,7 @@ public final class EquipmentDefinition { /** * Gets the minimum defence level required to equip this item. - * + * * @return The level. */ public int getDefenceLevel() { @@ -108,7 +108,7 @@ public final class EquipmentDefinition { /** * Gets the minimum hitpoints level required to equip this item. - * + * * @return The level. */ public int getHitpointsLevel() { @@ -117,7 +117,7 @@ public final class EquipmentDefinition { /** * Gets the id. - * + * * @return The id. */ public int getId() { @@ -126,7 +126,7 @@ public final class EquipmentDefinition { /** * Gets the minimum level required to equip this item for a specific skill. - * + * * @param skill The skill id. * @return The level. */ @@ -137,7 +137,7 @@ public final class EquipmentDefinition { /** * Gets the minimum magic level required to equip this item. - * + * * @return The level. */ public int getMagicLevel() { @@ -146,7 +146,7 @@ public final class EquipmentDefinition { /** * Gets the minimum prayer level required to equip this item. - * + * * @return The level. */ public int getPrayerLevel() { @@ -155,7 +155,7 @@ public final class EquipmentDefinition { /** * Gets the minimum ranged level required to equip this item. - * + * * @return The level. */ public int getRangedLevel() { @@ -164,7 +164,7 @@ public final class EquipmentDefinition { /** * Gets the target slot. - * + * * @return The target slot. */ public int getSlot() { @@ -173,7 +173,7 @@ public final class EquipmentDefinition { /** * Gets the minimum strength level required to equip this item. - * + * * @return The level. */ public int getStrengthLevel() { @@ -182,7 +182,7 @@ public final class EquipmentDefinition { /** * Checks if this equipment is a full body. - * + * * @return {@code true} if so, {@code false} if not. */ public boolean isFullBody() { @@ -191,7 +191,7 @@ public final class EquipmentDefinition { /** * Checks if this equipment is a full hat. - * + * * @return {@code true} if so, {@code false} if not. */ public boolean isFullHat() { @@ -200,7 +200,7 @@ public final class EquipmentDefinition { /** * Checks if this equipment is a full mask. - * + * * @return {@code true} if so, {@code false} if not. */ public boolean isFullMask() { @@ -209,7 +209,7 @@ public final class EquipmentDefinition { /** * Checks if this equipment is two-handed. - * + * * @return {@code true} if so, {@code false} if not. */ public boolean isTwoHanded() { @@ -218,7 +218,7 @@ public final class EquipmentDefinition { /** * Sets the flags. - * + * * @param twoHanded The two handed flag. * @param fullBody The full body flag. * @param fullHat The full hat flag. @@ -233,7 +233,7 @@ public final class EquipmentDefinition { /** * Sets the required levels. - * + * * @param attack The required attack level. * @param strength The required strength level. * @param defence The required defence level. @@ -246,7 +246,7 @@ public final class EquipmentDefinition { /** * Sets the required levels. - * + * * @param attack The required attack level. * @param strength The required strength level. * @param defence The required defence level. @@ -267,7 +267,7 @@ public final class EquipmentDefinition { /** * Sets the target slot. - * + * * @param slot The target slot. */ public void setSlot(int slot) { diff --git a/src/org/apollo/game/model/def/ItemDefinition.java b/src/org/apollo/game/model/def/ItemDefinition.java index bbbad0c2..015e1279 100644 --- a/src/org/apollo/game/model/def/ItemDefinition.java +++ b/src/org/apollo/game/model/def/ItemDefinition.java @@ -8,7 +8,7 @@ import com.google.common.collect.HashBiMap; /** * Represents a type of {@link Item}. - * + * * @author Graham */ public final class ItemDefinition { @@ -30,7 +30,7 @@ public final class ItemDefinition { /** * Gets the total number of item definitions. - * + * * @return The count. */ public static int count() { @@ -39,7 +39,7 @@ public final class ItemDefinition { /** * Gets the array of item definitions. - * + * * @return The definitions. */ public static ItemDefinition[] getDefinitions() { @@ -48,7 +48,7 @@ public final class ItemDefinition { /** * Initialises the class with the specified set of definitions. - * + * * @param definitions The definitions. * @throws RuntimeException If there is an id mismatch. */ @@ -68,7 +68,7 @@ public final class ItemDefinition { /** * Converts an item id to a noted id. - * + * * @param id The item id. * @return The noted id. */ @@ -82,7 +82,7 @@ public final class ItemDefinition { /** * Gets the item definition for the specified id. - * + * * @param id The id. * @return The definition. * @throws IndexOutOfBoundsException If the id is out of bounds. @@ -94,7 +94,7 @@ public final class ItemDefinition { /** * Converts a noted id to the normal item id. - * + * * @param id The note id. * @return The item id. */ @@ -114,7 +114,7 @@ public final class ItemDefinition { /** * The ground actions array. */ - private String[] groundActions = new String[5]; + private final String[] groundActions = new String[5]; /** * The item's id. @@ -124,7 +124,7 @@ public final class ItemDefinition { /** * The inventory actions array. */ - private String[] inventoryActions = new String[5]; + private final String[] inventoryActions = new String[5]; /** * A flag indicating if this item is members only. @@ -163,7 +163,7 @@ public final class ItemDefinition { /** * Creates an item definition with the default values. - * + * * @param id The item's id. */ public ItemDefinition(int id) { @@ -172,7 +172,7 @@ public final class ItemDefinition { /** * Gets the description of this item. - * + * * @return The item's description. */ public String getDescription() { @@ -181,7 +181,7 @@ public final class ItemDefinition { /** * Gets a ground action. - * + * * @param id The id. * @return The action. * @throws IndexOutOfBoundsException If the id is out of bounds. @@ -193,7 +193,7 @@ public final class ItemDefinition { /** * Gets this item's id. - * + * * @return The id. */ public int getId() { @@ -202,7 +202,7 @@ public final class ItemDefinition { /** * Gets an inventory action. - * + * * @param id The id. * @return The action. * @throws IndexOutOfBoundsException If the id is out of bounds. @@ -214,7 +214,7 @@ public final class ItemDefinition { /** * Gets this item's name. - * + * * @return The name. */ public String getName() { @@ -223,7 +223,7 @@ public final class ItemDefinition { /** * Gets this item's note graphic id. - * + * * @return The note graphic id. */ public int getNoteGraphicId() { @@ -232,7 +232,7 @@ public final class ItemDefinition { /** * Gets this item's note info id. - * + * * @return The note info id. */ public int getNoteInfoId() { @@ -241,7 +241,7 @@ public final class ItemDefinition { /** * Gets this item's team. - * + * * @return The team. */ public int getTeam() { @@ -250,7 +250,7 @@ public final class ItemDefinition { /** * Gets this item's value. - * + * * @return The value. */ public int getValue() { @@ -259,7 +259,7 @@ public final class ItemDefinition { /** * Checks if this item is members only. - * + * * @return {@code true} if so, {@code false} if not. */ public boolean isMembersOnly() { @@ -268,7 +268,7 @@ public final class ItemDefinition { /** * Checks if this item is a note. - * + * * @return {@code true} if so, {@code false} otherwise. */ public boolean isNote() { @@ -277,7 +277,7 @@ public final class ItemDefinition { /** * Checks if the item specified by this definition is stackable. - * + * * @return {@code true} if so, {@code false} if not. */ public boolean isStackable() { @@ -286,7 +286,7 @@ public final class ItemDefinition { /** * Sets this item's description. - * + * * @param description The description. */ public void setDescription(String description) { @@ -295,7 +295,7 @@ public final class ItemDefinition { /** * Sets a ground action. - * + * * @param id The id. * @param action The action. * @throws IndexOutOfBoundsException If the id is out of bounds. @@ -307,7 +307,7 @@ public final class ItemDefinition { /** * Sets an inventory action. - * + * * @param id The id. * @param action The action. * @throws IndexOutOfBoundsException If the id is out of bounds. @@ -319,7 +319,7 @@ public final class ItemDefinition { /** * Sets this item's members only flag. - * + * * @param members The flag. */ public void setMembersOnly(boolean members) { @@ -328,7 +328,7 @@ public final class ItemDefinition { /** * Sets this item's name. - * + * * @param name The name. */ public void setName(String name) { @@ -337,7 +337,7 @@ public final class ItemDefinition { /** * Sets this item's note graphic id. - * + * * @param noteGraphicId The note graphic id. */ public void setNoteGraphicId(int noteGraphicId) { @@ -346,7 +346,7 @@ public final class ItemDefinition { /** * Sets this item's note info id. - * + * * @param noteInfoId The note info id. */ public void setNoteInfoId(int noteInfoId) { @@ -355,7 +355,7 @@ public final class ItemDefinition { /** * Sets this item's stackable flag. - * + * * @param stackable The stackable flag. */ public void setStackable(boolean stackable) { @@ -364,7 +364,7 @@ public final class ItemDefinition { /** * Sets this item's team. - * + * * @param team The team. */ public void setTeam(int team) { @@ -373,7 +373,7 @@ public final class ItemDefinition { /** * sets this item's value. - * + * * @param value The value. */ public void setValue(int value) { @@ -382,7 +382,7 @@ public final class ItemDefinition { /** * Converts this item to a note, if possible. - * + * * @throws IllegalStateException If {@link ItemDefinition#isNote()} returns {@code false}. */ public void toNote() { diff --git a/src/org/apollo/game/model/def/NpcDefinition.java b/src/org/apollo/game/model/def/NpcDefinition.java index 3ddd77b4..ea9047cd 100644 --- a/src/org/apollo/game/model/def/NpcDefinition.java +++ b/src/org/apollo/game/model/def/NpcDefinition.java @@ -6,7 +6,7 @@ import com.google.common.base.Preconditions; /** * Represents a type of {@link Npc}. - * + * * @author Chris Fletcher */ public final class NpcDefinition { @@ -18,7 +18,7 @@ public final class NpcDefinition { /** * Gets the total number of npc definitions. - * + * * @return The count. */ public static int count() { @@ -27,7 +27,7 @@ public final class NpcDefinition { /** * Gets the array of npc definitions. - * + * * @return The definitions. */ public static NpcDefinition[] getDefinitions() { @@ -36,7 +36,7 @@ public final class NpcDefinition { /** * Initialises the class with the specified set of definitions. - * + * * @param definitions The definitions. * @throws RuntimeException If there is an id mismatch. */ @@ -52,7 +52,7 @@ public final class NpcDefinition { /** * Gets the npc definition for the specified id. - * + * * @param id The id. * @return The definition. * @throws IndexOutOfBoundsException If the id is out of bounds. @@ -80,7 +80,7 @@ public final class NpcDefinition { /** * An array of interaction options. */ - private String[] interactions = new String[5]; + private final String[] interactions = new String[5]; /** * The name of the npc. @@ -99,7 +99,7 @@ public final class NpcDefinition { /** * Creates a new npc definition. - * + * * @param id The npc id. */ public NpcDefinition(int id) { @@ -108,7 +108,7 @@ public final class NpcDefinition { /** * Gets the npc's combat level. - * + * * @return The combat level, or -1 if it doesn't have one. */ public int getCombatLevel() { @@ -117,7 +117,7 @@ public final class NpcDefinition { /** * Gets the description of the npc. - * + * * @return The description. */ public String getDescription() { @@ -126,7 +126,7 @@ public final class NpcDefinition { /** * Gets the npc id. - * + * * @return The npc id. */ public int getId() { @@ -135,7 +135,7 @@ public final class NpcDefinition { /** * Gets an interaction option. - * + * * @param slot The slot of the option. * @return The option, or {@code null} if there isn't any at the specified slot. * @throws IndexOutOfBoundsException If the slot is out of bounds. @@ -147,7 +147,7 @@ public final class NpcDefinition { /** * Gets the array of interaction options. - * + * * @return The interaction options. */ public String[] getInteractions() { @@ -156,7 +156,7 @@ public final class NpcDefinition { /** * Gets the name of the npc. - * + * * @return The name of the npc. */ public String getName() { @@ -165,7 +165,7 @@ public final class NpcDefinition { /** * Gets the npc's size, in tiles. - * + * * @return The size. */ public int getSize() { @@ -174,7 +174,7 @@ public final class NpcDefinition { /** * Gets the id of the npc's standing animation. - * + * * @return The stand animation id, or -1 if it doesn't have one. */ public int getStandAnimation() { @@ -183,7 +183,7 @@ public final class NpcDefinition { /** * Gets the walking animation of the npc. - * + * * @return The walking animation. */ public int getWalkAnimation() { @@ -192,7 +192,7 @@ public final class NpcDefinition { /** * Gets the walk-back animation of the npc. - * + * * @return The walk-back animation. */ public int getWalkBackAnimation() { @@ -201,7 +201,7 @@ public final class NpcDefinition { /** * Gets the walk-left animation of the npc. - * + * * @return The walk-left animation. */ public int getWalkLeftAnimation() { @@ -210,7 +210,7 @@ public final class NpcDefinition { /** * Gets the walk-right animation of the npc. - * + * * @return The walk-right animation. */ public int getWalkRightAnimation() { @@ -219,7 +219,7 @@ public final class NpcDefinition { /** * Checks if the npc has a combat level. - * + * * @return {@code true} if so, {@code false} if not. */ public boolean hasCombatLevel() { @@ -228,7 +228,7 @@ public final class NpcDefinition { /** * Checks if there is an interaction option present. - * + * * @param slot The slot to check. * @return {@code true} if so, {@code false} if not. * @throws IndexOutOfBoundsException If the slot is out of bounds. @@ -240,7 +240,7 @@ public final class NpcDefinition { /** * Checks if the npc has a standing animation id. - * + * * @return {@code true} if so, {@code false} if not. */ public boolean hasStandAnimation() { @@ -249,7 +249,7 @@ public final class NpcDefinition { /** * Checks if the npc has a walking animation. - * + * * @return {@code true} if so, {@code false} if not. */ public boolean hasWalkAnimation() { @@ -258,7 +258,7 @@ public final class NpcDefinition { /** * Checks if the npc has a walk-back animation. - * + * * @return {@code true} if so, {@code false} if not. */ public boolean hasWalkBackAnimation() { @@ -267,7 +267,7 @@ public final class NpcDefinition { /** * Checks if the npc has a walk-left animation. - * + * * @return {@code true} if so, {@code false} if not. */ public boolean hasWalkLeftAnimation() { @@ -276,7 +276,7 @@ public final class NpcDefinition { /** * Checks if the npc has a walk-right animation. - * + * * @return {@code true} if so, {@code false} if not. */ public boolean hasWalkRightAnimation() { @@ -285,7 +285,7 @@ public final class NpcDefinition { /** * Sets the npc's combat level. - * + * * @param combatLevel The combat level. */ public void setCombatLevel(int combatLevel) { @@ -294,7 +294,7 @@ public final class NpcDefinition { /** * Sets the description of the npc. - * + * * @param description The description. */ public void setDescription(String description) { @@ -303,7 +303,7 @@ public final class NpcDefinition { /** * Sets an interaction option. - * + * * @param slot The slot of the option. * @param interaction The interaction options. * @throws IndexOutOfBoundsException If the slot is out of bounds. @@ -315,7 +315,7 @@ public final class NpcDefinition { /** * Sets the name of the npc. - * + * * @param name The name. */ public void setName(String name) { @@ -324,7 +324,7 @@ public final class NpcDefinition { /** * Sets the size of the npc, in tiles. - * + * * @param size The size. */ public void setSize(int size) { @@ -333,7 +333,7 @@ public final class NpcDefinition { /** * Sets the id of the npc's standing animation. - * + * * @param standAnim The stand animation id. */ public void setStandAnimation(int standAnim) { @@ -342,7 +342,7 @@ public final class NpcDefinition { /** * Sets the walking animation of the npc. - * + * * @param walkAnim The walking animation. */ public void setWalkAnimation(int walkAnim) { @@ -351,7 +351,7 @@ public final class NpcDefinition { /** * Sets the various walking animations of the npc. - * + * * @param walkAnim The walking animation. * @param walkBackAnim The walk-back animation. * @param walkLeftAnim The walk-left animation. diff --git a/src/org/apollo/game/model/def/ObjectDefinition.java b/src/org/apollo/game/model/def/ObjectDefinition.java index 79de4d50..2c770023 100644 --- a/src/org/apollo/game/model/def/ObjectDefinition.java +++ b/src/org/apollo/game/model/def/ObjectDefinition.java @@ -6,7 +6,7 @@ import com.google.common.base.Preconditions; /** * Represents a type of {@link GameObject}. - * + * * @author Major */ public final class ObjectDefinition { @@ -18,7 +18,7 @@ public final class ObjectDefinition { /** * Gets the total number of object definitions. - * + * * @return The count. */ public static int count() { @@ -27,7 +27,7 @@ public final class ObjectDefinition { /** * Gets the array of object definitions. - * + * * @return The definitions. */ public static ObjectDefinition[] getDefinitions() { @@ -36,7 +36,7 @@ public final class ObjectDefinition { /** * Initialises the object definitions. - * + * * @param definitions The decoded definitions. * @throws RuntimeException If there is an id mismatch. */ @@ -52,7 +52,7 @@ public final class ObjectDefinition { /** * Gets the object definition for the specified id. - * + * * @param id The id of the object. * @return The definition. * @throws IndexOutOfBoundsException If the id is out of bounds. @@ -114,7 +114,7 @@ public final class ObjectDefinition { /** * Creates a new object definition. - * + * * @param id The id of the object. */ public ObjectDefinition(int id) { @@ -123,7 +123,7 @@ public final class ObjectDefinition { /** * Gets the description of this object. - * + * * @return The description. */ public String getDescription() { @@ -132,7 +132,7 @@ public final class ObjectDefinition { /** * Gets the id of this object. - * + * * @return The id. */ public int getId() { @@ -141,7 +141,7 @@ public final class ObjectDefinition { /** * Gets the length of this object. - * + * * @return The length. */ public int getLength() { @@ -150,7 +150,7 @@ public final class ObjectDefinition { /** * Gets the menu actions of this object. - * + * * @return The menu actions. */ public String[] getMenuActions() { @@ -159,7 +159,7 @@ public final class ObjectDefinition { /** * Gets the name of this object. - * + * * @return The name. */ public String getName() { @@ -168,7 +168,7 @@ public final class ObjectDefinition { /** * Gets the with of this object. - * + * * @return The width. */ public int getWidth() { @@ -177,7 +177,7 @@ public final class ObjectDefinition { /** * Indicates the impenetrability of this object. - * + * * @return {@code true} if this object is impenetrable, otherwise {@code false}. */ public boolean isImpenetrable() { @@ -186,7 +186,7 @@ public final class ObjectDefinition { /** * Indicates the interactivity of this object. - * + * * @return {@code true} if the object is interactive, otherwise {@code false}. */ public boolean isInteractive() { @@ -195,7 +195,7 @@ public final class ObjectDefinition { /** * Indicates whether or not this object obstructs the ground. - * + * * @return {@code true} if the object obstructs the ground otherwise {@code false}. */ public boolean isObstructive() { @@ -204,7 +204,7 @@ public final class ObjectDefinition { /** * Indicates the solidity of this object. - * + * * @return {@code true} if this object is solid, otherwise {@code false}. */ public boolean isSolid() { @@ -213,7 +213,7 @@ public final class ObjectDefinition { /** * Sets the description of this object. - * + * * @param description The description. */ public void setDescription(String description) { @@ -222,7 +222,7 @@ public final class ObjectDefinition { /** * Sets the impenetrability of this object. - * + * * @param impenetrable The impenetrability. */ public void setImpenetrable(boolean impenetrable) { @@ -231,7 +231,7 @@ public final class ObjectDefinition { /** * Sets the interactivity of this object. - * + * * @param interactive The interactivity. */ public void setInteractive(boolean interactive) { @@ -240,7 +240,7 @@ public final class ObjectDefinition { /** * Sets the length of this object. - * + * * @param length The length. */ public void setLength(int length) { @@ -249,7 +249,7 @@ public final class ObjectDefinition { /** * Sets the menu actions of this object. - * + * * @param menuActions The menu actions. */ public void setMenuActions(String[] menuActions) { @@ -258,7 +258,7 @@ public final class ObjectDefinition { /** * Sets the name of this object. - * + * * @param name The name. */ public void setName(String name) { @@ -267,7 +267,7 @@ public final class ObjectDefinition { /** * Sets the solidity of this object. - * + * * @param solid The solidity. */ public void setSolid(boolean solid) { @@ -276,7 +276,7 @@ public final class ObjectDefinition { /** * Sets the width of this object. - * + * * @param width The width. */ public void setWidth(int width) { @@ -285,7 +285,7 @@ public final class ObjectDefinition { /** * Sets whether or not this object is obstructive to the ground. - * + * * @param obstructive Whether or not this object obstructs the ground. */ public void setObstructive(boolean obstructive) { diff --git a/src/org/apollo/game/model/entity/Entity.java b/src/org/apollo/game/model/entity/Entity.java index af0f6f78..574fd464 100644 --- a/src/org/apollo/game/model/entity/Entity.java +++ b/src/org/apollo/game/model/entity/Entity.java @@ -8,7 +8,7 @@ import org.apollo.game.model.area.update.UpdateOperation; /** * Represents an in-game entity, such as a mob, object, projectile, etc. - * + * * @author Major */ public abstract class Entity { @@ -50,7 +50,7 @@ public abstract class Entity { /** * Returns whether or not this EntityType is for a Mob. - * + * * @return {@code true} if this EntityType is for a Mob, otherwise {@code false}. */ public boolean isMob() { @@ -71,7 +71,7 @@ public abstract class Entity { /** * Creates the Entity. - * + * * @param world The {@link World} containing the Entity. * @param position The {@link Position} of the Entity. */ @@ -85,14 +85,14 @@ public abstract class Entity { /** * Gets the {@link EntityType} of this entity. - * + * * @return The entity type. */ public abstract EntityType getEntityType(); /** * Gets the {@link Position} of this entity. - * + * * @return The position. */ public final Position getPosition() { @@ -101,7 +101,7 @@ public abstract class Entity { /** * Gets the {@link World} this Entity is in. - * + * * @return The World. */ public World getWorld() { @@ -113,7 +113,7 @@ public abstract class Entity { /** * Gets this Entity, as an {@link UpdateOperation} of a {@link Region}. - * + * * @param region The Region. * @param type The EntityUpdateType. * @return The UpdateOperation. diff --git a/src/org/apollo/game/model/entity/EquipmentConstants.java b/src/org/apollo/game/model/entity/EquipmentConstants.java index 13945d07..07cf3a6d 100644 --- a/src/org/apollo/game/model/entity/EquipmentConstants.java +++ b/src/org/apollo/game/model/entity/EquipmentConstants.java @@ -2,7 +2,7 @@ package org.apollo.game.model.entity; /** * Contains equipment-related constants. - * + * * @author Graham */ public final class EquipmentConstants { diff --git a/src/org/apollo/game/model/entity/GroundItem.java b/src/org/apollo/game/model/entity/GroundItem.java index 0a0ce3de..b37c7707 100644 --- a/src/org/apollo/game/model/entity/GroundItem.java +++ b/src/org/apollo/game/model/entity/GroundItem.java @@ -52,7 +52,7 @@ public final class GroundItem extends Entity { /** * Creates the GroundItem. - * + * * @param world The {@link World} containing the GroundItem. * @param position The {@link Position} of the GroundItem. * @param item The Item displayed on the ground. @@ -81,7 +81,7 @@ public final class GroundItem extends Entity { /** * Gets the {@link Item} displayed on the ground. - * + * * @return The Item. */ public Item getItem() { @@ -91,7 +91,7 @@ public final class GroundItem extends Entity { /** * Gets the index of the {@link Player} who dropped this GroundItem, or {@code -1} if this GroundItem was not * dropped by a Player. - * + * * @return The index. */ public int getOwnerIndex() { diff --git a/src/org/apollo/game/model/entity/Mob.java b/src/org/apollo/game/model/entity/Mob.java index 1a3e1efd..6beb6851 100644 --- a/src/org/apollo/game/model/entity/Mob.java +++ b/src/org/apollo/game/model/entity/Mob.java @@ -29,7 +29,7 @@ import org.apollo.game.sync.block.SynchronizationBlockSet; /** * A {@link Mob} is a living entity in the world, such as a player or npc. - * + * * @author Graham * @author Major */ @@ -127,7 +127,7 @@ public abstract class Mob extends Entity { /** * Creates the Mob. - * + * * @param world The {@link World} containing the Mob * @param position The {@link Position} of the Mob. * @param definition The {@link NpcDefinition} of the Mob. @@ -141,7 +141,7 @@ public abstract class Mob extends Entity { /** * Deals damage to this mob. - * + * * @param damage The damage dealt. * @param type The type of damage. * @param secondary If the damage should be dealt as a secondary hit. @@ -156,7 +156,7 @@ public abstract class Mob extends Entity { /** * Gets the value of the attribute with the specified name. - * + * * @param name The name of the attribute. * @return The value of the attribute. */ @@ -166,7 +166,7 @@ public abstract class Mob extends Entity { /** * Gets a shallow copy of the attributes of this mob, as a {@link Map}. - * + * * @return The map of attributes. */ public final Map> getAttributes() { @@ -175,7 +175,7 @@ public abstract class Mob extends Entity { /** * Gets this mob's {@link SynchronizationBlockSet}. - * + * * @return The block set. */ public final SynchronizationBlockSet getBlockSet() { @@ -184,7 +184,7 @@ public abstract class Mob extends Entity { /** * Gets this mob's {@link NpcDefinition}. - * + * * @return The npc definition. */ public final NpcDefinition getDefinition() { @@ -193,7 +193,7 @@ public abstract class Mob extends Entity { /** * Gets this mob's movement {@link Direction}s, as an array. - * + * * @return A zero, one or two element array containing the directions (in order). */ public final Direction[] getDirections() { @@ -207,7 +207,7 @@ public abstract class Mob extends Entity { /** * Gets this mob's equipment. - * + * * @return The mob's equipment. */ public final Inventory getEquipment() { @@ -216,7 +216,7 @@ public abstract class Mob extends Entity { /** * Gets the {@link Position} this mob is facing towards. - * + * * @return The position. */ public final Position getFacingPosition() { @@ -225,7 +225,7 @@ public abstract class Mob extends Entity { /** * Gets the first {@link Direction}. - * + * * @return The direction. */ public final Direction getFirstDirection() { @@ -234,7 +234,7 @@ public abstract class Mob extends Entity { /** * Gets the index of this mob. - * + * * @return The index. */ public final int getIndex() { @@ -245,7 +245,7 @@ public abstract class Mob extends Entity { /** * Gets the mob this mob is interacting with. - * + * * @return The mob. */ public final Mob getInteractingMob() { @@ -254,7 +254,7 @@ public abstract class Mob extends Entity { /** * Returns this mobs interacting index. - * + * * @return The interaction index of this mob. */ public int getInteractionIndex() { @@ -263,7 +263,7 @@ public abstract class Mob extends Entity { /** * Gets this mob's inventory. - * + * * @return The inventory. */ public final Inventory getInventory() { @@ -272,7 +272,7 @@ public abstract class Mob extends Entity { /** * Gets this mob's local npc {@link List}. - * + * * @return The list. */ public final List getLocalNpcList() { @@ -281,7 +281,7 @@ public abstract class Mob extends Entity { /** * Gets this mob's local player {@link List}. - * + * * @return The list. */ public final List getLocalPlayerList() { @@ -290,7 +290,7 @@ public abstract class Mob extends Entity { /** * Gets this mob's second movement {@link Direction}. - * + * * @return The direction. */ public final Direction getSecondDirection() { @@ -299,7 +299,7 @@ public abstract class Mob extends Entity { /** * Gets this mob's {@link SkillSet}. - * + * * @return The skill set. */ public final SkillSet getSkillSet() { @@ -308,7 +308,7 @@ public abstract class Mob extends Entity { /** * Gets this mob's {@link WalkingQueue}. - * + * * @return The walking queue. */ public final WalkingQueue getWalkingQueue() { @@ -317,7 +317,7 @@ public abstract class Mob extends Entity { /** * Returns whether or not this mob has an {@link NpcDefinition}. - * + * * @return {@code true} if this mob has an npc definition, {@code false} if not. */ public final boolean hasNpcDefinition() { @@ -326,7 +326,7 @@ public abstract class Mob extends Entity { /** * Checks if this mob is active. - * + * * @return {@code true} if the mob is active, {@code false} if not. */ public final boolean isActive() { @@ -335,7 +335,7 @@ public abstract class Mob extends Entity { /** * Checks if this mob is currently teleporting. - * + * * @return {@code true} if so, {@code false} if not. */ public final boolean isTeleporting() { @@ -344,7 +344,7 @@ public abstract class Mob extends Entity { /** * Makes this mob perform the specified {@link Animation}. - * + * * @param animation The animation. */ public final void playAnimation(Animation animation) { @@ -353,7 +353,7 @@ public abstract class Mob extends Entity { /** * Makes this mob perform the specified {@link Graphic}. - * + * * @param graphic The graphic. */ public final void playGraphic(Graphic graphic) { @@ -377,7 +377,7 @@ public abstract class Mob extends Entity { /** * Sets the value of the attribute with the specified name. - * + * * @param name The name of the attribute. * @param value The attribute. */ @@ -387,7 +387,7 @@ public abstract class Mob extends Entity { /** * Sets this mob's {@link NpcDefinition}. - * + * * @param definition The definition. Must not be {@code null}. * @throws NullPointerException If the specified definition is {@code null}. */ @@ -397,7 +397,7 @@ public abstract class Mob extends Entity { /** * Sets the next movement {@link Direction}s for this mob. - * + * * @param first The first direction. * @param second The second direction. */ @@ -408,7 +408,7 @@ public abstract class Mob extends Entity { /** * Sets the index of this mob. - * + * * @param index The index. */ public final void setIndex(int index) { @@ -419,7 +419,7 @@ public abstract class Mob extends Entity { /** * Updates this mob's interacting mob. - * + * * @param mob The mob. */ public final void setInteractingMob(Mob mob) { @@ -433,7 +433,7 @@ public abstract class Mob extends Entity { * This method may be intercepted using a {@link MobPositionUpdateEvent}, which can be terminated like any other. * Plugins that intercept this Event must be cautious, because movement will not be possible (even * through mechanisms such as teleporting) if the Event is terminated. - * + * * @param position The Position. */ public final void setPosition(Position position) { @@ -451,7 +451,7 @@ public abstract class Mob extends Entity { /** * Sets whether this mob is teleporting or not. - * + * * @param teleporting {@code true} if the mob is teleporting, {@code false} if not. */ public final void setTeleporting(boolean teleporting) { @@ -460,7 +460,7 @@ public abstract class Mob extends Entity { /** * Forces this mob to shout a message. Only messages said by a player can be shown in the chat box. - * + * * @param message The message. * @param chatOnly If the message should only be shown in the player's chat box, or above their head too. */ @@ -470,7 +470,7 @@ public abstract class Mob extends Entity { /** * Starts a new action, stopping the current one if it exists. - * + * * @param action The new action. * @return A flag indicating if the action was started. */ @@ -514,7 +514,7 @@ public abstract class Mob extends Entity { /** * Teleports this mob to the specified {@link Position}, setting the appropriate flags and clearing the walking * queue. - * + * * @param position The position. */ public void teleport(Position position) { @@ -531,11 +531,11 @@ public abstract class Mob extends Entity { /** * Turns this mob to face the specified {@link Position}. - * + * * @param position The position to face. */ public final void turnTo(Position position) { - this.facingPosition = position; + facingPosition = position; blockSet.add(SynchronizationBlock.createTurnToPositionBlock(position)); } diff --git a/src/org/apollo/game/model/entity/Npc.java b/src/org/apollo/game/model/entity/Npc.java index e84249d0..640ae52f 100644 --- a/src/org/apollo/game/model/entity/Npc.java +++ b/src/org/apollo/game/model/entity/Npc.java @@ -12,7 +12,7 @@ import com.google.common.base.Preconditions; /** * A {@link Mob} that is not controlled by a player. - * + * * @author Major */ public final class Npc extends Mob { @@ -24,7 +24,7 @@ public final class Npc extends Mob { /** * Creates the Npc. - * + * * @param world The {@link World} containing the Npc. * @param id The id. * @param position The position. @@ -35,7 +35,7 @@ public final class Npc extends Mob { /** * Creates the Npc. - * + * * @param world The {@link World} containing the Npc. * @param position The Position. * @param definition The NpcDefinition. @@ -59,7 +59,7 @@ public final class Npc extends Mob { /** * Gets the boundaries of this Npc. - * + * * @return The boundaries. */ public Optional getBoundaries() { @@ -73,7 +73,7 @@ public final class Npc extends Mob { /** * Gets the id of this Npc. - * + * * @return The id. */ public int getId() { @@ -82,7 +82,7 @@ public final class Npc extends Mob { /** * Returns whether or not this Npc has boundaries. - * + * * @return {@code true} if this Npc has boundaries, {@code false} if not. */ public boolean hasBoundaries() { @@ -97,7 +97,7 @@ public final class Npc extends Mob { /** * Sets the boundaries of this Npc. - * + * * @param boundaries The boundaries. */ public void setBoundaries(Position[] boundaries) { @@ -112,7 +112,7 @@ public final class Npc extends Mob { /** * Transforms this Npc into the Npc with the specified id. - * + * * @param id The id. */ public void transform(int id) { diff --git a/src/org/apollo/game/model/entity/Player.java b/src/org/apollo/game/model/entity/Player.java index c3234520..09946cce 100644 --- a/src/org/apollo/game/model/entity/Player.java +++ b/src/org/apollo/game/model/entity/Player.java @@ -54,7 +54,7 @@ import com.google.common.base.Preconditions; /** * A {@link Player} is a {@link Mob} that a user is controlling. - * + * * @author Graham * @author Major */ @@ -88,7 +88,7 @@ public final class Player extends Mob { /** * This player's credentials. */ - private PlayerCredentials credentials; + private final PlayerCredentials credentials; /** * A flag which indicates there are npcs that couldn't be added. @@ -197,7 +197,7 @@ public final class Player extends Mob { /** * Creates the Player. - * + * * @param world The {@link World} containing the Player. * @param credentials The player's credentials. * @param position The initial position. @@ -211,7 +211,7 @@ public final class Player extends Mob { /** * Adds a click, represented by a {@link Point}, to the {@link List} of clicks. - * + * * @param point The point. * @return {@code true} if the point was added successfully. */ @@ -221,7 +221,7 @@ public final class Player extends Mob { /** * Adds the specified username to this player's friend list. - * + * * @param username The username. */ public void addFriend(String username) { @@ -230,7 +230,7 @@ public final class Player extends Mob { /** * Adds the specified username to this player's ignore list. - * + * * @param username The username. */ public void addIgnore(String username) { @@ -272,7 +272,7 @@ public final class Player extends Mob { /** * Indicates whether this player is friends with the player with the specified username or not. - * + * * @param username The username of the other player. * @return {@code true} if the specified username is on this player's friend list, otherwise {@code false}. */ @@ -282,7 +282,7 @@ public final class Player extends Mob { /** * Gets the player's appearance. - * + * * @return The appearance. */ public Appearance getAppearance() { @@ -291,7 +291,7 @@ public final class Player extends Mob { /** * Gets the mob's bank. - * + * * @return The bank. */ public Inventory getBank() { @@ -300,7 +300,7 @@ public final class Player extends Mob { /** * Gets this player's public chat privacy state. - * + * * @return The privacy state. */ public PrivacyState getChatPrivacy() { @@ -309,7 +309,7 @@ public final class Player extends Mob { /** * Gets the {@link Deque} of clicks. - * + * * @return The deque. */ public Deque getClicks() { @@ -318,7 +318,7 @@ public final class Player extends Mob { /** * Gets the value denoting the clients modified version (0 if it is an unmodified jagex client). - * + * * @return The version. */ public int getClientVersion() { @@ -328,7 +328,7 @@ public final class Player extends Mob { /** * Gets the player's credentials. - * + * * @return The player's credentials. */ public PlayerCredentials getCredentials() { @@ -337,7 +337,7 @@ public final class Player extends Mob { /** * Gets the player's name, encoded as a long. - * + * * @return The encoded player name. */ public long getEncodedName() { @@ -351,7 +351,7 @@ public final class Player extends Mob { /** * Gets this player's friend chat {@link PrivacyState}. - * + * * @return The privacy state. */ public PrivacyState getFriendPrivacy() { @@ -360,7 +360,7 @@ public final class Player extends Mob { /** * Gets the {@link List} of this player's friends. - * + * * @return The list. */ public List getFriendUsernames() { @@ -369,7 +369,7 @@ public final class Player extends Mob { /** * Gets the {@link List} of usernames of ignored players. - * + * * @return The list. */ public List getIgnoredUsernames() { @@ -383,7 +383,7 @@ public final class Player extends Mob { /** * Gets this player's interface set. - * + * * @return The interface set for this player. */ public InterfaceSet getInterfaceSet() { @@ -392,7 +392,7 @@ public final class Player extends Mob { /** * Gets this player's last click, represented by a {@link Point}. - * + * * @return The click. */ public Point getLastClick() { @@ -401,7 +401,7 @@ public final class Player extends Mob { /** * Gets the last known region. - * + * * @return The last known region, or {@code null} if the player has never known a region. */ public Position getLastKnownRegion() { @@ -410,7 +410,7 @@ public final class Player extends Mob { /** * Gets the {@link MembershipStatus} of this Player. - * + * * @return The MembershipStatus. */ public MembershipStatus getMembershipStatus() { @@ -419,7 +419,7 @@ public final class Player extends Mob { /** * Gets the player's prayer icon. - * + * * @return The prayer icon. */ public int getPrayerIcon() { @@ -428,7 +428,7 @@ public final class Player extends Mob { /** * Gets the privilege level. - * + * * @return The privilege level. */ public PrivilegeLevel getPrivilegeLevel() { @@ -437,7 +437,7 @@ public final class Player extends Mob { /** * Gets the player's run energy. - * + * * @return The run energy. */ public int getRunEnergy() { @@ -447,7 +447,7 @@ public final class Player extends Mob { /** * Gets this player's {@link ScreenBrightness}. - * + * * @return The screen brightness. */ public ScreenBrightness getScreenBrightness() { @@ -456,7 +456,7 @@ public final class Player extends Mob { /** * Gets the game session. - * + * * @return The game session. */ public GameSession getSession() { @@ -465,7 +465,7 @@ public final class Player extends Mob { /** * Gets this player's trade {@link PrivacyState}. - * + * * @return The privacy state. */ public PrivacyState getTradePrivacy() { @@ -474,7 +474,7 @@ public final class Player extends Mob { /** * Gets this player's name. - * + * * @return The name. */ public String getUsername() { @@ -483,7 +483,7 @@ public final class Player extends Mob { /** * Gets this player's viewing distance. - * + * * @return The viewing distance. */ public int getViewingDistance() { @@ -492,7 +492,7 @@ public final class Player extends Mob { /** * Gets the id of the world this player is in. - * + * * @return The id. */ public int getWorldId() { @@ -506,7 +506,7 @@ public final class Player extends Mob { /** * Indicates whether or not the player with the specified username is on this player's ignore list. - * + * * @param username The username of the player. * @return {@code true} if the player is ignored, {@code false} if not. */ @@ -516,7 +516,7 @@ public final class Player extends Mob { /** * Checks if this player has ever known a region. - * + * * @return {@code true} if so, {@code false} if not. */ public boolean hasLastKnownRegion() { @@ -525,7 +525,7 @@ public final class Player extends Mob { /** * Checks if the region has changed. - * + * * @return {@code true} if so, {@code false} if not. */ public boolean hasRegionChanged() { @@ -543,7 +543,7 @@ public final class Player extends Mob { /** * Checks if there are excessive npcs. - * + * * @return {@code true} if so, {@code false} if not. */ public boolean isExcessiveNpcsSet() { @@ -552,7 +552,7 @@ public final class Player extends Mob { /** * Checks if there are excessive players. - * + * * @return {@code true} if so, {@code false} if not. */ public boolean isExcessivePlayersSet() { @@ -561,7 +561,7 @@ public final class Player extends Mob { /** * Checks if this player has membership. - * + * * @return {@code true} if so, {@code false} if not. */ public boolean isMembers() { @@ -570,7 +570,7 @@ public final class Player extends Mob { /** * Checks if this player is running. - * + * * @return {@code true} if the player is running, otherwise {@code false}. */ public boolean isRunning() { @@ -579,7 +579,7 @@ public final class Player extends Mob { /** * Indicates whether or not the player is skulled - * + * * @return {@code true} if the player is skulled, otherwise {@code false}. */ public boolean isSkulled() { @@ -588,7 +588,7 @@ public final class Player extends Mob { /** * Checks if this player is withdrawing noted items. - * + * * @return {@code true} if the player is currently withdrawing notes, otherwise {@code false}. */ public boolean isWithdrawingNotes() { @@ -606,7 +606,7 @@ public final class Player extends Mob { /** * Indicates whether the message filter is enabled. - * + * * @return {@code true} if the filter is enabled, otherwise {@code false}. */ public boolean messageFilterEnabled() { @@ -631,7 +631,7 @@ public final class Player extends Mob { /** * Removes the specified username from this player's friend list. - * + * * @param username The username. * @return {@code true} if the player's friend list contained the specified user, {@code false} if not. */ @@ -641,7 +641,7 @@ public final class Player extends Mob { /** * Removes the specified username from this player's ignore list. - * + * * @param username The username. * @return {@code true} if the player's ignore list contained the specified user, {@code false} if not. */ @@ -665,7 +665,7 @@ public final class Player extends Mob { /** * Sends a {@link Message} to this player. - * + * * @param message The message.. */ public void send(Message message) { @@ -704,7 +704,7 @@ public final class Player extends Mob { /** * Sends a message to the player. - * + * * @param message The message. */ public void sendMessage(String message) { @@ -713,7 +713,7 @@ public final class Player extends Mob { /** * Sends a message to the player. - * + * * @param message The message. * @param filterable Whether or not the message can be filtered. */ @@ -727,7 +727,7 @@ public final class Player extends Mob { /** * Sends the quest interface - * + * * @param text The text to display on the interface. */ public void sendQuestInterface(List text) { @@ -756,7 +756,7 @@ public final class Player extends Mob { /** * Sets the player's appearance. - * + * * @param appearance The new appearance. */ public void setAppearance(Appearance appearance) { @@ -766,7 +766,7 @@ public final class Player extends Mob { /** * Sets the chat {@link PrivacyState}. - * + * * @param chatPrivacy The privacy state. */ public void setChatPrivacy(PrivacyState chatPrivacy) { @@ -775,7 +775,7 @@ public final class Player extends Mob { /** * Sets the value denoting the client's modified version. - * + * * @param version The client version. */ public void setClientVersion(int version) { @@ -784,7 +784,7 @@ public final class Player extends Mob { /** * Sets the friend {@link PrivacyState}. - * + * * @param friendPrivacy The privacy state. */ public void setFriendPrivacy(PrivacyState friendPrivacy) { @@ -793,7 +793,7 @@ public final class Player extends Mob { /** * Sets the {@link List} of this player's friends. - * + * * @param friends The friends. */ public void setFriendUsernames(List friends) { @@ -802,7 +802,7 @@ public final class Player extends Mob { /** * Sets the {@link List} of this player's ignored players. - * + * * @param ignores The ignored player list. */ public void setIgnoredUsernames(List ignores) { @@ -811,7 +811,7 @@ public final class Player extends Mob { /** * Sets the last known region. - * + * * @param lastKnownRegion The last known region. */ public void setLastKnownRegion(Position lastKnownRegion) { @@ -820,7 +820,7 @@ public final class Player extends Mob { /** * Changes the membership status of this player. - * + * * @param members The new membership flag. */ public void setMembers(MembershipStatus members) { @@ -829,7 +829,7 @@ public final class Player extends Mob { /** * Sets the player's prayer icon. TODO make this an attribute? - * + * * @param prayerIcon The prayer icon. */ public void setPrayerIcon(int prayerIcon) { @@ -838,7 +838,7 @@ public final class Player extends Mob { /** * Sets the privilege level. - * + * * @param privilegeLevel The privilege level. */ public void setPrivilegeLevel(PrivilegeLevel privilegeLevel) { @@ -847,7 +847,7 @@ public final class Player extends Mob { /** * Sets the region changed flag. - * + * * @param regionChanged A flag indicating if the region has changed. */ public void setRegionChanged(boolean regionChanged) { @@ -856,7 +856,7 @@ public final class Player extends Mob { /** * Sets the player's run energy. - * + * * @param energy The energy. */ public void setRunEnergy(int energy) { @@ -866,16 +866,16 @@ public final class Player extends Mob { /** * Sets the {@link ScreenBrightness} of this player. - * + * * @param brightness The screen brightness. */ public void setScreenBrightness(ScreenBrightness brightness) { - this.screenBrightness = brightness; + screenBrightness = brightness; } /** * Sets the player's {@link GameSession}. - * + * * @param session The player's {@link GameSession}. */ public void setSession(GameSession session) { @@ -884,7 +884,7 @@ public final class Player extends Mob { /** * Sets whether or not the player is skulled. TODO make this an attribute - * + * * @param isSkulled Whether or not the player is skulled. */ public void setSkulled(boolean isSkulled) { @@ -893,7 +893,7 @@ public final class Player extends Mob { /** * Sets the trade {@link PrivacyState}. - * + * * @param tradePrivacy The privacy state. */ public void setTradePrivacy(PrivacyState tradePrivacy) { @@ -902,7 +902,7 @@ public final class Player extends Mob { /** * Sets whether or not the player is withdrawing notes from the bank. - * + * * @param withdrawingNotes Whether or not the player is withdrawing noted items. */ public void setWithdrawingNotes(boolean withdrawingNotes) { @@ -924,7 +924,7 @@ public final class Player extends Mob { /** * Toggles the message filter. - * + * * @return The new value of the filter. */ public boolean toggleMessageFilter() { diff --git a/src/org/apollo/game/model/entity/Skill.java b/src/org/apollo/game/model/entity/Skill.java index 5db56e22..9bb08354 100644 --- a/src/org/apollo/game/model/entity/Skill.java +++ b/src/org/apollo/game/model/entity/Skill.java @@ -2,7 +2,7 @@ package org.apollo.game.model.entity; /** * Represents a single skill. - * + * * @author Graham */ public final class Skill { @@ -121,7 +121,7 @@ public final class Skill { /** * Gets the name of a skill. - * + * * @param id The skill's id. * @return The skill's name. */ @@ -131,7 +131,7 @@ public final class Skill { /** * Whether the skill affects the combat level or not. - * + * * @param skill The id of the skill. * @return {@code true} if the skill is a combat skill, otherwise {@code false}. */ @@ -142,10 +142,10 @@ public final class Skill { /** * Creates a skill from an existing skill, using the existing skill's experience and maximum level values, but the * specified current level. - * + * * @param currentLevel The current level. * @param skill The existing skill. - * + * * @return The new skill with the updated current level. */ public static Skill updateCurrentLevel(int currentLevel, Skill skill) { @@ -155,7 +155,7 @@ public final class Skill { /** * Creates a skill from an existing skill, using the existing skill's current and maximum level values, but the * specified experience. - * + * * @param experience The experience. * @param skill The existing skill. * @return The new skill with the updated experience. @@ -167,7 +167,7 @@ public final class Skill { /** * Creates a skill from an existing skill, using the existing skill's experience and current level values, but the * specified maximum level. - * + * * @param maximumLevel experience The maximum level. * @param skill The existing skill. * @return The new skill with the updated maximum level. @@ -193,7 +193,7 @@ public final class Skill { /** * Creates a skill. - * + * * @param experience The experience. * @param currentLevel The current level. * @param maximumLevel The maximum level. @@ -206,7 +206,7 @@ public final class Skill { /** * Gets the current level. - * + * * @return The current level. */ public int getCurrentLevel() { @@ -215,7 +215,7 @@ public final class Skill { /** * Gets the experience. - * + * * @return The experience. */ public double getExperience() { @@ -224,7 +224,7 @@ public final class Skill { /** * Gets the maximum level. - * + * * @return The maximum level. */ public int getMaximumLevel() { diff --git a/src/org/apollo/game/model/entity/SkillSet.java b/src/org/apollo/game/model/entity/SkillSet.java index 53523cee..8099ffcb 100644 --- a/src/org/apollo/game/model/entity/SkillSet.java +++ b/src/org/apollo/game/model/entity/SkillSet.java @@ -11,7 +11,7 @@ import com.google.common.primitives.Ints; /** * Represents the set of the player's skills. - * + * * @author Graham */ public final class SkillSet { @@ -42,7 +42,7 @@ public final class SkillSet { /** * Gets the minimum experience required for the specified level. - * + * * @param level The level. * @return The minimum experience. */ @@ -53,7 +53,7 @@ public final class SkillSet { /** * Gets the minimum level to get the specified experience. - * + * * @param experience The experience. * @return The minimum level. */ @@ -96,7 +96,7 @@ public final class SkillSet { /** * Adds experience to the specified skill. - * + * * @param id The skill id. * @param experience The amount of experience. */ @@ -121,7 +121,7 @@ public final class SkillSet { /** * Adds a {@link SkillListener} to this set. - * + * * @param listener The listener. */ public void addListener(SkillListener listener) { @@ -155,7 +155,7 @@ public final class SkillSet { /** * Gets the combat level of this skill set. - * + * * @return The combat level. */ public int getCombatLevel() { @@ -164,7 +164,7 @@ public final class SkillSet { /** * Gets the current level of the specified skill. - * + * * @param skill The skill. * @return The current level. */ @@ -174,7 +174,7 @@ public final class SkillSet { /** * Gets the experience of the specified skill. - * + * * @param skill The skill. * @return The experience. */ @@ -184,7 +184,7 @@ public final class SkillSet { /** * Gets the maximum level of the specified skill. - * + * * @param skill The skill. * @return The maximum level. */ @@ -194,7 +194,7 @@ public final class SkillSet { /** * Gets a skill by its id. - * + * * @param id The id. * @return The skill. */ @@ -205,7 +205,7 @@ public final class SkillSet { /** * Gets the total level for this skill set. - * + * * @return The total level. */ public int getTotalLevel() { @@ -223,7 +223,7 @@ public final class SkillSet { continue; } - current += (current < max ? 1 : -1); + current += current < max ? 1 : -1; setSkill(id, new Skill(skills[id].getExperience(), current, max)); } } @@ -237,7 +237,7 @@ public final class SkillSet { /** * Removes a {@link SkillListener}. - * + * * @param listener The listener to remove. */ public void removeListener(SkillListener listener) { @@ -246,7 +246,7 @@ public final class SkillSet { /** * Sets the current level of the specified skill. - * + * * @param skill The skill. * @param level The level. */ @@ -257,7 +257,7 @@ public final class SkillSet { /** * Sets the experience level of the specified skill. - * + * * @param skill The skill. * @param experience The experience. */ @@ -268,7 +268,7 @@ public final class SkillSet { /** * Sets the maximum level of the specified skill. - * + * * @param skill The skill. * @param level The level. */ @@ -279,7 +279,7 @@ public final class SkillSet { /** * Sets a {@link Skill}. - * + * * @param id The id. * @param skill The skill. */ @@ -291,7 +291,7 @@ public final class SkillSet { /** * Gets the number of {@link Skill}s in this set. - * + * * @return The number of skills. */ public int size() { @@ -314,7 +314,7 @@ public final class SkillSet { /** * Checks the bounds of the id. - * + * * @param id The id. * @throws IndexOutOfBoundsException If the id is out of bounds. */ @@ -331,7 +331,7 @@ public final class SkillSet { /** * Notifies listeners that a skill has been levelled up. - * + * * @param id The skill's id. */ private void notifyLevelledUp(int id) { @@ -352,7 +352,7 @@ public final class SkillSet { /** * Notifies listeners that a skill has been updated. - * + * * @param id The skill's id. */ private void notifySkillUpdated(int id) { diff --git a/src/org/apollo/game/model/entity/WalkingQueue.java b/src/org/apollo/game/model/entity/WalkingQueue.java index 0069b28e..8888598a 100644 --- a/src/org/apollo/game/model/entity/WalkingQueue.java +++ b/src/org/apollo/game/model/entity/WalkingQueue.java @@ -11,14 +11,14 @@ import com.google.common.base.MoreObjects; /** * A queue of {@link Direction}s which a {@link Mob} will follow. - * + * * @author Graham */ public final class WalkingQueue { /** * Represents a single point in the queue. - * + * * @author Graham */ private static final class Point { @@ -35,7 +35,7 @@ public final class WalkingQueue { /** * Creates a point. - * + * * @param position The position. * @param direction The direction. */ @@ -78,7 +78,7 @@ public final class WalkingQueue { /** * Creates a walking queue for the specified mob. - * + * * @param mob The mob. */ public WalkingQueue(Mob mob) { @@ -88,7 +88,7 @@ public final class WalkingQueue { /** * Adds the first step to the queue, attempting to connect the server and client position by looking at the previous * queue. - * + * * @param clientPosition The first step. * @return {@code true} if the queues could be connected correctly, {@code false} if not. */ @@ -134,7 +134,7 @@ public final class WalkingQueue { /** * Adds a step. - * + * * @param x The x coordinate of this step. * @param y The y coordinate of this step. */ @@ -159,7 +159,7 @@ public final class WalkingQueue { /** * Adds a step to the queue. - * + * * @param step The step to add. */ public void addStep(Position step) { @@ -198,7 +198,7 @@ public final class WalkingQueue { /** * Gets the last point. - * + * * @return The last point. */ private Point getLast() { @@ -235,7 +235,7 @@ public final class WalkingQueue { /** * Sets the running queue flag. - * + * * @param running The running queue flag. */ public void setRunningQueue(boolean running) { @@ -244,7 +244,7 @@ public final class WalkingQueue { /** * Gets the size of the queue. - * + * * @return The size of the queue. */ public int size() { diff --git a/src/org/apollo/game/model/entity/attr/Attribute.java b/src/org/apollo/game/model/entity/attr/Attribute.java index 6627b8a0..fbae8f08 100644 --- a/src/org/apollo/game/model/entity/attr/Attribute.java +++ b/src/org/apollo/game/model/entity/attr/Attribute.java @@ -2,7 +2,7 @@ package org.apollo.game.model.entity.attr; /** * An attribute belonging to an entity. - * + * * @author Major * * @param The type of attribute. @@ -22,7 +22,7 @@ public abstract class Attribute { /** * Creates the attribute with the specified {@link AttributeType} and value. - * + * * @param type The type. * @param value The value. */ @@ -33,14 +33,14 @@ public abstract class Attribute { /** * Encodes this Attribute into a byte array. - * + * * @return The byte array. */ public abstract byte[] encode(); /** * Gets the type of this attribute. - * + * * @return The type. */ public AttributeType getType() { @@ -49,7 +49,7 @@ public abstract class Attribute { /** * Gets the value of this attribute. - * + * * @return The value. */ public T getValue() { diff --git a/src/org/apollo/game/model/entity/attr/AttributeDefinition.java b/src/org/apollo/game/model/entity/attr/AttributeDefinition.java index 0f4092b1..9f08acbb 100644 --- a/src/org/apollo/game/model/entity/attr/AttributeDefinition.java +++ b/src/org/apollo/game/model/entity/attr/AttributeDefinition.java @@ -2,7 +2,7 @@ package org.apollo.game.model.entity.attr; /** * A definition for an {@link Attribute}. - * + * * @author Major * * @param The type of attribute. @@ -11,7 +11,7 @@ public final class AttributeDefinition { /** * Creates an AttributeDefinition for a {@code boolean}. - * + * * @param defaultValue The default value of the definition. * @param persistence The {@link AttributePersistence} of the definition. * @return The AttributeDefinition. @@ -22,7 +22,7 @@ public final class AttributeDefinition { /** * Creates an AttributeDefinition for a {@code double}. - * + * * @param defaultValue The default value of the definition. * @param persistence The {@link AttributePersistence} of the definition. * @return The AttributeDefinition. @@ -33,7 +33,7 @@ public final class AttributeDefinition { /** * Creates an AttributeDefinition for an {@code int}. - * + * * @param defaultValue The default value of the definition. * @param persistence The {@link AttributePersistence} of the definition. * @return The AttributeDefinition. @@ -44,7 +44,7 @@ public final class AttributeDefinition { /** * Creates an AttributeDefinition for a String. - * + * * @param defaultValue The default value of the definition. * @param persistence The {@link AttributePersistence} of the definition. * @return The AttributeDefinition. @@ -70,7 +70,7 @@ public final class AttributeDefinition { /** * Creates the AttributeDefinition. - * + * * @param defaultValue The default value. * @param persistence The {@link AttributePersistence}. * @param type The {@link AttributeType}. @@ -83,7 +83,7 @@ public final class AttributeDefinition { /** * Gets the default value of this AttributeDefinition. - * + * * @return The default value. */ public T getDefault() { @@ -92,7 +92,7 @@ public final class AttributeDefinition { /** * Gets the {@link AttributePersistence} of this AttributeDefinition. - * + * * @return The AttributePersistence. */ public AttributePersistence getPersistence() { @@ -101,7 +101,7 @@ public final class AttributeDefinition { /** * Gets the {@link AttributeType} of this AttributeDefinition - * + * * @return The AttributeType. */ public AttributeType getType() { diff --git a/src/org/apollo/game/model/entity/attr/AttributeMap.java b/src/org/apollo/game/model/entity/attr/AttributeMap.java index a4410c8a..b67d2386 100644 --- a/src/org/apollo/game/model/entity/attr/AttributeMap.java +++ b/src/org/apollo/game/model/entity/attr/AttributeMap.java @@ -9,7 +9,7 @@ import com.google.common.base.Preconditions; /** * A {@link Map} wrapper used to store {@link Attribute}s and their {@link AttributeDefinition definitions}. - * + * * @author Major */ public final class AttributeMap { @@ -26,7 +26,7 @@ public final class AttributeMap { /** * Registers an {@link AttributeDefinition}. - * + * * @param name The name of the attribute. * @param definition The definition. */ @@ -36,7 +36,7 @@ public final class AttributeMap { /** * Gets the {@link AttributeDefinition} with the specified name, or {@code null} if it is not defined. - * + * * @param name The name of the attribute. * @return The attribute definition. */ @@ -47,7 +47,7 @@ public final class AttributeMap { /** * Gets the {@link AttributeDefinition}s, as a {@link Map}. - * + * * @return The map of attribute names to definitions. */ public static Map> getDefinitions() { @@ -56,7 +56,7 @@ public final class AttributeMap { /** * Returns whether or not an {@link AttributeDefinition} with the specified name exists. - * + * * @param name The name of the AttributeDefinition. * @return {@code true} if the AttributeDefinition exists, {@code false} if not. */ @@ -67,11 +67,11 @@ public final class AttributeMap { /** * The map of attribute names to attributes. */ - private Map> attributes = new HashMap<>(DEFAULT_MAP_SIZE); + private final Map> attributes = new HashMap<>(DEFAULT_MAP_SIZE); /** * Gets the {@link Attribute} with the specified name. - * + * * @param name The name of the attribute. * @return The attribute. */ @@ -85,7 +85,7 @@ public final class AttributeMap { /** * Gets a shallow copy of the {@link Map} of {@link Attribute}s. - * + * * @return The attributes. */ public Map> getAttributes() { @@ -94,7 +94,7 @@ public final class AttributeMap { /** * Sets the value of the {@link Attribute} with the specified name. - * + * * @param name The name of the attribute. * @param attribute The attribute. */ @@ -105,7 +105,7 @@ public final class AttributeMap { /** * Creates an {@link Attribute} with the specified value and {@link AttributeType}. - * + * * @param value The value of the Attribute. * @param type The AttributeType. * @return The Attribute. diff --git a/src/org/apollo/game/model/entity/attr/AttributeType.java b/src/org/apollo/game/model/entity/attr/AttributeType.java index ba9047d9..b107a394 100644 --- a/src/org/apollo/game/model/entity/attr/AttributeType.java +++ b/src/org/apollo/game/model/entity/attr/AttributeType.java @@ -3,7 +3,7 @@ package org.apollo.game.model.entity.attr; /** * The type of attribute. The functionality of this enum (and other classes) is dependent on the ordering of the values * - the expected order is {@link #BOOLEAN}, {@link #DOUBLE}, {@link #LONG}, {@link #STRING}, {@link #SYMBOL}. - * + * * @author Major */ public enum AttributeType { @@ -35,7 +35,7 @@ public enum AttributeType { /** * Gets the type with the specified ordinal. - * + * * @param ordinal The ordinal. * @return The type. */ @@ -45,7 +45,7 @@ public enum AttributeType { /** * Gets the value of this attribute type. - * + * * @return The value. */ public int getValue() { diff --git a/src/org/apollo/game/model/entity/attr/BooleanAttribute.java b/src/org/apollo/game/model/entity/attr/BooleanAttribute.java index e9df53d1..3b20f733 100644 --- a/src/org/apollo/game/model/entity/attr/BooleanAttribute.java +++ b/src/org/apollo/game/model/entity/attr/BooleanAttribute.java @@ -2,14 +2,14 @@ package org.apollo.game.model.entity.attr; /** * An {@link Attribute} with a boolean value. - * + * * @author Major */ public final class BooleanAttribute extends Attribute { /** * Creates the boolean attribute. - * + * * @param value The value. */ public BooleanAttribute(Boolean value) { diff --git a/src/org/apollo/game/model/entity/attr/NumericalAttribute.java b/src/org/apollo/game/model/entity/attr/NumericalAttribute.java index 018e9158..0aa28700 100644 --- a/src/org/apollo/game/model/entity/attr/NumericalAttribute.java +++ b/src/org/apollo/game/model/entity/attr/NumericalAttribute.java @@ -4,14 +4,14 @@ import com.google.common.primitives.Longs; /** * An {@link Attribute} with a numerical value. - * + * * @author Major */ public final class NumericalAttribute extends Attribute { /** * Gets the {@link AttributeType} of number this attribute is. - * + * * @param value The value of this attribute. * @return The type. */ @@ -21,7 +21,7 @@ public final class NumericalAttribute extends Attribute { /** * Creates the number attribute. - * + * * @param value The value of this attribute. */ public NumericalAttribute(Number value) { @@ -30,13 +30,13 @@ public final class NumericalAttribute extends Attribute { @Override public byte[] encode() { - long encoded = (type == AttributeType.DOUBLE) ? Double.doubleToLongBits((double) value) : (long) value; + long encoded = type == AttributeType.DOUBLE ? Double.doubleToLongBits((double) value) : (long) value; return Longs.toByteArray(encoded); } @Override public String toString() { - return (type == AttributeType.DOUBLE) ? Double.toString((double) value) : Long.toString((long) value); + return type == AttributeType.DOUBLE ? Double.toString((double) value) : Long.toString((long) value); } } \ No newline at end of file diff --git a/src/org/apollo/game/model/entity/attr/StringAttribute.java b/src/org/apollo/game/model/entity/attr/StringAttribute.java index 2691bbc3..c2f0454c 100644 --- a/src/org/apollo/game/model/entity/attr/StringAttribute.java +++ b/src/org/apollo/game/model/entity/attr/StringAttribute.java @@ -5,14 +5,14 @@ import java.util.Arrays; /** * An {@link Attribute} with a string value. - * + * * @author Major */ public final class StringAttribute extends Attribute { /** * Creates the string attribute. - * + * * @param value The value. */ public StringAttribute(String value) { @@ -21,7 +21,7 @@ public final class StringAttribute extends Attribute { /** * Creates the string attribute. - * + * * @param value The value. * @param symbol Whether or not the attribute is a symbol. */ diff --git a/src/org/apollo/game/model/entity/obj/DynamicGameObject.java b/src/org/apollo/game/model/entity/obj/DynamicGameObject.java index bf99cb55..5747b42a 100644 --- a/src/org/apollo/game/model/entity/obj/DynamicGameObject.java +++ b/src/org/apollo/game/model/entity/obj/DynamicGameObject.java @@ -44,7 +44,7 @@ public final class DynamicGameObject extends GameObject { @Override public int hashCode() { Player player = get(); - return (player == null) ? 0 : player.hashCode(); + return player == null ? 0 : player.hashCode(); } } @@ -104,7 +104,7 @@ public final class DynamicGameObject extends GameObject { /** * Adds this DynamicGameObject to the view of the specified {@link Player}. - * + * * @param player The Player. * @return {@code true} if this GameObject was not already visible to the specified Player. */ @@ -120,7 +120,7 @@ public final class DynamicGameObject extends GameObject { /** * Removes this DynamicGameObject from the view of the specified {@link Player}. - * + * * @param player The Player. * @return {@code true} if this GameObject was visible to the specified Player. */ diff --git a/src/org/apollo/game/model/entity/obj/GameObject.java b/src/org/apollo/game/model/entity/obj/GameObject.java index 65e18470..f824ebfd 100644 --- a/src/org/apollo/game/model/entity/obj/GameObject.java +++ b/src/org/apollo/game/model/entity/obj/GameObject.java @@ -13,7 +13,7 @@ import com.google.common.base.MoreObjects; /** * Represents an object in the game world. - * + * * @author Chris Fletcher * @author Major */ @@ -26,7 +26,7 @@ public abstract class GameObject extends Entity { /** * Creates the GameObject. - * + * * @param world The {@link World} containing the GameObject. * @param id The id of the GameObject * @param position The {@link Position} of the GameObject. @@ -35,7 +35,7 @@ public abstract class GameObject extends Entity { */ public GameObject(World world, int id, Position position, int type, int orientation) { super(world, position); - this.packed = id << 8 | (type & 0x3F) << 2 | orientation & 0x3; + packed = id << 8 | (type & 0x3F) << 2 | orientation & 0x3; } @Override @@ -50,7 +50,7 @@ public abstract class GameObject extends Entity { /** * Gets the definition of this object. - * + * * @return The object's definition. */ public ObjectDefinition getDefinition() { @@ -59,7 +59,7 @@ public abstract class GameObject extends Entity { /** * Gets this object's id. - * + * * @return The id. */ public int getId() { @@ -68,7 +68,7 @@ public abstract class GameObject extends Entity { /** * Gets this object's orientation. - * + * * @return The orientation. */ public int getOrientation() { @@ -77,11 +77,11 @@ public abstract class GameObject extends Entity { /** * Gets this object's type. - * + * * @return The type. */ public int getType() { - return (packed >> 2) & 0x3F; + return packed >> 2 & 0x3F; } @Override @@ -101,7 +101,7 @@ public abstract class GameObject extends Entity { /** * Returns whether or not this GameObject can be seen by the specified {@link Player}. - * + * * @param player The Player. * @param world The {@link World} containing the GameObject. * @return {@code true} if the Player can see this GameObject, {@code false} if not. diff --git a/src/org/apollo/game/model/entity/obj/ObjectGroup.java b/src/org/apollo/game/model/entity/obj/ObjectGroup.java index 9bb50d22..59baa2a1 100644 --- a/src/org/apollo/game/model/entity/obj/ObjectGroup.java +++ b/src/org/apollo/game/model/entity/obj/ObjectGroup.java @@ -32,7 +32,7 @@ public enum ObjectGroup { /** * Gets the ObjectGroup with the specified integer value. - * + * * @param value The integer value of the ObjectGroup. * @return The ObjectGroup. * @throws IllegalArgumentException If there is no ObjectGroup with the specified value. @@ -57,7 +57,7 @@ public enum ObjectGroup { /** * Gets the value of this ObjectGroup. - * + * * @return The value. */ public int getValue() { diff --git a/src/org/apollo/game/model/entity/obj/ObjectType.java b/src/org/apollo/game/model/entity/obj/ObjectType.java index 33d8395e..cef36d4d 100644 --- a/src/org/apollo/game/model/entity/obj/ObjectType.java +++ b/src/org/apollo/game/model/entity/obj/ObjectType.java @@ -3,7 +3,7 @@ package org.apollo.game.model.entity.obj; /** * The type of an object, which affects specified behaviour (such as whether it displaces existing objects). TODO * complete this... - * + * * @author Major * @author Scu11 */ diff --git a/src/org/apollo/game/model/entity/path/AStarPathfindingAlgorithm.java b/src/org/apollo/game/model/entity/path/AStarPathfindingAlgorithm.java index a8348454..5f643f8f 100644 --- a/src/org/apollo/game/model/entity/path/AStarPathfindingAlgorithm.java +++ b/src/org/apollo/game/model/entity/path/AStarPathfindingAlgorithm.java @@ -21,7 +21,7 @@ import org.apollo.game.model.area.RegionRepository; *

* This implementation also avoids the linear-time removal from the queue by polling until the first open node is found * when identifying the cheapest node. - * + * * @author Major */ public final class AStarPathfindingAlgorithm extends PathfindingAlgorithm { @@ -33,7 +33,7 @@ public final class AStarPathfindingAlgorithm extends PathfindingAlgorithm { /** * Creates the A* pathfinding algorithm with the specified heuristic. - * + * * @param repository The {@link RegionRepository}. * @param heuristic The heuristic. */ @@ -100,7 +100,7 @@ public final class AStarPathfindingAlgorithm extends PathfindingAlgorithm { /** * Compares the two specified {@link Node}s, adding the other node to the open {@link Set} if the estimation is * cheaper than the current cost. - * + * * @param active The active node. * @param other The node to compare the active node against. * @param open The set of open nodes. @@ -123,7 +123,7 @@ public final class AStarPathfindingAlgorithm extends PathfindingAlgorithm { /** * Gets the cheapest open {@link Node} from the {@link Queue}. - * + * * @param nodes The queue of nodes. * @return The cheapest node. */ diff --git a/src/org/apollo/game/model/entity/path/ChebyshevHeuristic.java b/src/org/apollo/game/model/entity/path/ChebyshevHeuristic.java index d2508cbf..33c2cdd9 100644 --- a/src/org/apollo/game/model/entity/path/ChebyshevHeuristic.java +++ b/src/org/apollo/game/model/entity/path/ChebyshevHeuristic.java @@ -4,7 +4,7 @@ import org.apollo.game.model.Position; /** * The Chebyshev heuristic, ideal for a system that allows for 8-directional movement. - * + * * @author Major */ final class ChebyshevHeuristic extends Heuristic { diff --git a/src/org/apollo/game/model/entity/path/Heuristic.java b/src/org/apollo/game/model/entity/path/Heuristic.java index 842fbe44..f43717fd 100644 --- a/src/org/apollo/game/model/entity/path/Heuristic.java +++ b/src/org/apollo/game/model/entity/path/Heuristic.java @@ -4,14 +4,14 @@ import org.apollo.game.model.Position; /** * A heuristic used by the A* algorithm. - * + * * @author Major */ abstract class Heuristic { /** * Estimates the value for this heuristic. - * + * * @param current The current {@link Position}. * @param target The target position. * @return The heuristic value. diff --git a/src/org/apollo/game/model/entity/path/ManhattanHeuristic.java b/src/org/apollo/game/model/entity/path/ManhattanHeuristic.java index 8e324142..c44061b0 100644 --- a/src/org/apollo/game/model/entity/path/ManhattanHeuristic.java +++ b/src/org/apollo/game/model/entity/path/ManhattanHeuristic.java @@ -4,7 +4,7 @@ import org.apollo.game.model.Position; /** * The Manhattan heuristic, ideal for a system that limits movement to 4 directions. - * + * * @author Major */ final class ManhattanHeuristic extends Heuristic { diff --git a/src/org/apollo/game/model/entity/path/Node.java b/src/org/apollo/game/model/entity/path/Node.java index 1028abb8..a5632160 100644 --- a/src/org/apollo/game/model/entity/path/Node.java +++ b/src/org/apollo/game/model/entity/path/Node.java @@ -9,7 +9,7 @@ import com.google.common.base.MoreObjects; /** * A node representing a weighted {@link Position}. - * + * * @author Major */ final class Node { @@ -36,7 +36,7 @@ final class Node { /** * Creates the node with the specified {@link Position} and cost. - * + * * @param position The position. */ public Node(Position position) { @@ -45,7 +45,7 @@ final class Node { /** * Creates the node with the specified {@link Position} and cost. - * + * * @param position The position. * @param cost The cost of the node. */ @@ -74,7 +74,7 @@ final class Node { /** * Gets the cost of this node. - * + * * @return The cost. */ public int getCost() { @@ -83,7 +83,7 @@ final class Node { /** * Gets the parent node of this node. - * + * * @return The parent node. * @throws NoSuchElementException If this node does not have a parent. */ @@ -93,7 +93,7 @@ final class Node { /** * Gets the {@link Position} this node represents. - * + * * @return The position. */ public Position getPosition() { @@ -107,7 +107,7 @@ final class Node { /** * Returns whether or not this node has a parent node. - * + * * @return {@code true} if this node has a parent node, otherwise {@code false}. */ public boolean hasParent() { @@ -116,7 +116,7 @@ final class Node { /** * Returns whether or not this {@link Node} is open. - * + * * @return {@code true} if this node is open, otherwise {@code false}. */ public boolean isOpen() { @@ -125,7 +125,7 @@ final class Node { /** * Sets the cost of this node. - * + * * @param cost The cost. */ public void setCost(int cost) { @@ -134,7 +134,7 @@ final class Node { /** * Sets the parent node of this node. - * + * * @param parent The parent node. May be {@code null}. */ public void setParent(Node parent) { diff --git a/src/org/apollo/game/model/entity/path/PathfindingAlgorithm.java b/src/org/apollo/game/model/entity/path/PathfindingAlgorithm.java index f60ccee2..9103d7cb 100644 --- a/src/org/apollo/game/model/entity/path/PathfindingAlgorithm.java +++ b/src/org/apollo/game/model/entity/path/PathfindingAlgorithm.java @@ -34,7 +34,7 @@ abstract class PathfindingAlgorithm { /** * Finds a valid path from the origin {@link Position} to the target one. - * + * * @param origin The origin Position. * @param target The target Position. * @return The {@link Deque} containing the Positions to go through. @@ -44,7 +44,7 @@ abstract class PathfindingAlgorithm { /** * Returns whether or not a {@link Position} walking one step in any of the specified {@link Direction}s would lead * to is traversable. - * + * * @param current The current Position. * @param directions The Directions that should be checked. * @return {@code true} if any of the Directions lead to a traversable tile, otherwise {@code false}. @@ -56,7 +56,7 @@ abstract class PathfindingAlgorithm { /** * Returns whether or not a {@link Position} walking one step in any of the specified {@link Direction}s would lead * to is traversable. - * + * * @param current The current Position. * @param boundaries The {@link Optional} containing the Position boundaries. * @param directions The Directions that should be checked. @@ -96,7 +96,7 @@ abstract class PathfindingAlgorithm { /** * Returns whether or not the specified {@link Position} is inside the specified {@code boundary}. - * + * * @param position The Position. * @param boundary The boundary Positions. * @return {@code true} if the specified Position is inside the boundary, {@code false} if not. diff --git a/src/org/apollo/game/model/entity/path/SimplePathfindingAlgorithm.java b/src/org/apollo/game/model/entity/path/SimplePathfindingAlgorithm.java index 1307a725..d784e451 100644 --- a/src/org/apollo/game/model/entity/path/SimplePathfindingAlgorithm.java +++ b/src/org/apollo/game/model/entity/path/SimplePathfindingAlgorithm.java @@ -40,7 +40,7 @@ public final class SimplePathfindingAlgorithm extends PathfindingAlgorithm { /** * Finds a valid path from the origin {@link Position} to the target one. - * + * * @param origin The origin Position. * @param target The target Position. * @param boundaries The boundary Positions, which are marking as untraversable. @@ -61,7 +61,7 @@ public final class SimplePathfindingAlgorithm extends PathfindingAlgorithm { *

  • Checks if we are not at the target, and that either of the horizontally-adjacent positions are traversable: * if so, we traverse horizontally (see {@link #addHorizontal}); if not, return the current path. * - * + * * @param start The current position. * @param target The target position. * @param positions The deque of positions. @@ -88,7 +88,7 @@ public final class SimplePathfindingAlgorithm extends PathfindingAlgorithm { } Position last = new Position(x, y, height); - if (!start.equals(last) && dy != 0 && traversable(last, boundaries, (dy > 0) ? Direction.SOUTH : Direction.NORTH)) { + if (!start.equals(last) && dy != 0 && traversable(last, boundaries, dy > 0 ? Direction.SOUTH : Direction.NORTH)) { return addVertical(last, target, positions); } @@ -105,7 +105,7 @@ public final class SimplePathfindingAlgorithm extends PathfindingAlgorithm { *
  • Checks if we are not at the target, and that either of the horizontally-adjacent positions are traversable: * if so, we traverse horizontally (see {@link #addHorizontal}); if not, return the current path. * - * + * * @param start The current position. * @param target The target position. * @param positions The deque of positions. @@ -132,7 +132,7 @@ public final class SimplePathfindingAlgorithm extends PathfindingAlgorithm { } Position last = new Position(x, y, height); - if (!last.equals(target) && dx != 0 && traversable(last, boundaries, (dx > 0) ? Direction.WEST : Direction.EAST)) { + if (!last.equals(target) && dx != 0 && traversable(last, boundaries, dx > 0 ? Direction.WEST : Direction.EAST)) { return addHorizontal(last, target, positions); } diff --git a/src/org/apollo/game/model/entity/setting/Gender.java b/src/org/apollo/game/model/entity/setting/Gender.java index 9cd43668..75d0bddb 100644 --- a/src/org/apollo/game/model/entity/setting/Gender.java +++ b/src/org/apollo/game/model/entity/setting/Gender.java @@ -3,7 +3,7 @@ package org.apollo.game.model.entity.setting; /** * An enumeration containing the two genders (male and female). This enumeration relies on the ordering of the elements * within, which should be as follows: {@code MALE}, {@code FEMALE}. - * + * * @author Graham */ public enum Gender { @@ -20,7 +20,7 @@ public enum Gender { /** * Converts this gender to an integer. - * + * * @return The numerical value used by the client. */ public int toInteger() { diff --git a/src/org/apollo/game/model/entity/setting/MembershipStatus.java b/src/org/apollo/game/model/entity/setting/MembershipStatus.java index c02f86f3..a82ccd0f 100644 --- a/src/org/apollo/game/model/entity/setting/MembershipStatus.java +++ b/src/org/apollo/game/model/entity/setting/MembershipStatus.java @@ -22,7 +22,7 @@ public enum MembershipStatus { /** * Gets the MembershipStatus with the specified value. - * + * * @param value The integer value of the MembershipStatus. * @return The MembershipStatus. * @throws IllegalArgumentException If no MembershipStatus with the specified the value exists. @@ -48,7 +48,7 @@ public enum MembershipStatus { /** * Gets the value of this MembershipStatus. - * + * * @return The value. */ public int getValue() { diff --git a/src/org/apollo/game/model/entity/setting/PrivacyState.java b/src/org/apollo/game/model/entity/setting/PrivacyState.java index 76fbec8d..959d7a52 100644 --- a/src/org/apollo/game/model/entity/setting/PrivacyState.java +++ b/src/org/apollo/game/model/entity/setting/PrivacyState.java @@ -6,7 +6,7 @@ import com.google.common.base.Preconditions; * An enumeration representing the different privacy states for public, private and trade chat. This enumeration relies * on the ordering of the elements within, which should be as follows: {@code ON}, {@code HIDE}, {@code FRIENDS}, * {@code OFF}, {@code FILTERABLE}. - * + * * @author Kyle Stevenson */ public enum PrivacyState { @@ -40,7 +40,7 @@ public enum PrivacyState { /** * Gets the privacy state for the specified numerical value. - * + * * @param value The numerical value. * @param chat Whether or not the value is for public chat. * @return The privacy state. @@ -62,7 +62,7 @@ public enum PrivacyState { /** * Creates the privacy state. - * + * * @param value The numerical value. */ private PrivacyState(int value) { @@ -76,7 +76,7 @@ public enum PrivacyState { /** * Converts this privacy state to an integer. - * + * * @param chat Whether or not the value is for public chat. * @return The numerical value used by the client. */ diff --git a/src/org/apollo/game/model/entity/setting/PrivilegeLevel.java b/src/org/apollo/game/model/entity/setting/PrivilegeLevel.java index fbdaf7c6..cb0a0d5e 100644 --- a/src/org/apollo/game/model/entity/setting/PrivilegeLevel.java +++ b/src/org/apollo/game/model/entity/setting/PrivilegeLevel.java @@ -5,7 +5,7 @@ import com.google.common.base.Preconditions; /** * An enumeration with the different privilege levels a player can have. This enumeration relies on the ordering of the * elements within, which should be as follows: {@code STANDARD}, {@code MODERATOR}, {@code ADMINISTRATOR}. - * + * * @author Graham */ public enum PrivilegeLevel { @@ -27,7 +27,7 @@ public enum PrivilegeLevel { /** * Gets the privilege level for the specified numerical value. - * + * * @param value The numerical value. * @return The privilege level. * @throws IllegalArgumentException If the specified value is out of bounds. @@ -40,7 +40,7 @@ public enum PrivilegeLevel { /** * Gets the numerical value of this privilege level. - * + * * @return The numerical value used in the protocol. */ public int toInteger() { diff --git a/src/org/apollo/game/model/entity/setting/ScreenBrightness.java b/src/org/apollo/game/model/entity/setting/ScreenBrightness.java index 4a190a44..a912a497 100644 --- a/src/org/apollo/game/model/entity/setting/ScreenBrightness.java +++ b/src/org/apollo/game/model/entity/setting/ScreenBrightness.java @@ -5,7 +5,7 @@ import com.google.common.base.Preconditions; /** * An enumeration representing the brightness of a player's screen. This enumeration relies on the ordering of the * elements within, which should be as follows: {@code DARK}, {@code NORMAL}, {@code BRIGHT}, {@code VERY_BRIGHT}. - * + * * @author Major */ public enum ScreenBrightness { @@ -32,7 +32,7 @@ public enum ScreenBrightness { /** * Gets the screen brightness for the specified numerical value. - * + * * @param value The numerical value. * @return The screen brightness. * @throws IllegalArgumentException If the specified value is out of bounds. @@ -45,7 +45,7 @@ public enum ScreenBrightness { /** * Converts this screen brightness to an integer. - * + * * @return The numerical value. */ public int toInteger() { diff --git a/src/org/apollo/game/model/entity/setting/ServerStatus.java b/src/org/apollo/game/model/entity/setting/ServerStatus.java index 651d4b88..1d0eadf7 100644 --- a/src/org/apollo/game/model/entity/setting/ServerStatus.java +++ b/src/org/apollo/game/model/entity/setting/ServerStatus.java @@ -5,7 +5,7 @@ import com.google.common.base.Preconditions; /** * Represents the status of the friend server. This enumeration relies on the ordering of the elements within, which * should be as follows: {@code OFFLINE}, {@code CONNECTING}, {@code ONLINE}. - * + * * @author Major */ public enum ServerStatus { @@ -27,7 +27,7 @@ public enum ServerStatus { /** * Gets the code of this server status. - * + * * @return The code. */ public int getCode() { @@ -36,7 +36,7 @@ public enum ServerStatus { /** * Gets the server status for the specified numerical value. - * + * * @param value The value. * @return The server status. * @throws IndexOutOfBoundsException If the specified value is out of bounds. diff --git a/src/org/apollo/game/model/event/Event.java b/src/org/apollo/game/model/event/Event.java index fbb225b0..14ab6e75 100644 --- a/src/org/apollo/game/model/event/Event.java +++ b/src/org/apollo/game/model/event/Event.java @@ -21,7 +21,7 @@ public abstract class Event { /** * Returns whether or not the Event chain has been terminated. - * + * * @return {@code true} if the Event chain has been terminated, otherwise {@code false}. */ public final boolean terminated() { diff --git a/src/org/apollo/game/model/event/EventListener.java b/src/org/apollo/game/model/event/EventListener.java index 7a5306b8..9dac4ea7 100644 --- a/src/org/apollo/game/model/event/EventListener.java +++ b/src/org/apollo/game/model/event/EventListener.java @@ -12,7 +12,7 @@ public interface EventListener { /** * Handles the {@link Event} that occurred. - * + * * @param event The Event. */ public void handle(E event); diff --git a/src/org/apollo/game/model/event/EventListenerChain.java b/src/org/apollo/game/model/event/EventListenerChain.java index a6dc1fe7..feb49670 100644 --- a/src/org/apollo/game/model/event/EventListenerChain.java +++ b/src/org/apollo/game/model/event/EventListenerChain.java @@ -34,7 +34,7 @@ final class EventListenerChain { /** * Adds an {@link EventListener} to this chain. - * + * * @param listener The EventListener to add. */ public void addListener(EventListener listener) { @@ -43,7 +43,7 @@ final class EventListenerChain { /** * Notifies each {@link EventListener} in this chain that an {@link Event} has occurred. - * + * * @param event The event. * @return {@code true} if the Event should continue on with its outcome, {@code false} if not. */ diff --git a/src/org/apollo/game/model/event/EventListenerChainSet.java b/src/org/apollo/game/model/event/EventListenerChainSet.java index 293632cd..34d412cd 100644 --- a/src/org/apollo/game/model/event/EventListenerChainSet.java +++ b/src/org/apollo/game/model/event/EventListenerChainSet.java @@ -17,19 +17,19 @@ public final class EventListenerChainSet { /** * Notifies the appropriate {@link EventListenerChain} that an {@link Event} has occurred. - * + * * @param event The Event. * @return {@code true} if the Event should continue on with its outcome, {@code false} if not. */ public boolean notify(E event) { @SuppressWarnings("unchecked") EventListenerChain chain = (EventListenerChain) chains.get(event.getClass()); - return (chain == null) || chain.notify(event); + return chain == null || chain.notify(event); } /** * Places the {@link EventListenerChain} into this set. - * + * * @param clazz The {@link Class} to associate the EventListenerChain with. * @param listener The EventListenerChain. */ diff --git a/src/org/apollo/game/model/event/PlayerEvent.java b/src/org/apollo/game/model/event/PlayerEvent.java index 23272210..6415dee8 100644 --- a/src/org/apollo/game/model/event/PlayerEvent.java +++ b/src/org/apollo/game/model/event/PlayerEvent.java @@ -25,7 +25,7 @@ public abstract class PlayerEvent extends Event { /** * Gets the {@link Player}. - * + * * @return The Player. */ public Player getPlayer() { diff --git a/src/org/apollo/game/model/event/impl/LoginEvent.java b/src/org/apollo/game/model/event/impl/LoginEvent.java index 307764f4..bce5019f 100644 --- a/src/org/apollo/game/model/event/impl/LoginEvent.java +++ b/src/org/apollo/game/model/event/impl/LoginEvent.java @@ -5,7 +5,7 @@ import org.apollo.game.model.event.PlayerEvent; /** * A {@link PlayerEvent} that is fired when a {@link Player} logs in. - * + * * @author Major */ public final class LoginEvent extends PlayerEvent { diff --git a/src/org/apollo/game/model/event/impl/LogoutEvent.java b/src/org/apollo/game/model/event/impl/LogoutEvent.java index 16f17390..5dd57a8d 100644 --- a/src/org/apollo/game/model/event/impl/LogoutEvent.java +++ b/src/org/apollo/game/model/event/impl/LogoutEvent.java @@ -5,7 +5,7 @@ import org.apollo.game.model.event.PlayerEvent; /** * A {@link PlayerEvent} that is fired when a {@link Player} logs out. - * + * * @author Major */ public final class LogoutEvent extends PlayerEvent { diff --git a/src/org/apollo/game/model/event/impl/MobPositionUpdateEvent.java b/src/org/apollo/game/model/event/impl/MobPositionUpdateEvent.java index 82f9a470..791a23e2 100644 --- a/src/org/apollo/game/model/event/impl/MobPositionUpdateEvent.java +++ b/src/org/apollo/game/model/event/impl/MobPositionUpdateEvent.java @@ -9,7 +9,7 @@ import org.apollo.game.model.event.Event; *

    * This Event intentionally ignores the result of execution - it should not be possible for a plugin to prevent this * Event from happening, only to listen for it. - * + * * @author Major */ public final class MobPositionUpdateEvent extends Event { @@ -37,7 +37,7 @@ public final class MobPositionUpdateEvent extends Event { /** * Gets the {@link Mob} being moved. - * + * * @return The Mob. */ public Mob getMob() { @@ -46,7 +46,7 @@ public final class MobPositionUpdateEvent extends Event { /** * Gets the {@link Position} this {@link Mob} is being moved to. - * + * * @return The Position. */ public Position getNext() { diff --git a/src/org/apollo/game/model/inter/EnterAmountListener.java b/src/org/apollo/game/model/inter/EnterAmountListener.java index 01e4b92d..6211b844 100644 --- a/src/org/apollo/game/model/inter/EnterAmountListener.java +++ b/src/org/apollo/game/model/inter/EnterAmountListener.java @@ -2,7 +2,7 @@ package org.apollo.game.model.inter; /** * A listener for the enter amount dialog. - * + * * @author Graham */ @FunctionalInterface @@ -10,7 +10,7 @@ public interface EnterAmountListener { /** * Called when the player enters the specified amount. - * + * * @param amount The amount. */ public void amountEntered(int amount); diff --git a/src/org/apollo/game/model/inter/InterfaceConstants.java b/src/org/apollo/game/model/inter/InterfaceConstants.java index b356f590..acee6162 100644 --- a/src/org/apollo/game/model/inter/InterfaceConstants.java +++ b/src/org/apollo/game/model/inter/InterfaceConstants.java @@ -2,7 +2,7 @@ package org.apollo.game.model.inter; /** * Contains interface-related constants. - * + * * @author Major */ public class InterfaceConstants { diff --git a/src/org/apollo/game/model/inter/InterfaceListener.java b/src/org/apollo/game/model/inter/InterfaceListener.java index 0ebe299d..aa78233a 100644 --- a/src/org/apollo/game/model/inter/InterfaceListener.java +++ b/src/org/apollo/game/model/inter/InterfaceListener.java @@ -2,7 +2,7 @@ package org.apollo.game.model.inter; /** * Listens to interface-related messages. - * + * * @author Graham */ @FunctionalInterface diff --git a/src/org/apollo/game/model/inter/InterfaceSet.java b/src/org/apollo/game/model/inter/InterfaceSet.java index f067952c..225fe2f5 100644 --- a/src/org/apollo/game/model/inter/InterfaceSet.java +++ b/src/org/apollo/game/model/inter/InterfaceSet.java @@ -33,7 +33,7 @@ import org.apollo.game.model.inv.InventoryListener; *

  • Fullscreen background: Interfaces displayed behind the fullscreen window, typically a blank, * black screen.
  • * - * + * * @author Graham */ public final class InterfaceSet { @@ -51,7 +51,7 @@ public final class InterfaceSet { /** * A map of open interfaces. */ - private Map interfaces = new HashMap<>(); + private final Map interfaces = new HashMap<>(); /** * The current listener. @@ -65,7 +65,7 @@ public final class InterfaceSet { /** * Creates an interface set. - * + * * @param player The player. */ public InterfaceSet(Player player) { @@ -74,7 +74,7 @@ public final class InterfaceSet { /** * Called when the player has clicked the specified button. Notifies the current dialogue listener. - * + * * @param button The button. * @return {@code true} if the {@link MessageHandlerChain} should be broken. */ @@ -95,7 +95,7 @@ public final class InterfaceSet { /** * Checks if this interface sets contains the specified interface. - * + * * @param id The interface's id. * @return {@code true} if so, {@code false} if not. */ @@ -105,7 +105,7 @@ public final class InterfaceSet { /** * Checks if this interface set contains the specified interface type. - * + * * @param type The interface's type. * @return {@code true} if so, {@code false} if not. */ @@ -124,7 +124,7 @@ public final class InterfaceSet { /** * Called when the client has entered the specified amount. Notifies the current listener. - * + * * @param amount The amount. */ public void enteredAmount(int amount) { @@ -143,14 +143,14 @@ public final class InterfaceSet { /** * Opens a dialogue interface. - * + * * @param listener The {@link DialogueListener}. * @param dialogueId The dialogue id. */ public void openDialogue(DialogueListener listener, int dialogueId) { closeAndNotify(); - this.dialogueListener = Optional.ofNullable(listener); + dialogueListener = Optional.ofNullable(listener); this.listener = Optional.ofNullable(listener); interfaces.put(InterfaceType.DIALOGUE, dialogueId); @@ -159,7 +159,7 @@ public final class InterfaceSet { /** * Opens a dialogue. - * + * * @param dialogueId The dialogue id. */ public void openDialogue(int dialogueId) { @@ -168,14 +168,14 @@ public final class InterfaceSet { /** * Opens a dialogue overlay interface. - * + * * @param listener The {@link DialogueListener}. * @param dialogueId The dialogue id. */ public void openDialogueOverlay(DialogueListener listener, int dialogueId) { closeAndNotify(); - this.dialogueListener = Optional.ofNullable(listener); + dialogueListener = Optional.ofNullable(listener); this.listener = Optional.ofNullable(listener); interfaces.put(InterfaceType.DIALOGUE, dialogueId); @@ -184,7 +184,7 @@ public final class InterfaceSet { /** * Opens a dialogue overlay. - * + * * @param dialogueId The dialogue id. */ public void openDialogueOverlay(int dialogueId) { @@ -193,7 +193,7 @@ public final class InterfaceSet { /** * Opens the enter amount dialogue. - * + * * @param listener The enter amount listener. */ public void openEnterAmountDialogue(EnterAmountListener listener) { @@ -203,7 +203,7 @@ public final class InterfaceSet { /** * Opens an overlay interface. - * + * * @param overlay The overlay id. */ public void openOverlay(int overlay) { @@ -213,7 +213,7 @@ public final class InterfaceSet { /** * Opens an sidebar interface. - * + * * @param sidebar The sidebar id. */ public void openSidebar(int sidebar) { @@ -225,7 +225,7 @@ public final class InterfaceSet { /** * Opens an sidebar interface with the specified {@link InventoryListener}. - * + * * @param listener The listener. * @param sidebar The sidebar id. */ @@ -239,7 +239,7 @@ public final class InterfaceSet { /** * Opens a window. - * + * * @param windowId The window's id. */ public void openWindow(int windowId) { @@ -248,7 +248,7 @@ public final class InterfaceSet { /** * Opens a window with the specified listener. - * + * * @param listener The listener for this interface. * @param windowId The window's id. */ @@ -262,7 +262,7 @@ public final class InterfaceSet { /** * Opens a window and inventory sidebar. - * + * * @param windowId The window's id. * @param sidebarId The sidebar's id. */ @@ -272,7 +272,7 @@ public final class InterfaceSet { /** * Opens a window and inventory sidebar with the specified listener. - * + * * @param listener The listener for this interface. * @param windowId The window's id. * @param sidebarId The sidebar's id. @@ -289,7 +289,7 @@ public final class InterfaceSet { /** * Gets the size of the interface set. - * + * * @return The size. */ public int size() { diff --git a/src/org/apollo/game/model/inter/InterfaceType.java b/src/org/apollo/game/model/inter/InterfaceType.java index 882b33c9..0e4b530c 100644 --- a/src/org/apollo/game/model/inter/InterfaceType.java +++ b/src/org/apollo/game/model/inter/InterfaceType.java @@ -2,7 +2,7 @@ package org.apollo.game.model.inter; /** * Represents the different types of interfaces. - * + * * @author Graham */ public enum InterfaceType { diff --git a/src/org/apollo/game/model/inter/bank/BankConstants.java b/src/org/apollo/game/model/inter/bank/BankConstants.java index f5715911..b1731d6d 100644 --- a/src/org/apollo/game/model/inter/bank/BankConstants.java +++ b/src/org/apollo/game/model/inter/bank/BankConstants.java @@ -2,7 +2,7 @@ package org.apollo.game.model.inter.bank; /** * Contains bank-related constants. - * + * * @author Graham */ public final class BankConstants { diff --git a/src/org/apollo/game/model/inter/bank/BankDepositEnterAmountListener.java b/src/org/apollo/game/model/inter/bank/BankDepositEnterAmountListener.java index 866edfe0..fe766227 100644 --- a/src/org/apollo/game/model/inter/bank/BankDepositEnterAmountListener.java +++ b/src/org/apollo/game/model/inter/bank/BankDepositEnterAmountListener.java @@ -5,7 +5,7 @@ import org.apollo.game.model.inter.EnterAmountListener; /** * An {@link EnterAmountListener} for depositing items. - * + * * @author Graham */ public final class BankDepositEnterAmountListener implements EnterAmountListener { @@ -27,7 +27,7 @@ public final class BankDepositEnterAmountListener implements EnterAmountListener /** * Creates the bank deposit amount listener. - * + * * @param player The player. * @param slot The slot. * @param id The id. diff --git a/src/org/apollo/game/model/inter/bank/BankInterfaceListener.java b/src/org/apollo/game/model/inter/bank/BankInterfaceListener.java index a4130a32..953c7d1e 100644 --- a/src/org/apollo/game/model/inter/bank/BankInterfaceListener.java +++ b/src/org/apollo/game/model/inter/bank/BankInterfaceListener.java @@ -6,7 +6,7 @@ import org.apollo.game.model.inv.InventoryListener; /** * An {@link InterfaceListener} which removes the {@link InventoryListener}s when the bank is closed. - * + * * @author Graham */ public final class BankInterfaceListener implements InterfaceListener { @@ -28,7 +28,7 @@ public final class BankInterfaceListener implements InterfaceListener { /** * Creates the bank interface listener. - * + * * @param player The player. * @param invListener The inventory listener. * @param bankListener The bank listener. diff --git a/src/org/apollo/game/model/inter/bank/BankUtils.java b/src/org/apollo/game/model/inter/bank/BankUtils.java index 75cffec8..534ff843 100644 --- a/src/org/apollo/game/model/inter/bank/BankUtils.java +++ b/src/org/apollo/game/model/inter/bank/BankUtils.java @@ -7,14 +7,14 @@ import org.apollo.game.model.inv.Inventory; /** * Contains bank-related utility methods. - * + * * @author Graham */ public final class BankUtils { /** * Deposits an item into the player's bank. - * + * * @param player The player. * @param slot The slot. * @param id The id. @@ -58,7 +58,7 @@ public final class BankUtils { /** * Opens a player's bank. - * + * * @param player The player. */ public static void openBank(Player player) { @@ -68,7 +68,7 @@ public final class BankUtils { /** * Withdraws an item from a player's bank. - * + * * @param player The player. * @param slot The slot. * @param id The id. diff --git a/src/org/apollo/game/model/inter/bank/BankWithdrawEnterAmountListener.java b/src/org/apollo/game/model/inter/bank/BankWithdrawEnterAmountListener.java index f51811cc..e0134aa6 100644 --- a/src/org/apollo/game/model/inter/bank/BankWithdrawEnterAmountListener.java +++ b/src/org/apollo/game/model/inter/bank/BankWithdrawEnterAmountListener.java @@ -5,7 +5,7 @@ import org.apollo.game.model.inter.EnterAmountListener; /** * An {@link EnterAmountListener} for withdrawing items. - * + * * @author Graham */ public final class BankWithdrawEnterAmountListener implements EnterAmountListener { @@ -27,7 +27,7 @@ public final class BankWithdrawEnterAmountListener implements EnterAmountListene /** * Creates the bank withdraw amount listener. - * + * * @param player The player. * @param slot The slot. * @param id The id. diff --git a/src/org/apollo/game/model/inter/dialogue/DialogueAdapter.java b/src/org/apollo/game/model/inter/dialogue/DialogueAdapter.java index 6c3f0e6e..ac0f7a7f 100644 --- a/src/org/apollo/game/model/inter/dialogue/DialogueAdapter.java +++ b/src/org/apollo/game/model/inter/dialogue/DialogueAdapter.java @@ -2,7 +2,7 @@ package org.apollo.game.model.inter.dialogue; /** * An adapter for the {@link DialogueListener}. - * + * * @author Chris Fletcher */ public abstract class DialogueAdapter implements DialogueListener { diff --git a/src/org/apollo/game/model/inter/dialogue/DialogueListener.java b/src/org/apollo/game/model/inter/dialogue/DialogueListener.java index ceb6b261..48bce36d 100644 --- a/src/org/apollo/game/model/inter/dialogue/DialogueListener.java +++ b/src/org/apollo/game/model/inter/dialogue/DialogueListener.java @@ -5,7 +5,7 @@ import org.apollo.game.model.inter.InterfaceListener; /** * An {@link InterfaceListener} that listens for dialogue-specific message (e.g. clicking buttons). - * + * * @author Chris Fletcher */ public interface DialogueListener extends InterfaceListener { @@ -16,9 +16,10 @@ public interface DialogueListener extends InterfaceListener { * Note that this method is invoked when any button is clicked whilst the dialogue is opened. In case the button is * not being handled by this listener, simply return {@code false} to allow further processing of the message. *

    - * + * * @param button The button interface id. - * @return {@code true} if the {@link MessageHandlerChain} should be broken, {@code false} if it should be continued. + * @return {@code true} if the {@link MessageHandlerChain} should be broken, {@code false} if it should be + * continued. */ public boolean buttonClicked(int button); diff --git a/src/org/apollo/game/model/inv/AppearanceInventoryListener.java b/src/org/apollo/game/model/inv/AppearanceInventoryListener.java index 54f592b3..a977ec6f 100644 --- a/src/org/apollo/game/model/inv/AppearanceInventoryListener.java +++ b/src/org/apollo/game/model/inv/AppearanceInventoryListener.java @@ -6,7 +6,7 @@ import org.apollo.game.sync.block.SynchronizationBlock; /** * An {@link InventoryListener} which updates the player's appearance when any items are updated. - * + * * @author Graham */ public final class AppearanceInventoryListener extends InventoryAdapter { @@ -18,7 +18,7 @@ public final class AppearanceInventoryListener extends InventoryAdapter { /** * Creates the appearance inventory listener. - * + * * @param player The player. */ public AppearanceInventoryListener(Player player) { diff --git a/src/org/apollo/game/model/inv/FullInventoryListener.java b/src/org/apollo/game/model/inv/FullInventoryListener.java index 00f747d8..cdd94f5e 100644 --- a/src/org/apollo/game/model/inv/FullInventoryListener.java +++ b/src/org/apollo/game/model/inv/FullInventoryListener.java @@ -6,7 +6,7 @@ import org.apollo.game.model.entity.Player; /** * An {@link InventoryListener} which sends a message to a player when an inventory has run out of space. - * + * * @author Graham */ public final class FullInventoryListener extends InventoryAdapter { @@ -33,7 +33,7 @@ public final class FullInventoryListener extends InventoryAdapter { /** * Creates the empty inventory listener. - * + * * @param player The player. * @param message The message to send when the inventory is empty. */ diff --git a/src/org/apollo/game/model/inv/Inventory.java b/src/org/apollo/game/model/inv/Inventory.java index ac6abbe1..6fa3d71c 100644 --- a/src/org/apollo/game/model/inv/Inventory.java +++ b/src/org/apollo/game/model/inv/Inventory.java @@ -12,14 +12,14 @@ import com.google.common.base.Preconditions; /** * Represents an inventory - a collection of {@link Item}s. - * + * * @author Graham */ public final class Inventory { /** * An enumeration containing the different 'stacking modes' of an {@link Inventory}. - * + * * @author Graham */ public static enum StackMode { @@ -75,7 +75,7 @@ public final class Inventory { /** * Creates an inventory. - * + * * @param capacity The capacity. */ public Inventory(int capacity) { @@ -84,7 +84,7 @@ public final class Inventory { /** * Creates an inventory. - * + * * @param capacity The capacity. * @param mode The {@link StackMode}. * @throws IllegalArgumentException If the capacity is negative. @@ -101,7 +101,7 @@ public final class Inventory { /** * An alias for {@code add(id, 1)}. - * + * * @param id The id. * @return {@code true} if the item was added, {@code false} if there was not enough room. */ @@ -111,7 +111,7 @@ public final class Inventory { /** * An alias for {@code add(new Item(id, amount)}. - * + * * @param id The id. * @param amount The amount. * @return The amount that remains. @@ -205,7 +205,7 @@ public final class Inventory { /** * Adds an {@link InventoryListener}. - * + * * @param listener The listener. */ public void addListener(InventoryListener listener) { @@ -214,7 +214,7 @@ public final class Inventory { /** * Gets the capacity of this inventory. - * + * * @return The capacity. */ public int capacity() { @@ -223,7 +223,7 @@ public final class Inventory { /** * Checks the bounds of the specified slots. - * + * * @param slots The slots. * @throws IndexOutOfBoundsException If the slot is out of bounds. */ @@ -244,7 +244,7 @@ public final class Inventory { /** * Creates a copy of this inventory. Listeners are not copied. - * + * * @return The duplicated inventory. */ public Inventory duplicate() { @@ -256,7 +256,7 @@ public final class Inventory { /** * Checks if this inventory contains an item with the specified id. - * + * * @param id The item's id. * @return {@code true} if so, {@code false} if not. */ @@ -266,7 +266,7 @@ public final class Inventory { /** * Returns whether or not this inventory contains any items with one of the specified ids. - * + * * @param ids The ids. * @return {@code true} if the inventory does contain at least one of the items, otherwise {@code false}. */ @@ -276,7 +276,7 @@ public final class Inventory { /** * Returns whether or not this inventory contains an item for each of the specified ids. - * + * * @param ids The ids. * @return {@code true} if items in this inventory every id is */ @@ -300,7 +300,7 @@ public final class Inventory { /** * Forces a refresh of a specific slot. - * + * * @param slot The slot. */ public void forceRefresh(int slot) { @@ -309,7 +309,7 @@ public final class Inventory { /** * Gets the number of free slots. - * + * * @return The number of free slots. */ public int freeSlots() { @@ -318,7 +318,7 @@ public final class Inventory { /** * Gets the item in the specified slot. - * + * * @param slot The slot. * @return The item, or {@code null} if the slot is empty. */ @@ -329,7 +329,7 @@ public final class Inventory { /** * Gets the amount of items with the specified id in this inventory. - * + * * @param id The id. * @return The number of matching items, or {@code 0} if none were found. */ @@ -356,7 +356,7 @@ public final class Inventory { /** * Gets a clone of the items array. - * + * * @return A clone of the items array. */ public Item[] getItems() { @@ -365,7 +365,7 @@ public final class Inventory { /** * Checks if the item with the specified {@link ItemDefinition} should be stacked. - * + * * @param definition The item definition. * @return {@code true} if the item should be stacked, {@code false} otherwise. */ @@ -403,7 +403,7 @@ public final class Inventory { /** * Notifies listeners that the specified slot has been updated. - * + * * @param slot The slot. */ private void notifyItemUpdated(int slot) { @@ -414,7 +414,7 @@ public final class Inventory { /** * Removes one item with the specified id. - * + * * @param id The id. * @return {@code true} if the item was removed, {@code false} otherwise. */ @@ -427,7 +427,7 @@ public final class Inventory { *

    * This method will attempt to remove one of each item, and will continue even if a previous item could not be * removed. - * + * * @param ids The ids of the item to remove. * @return {@code true} if one of each item could be removed, otherwise {@code false}. */ @@ -443,7 +443,7 @@ public final class Inventory { /** * Removes {@code amount} of the item with the specified {@code id}. If the item is stackable, it will remove it * from the stack. If not, it'll remove {@code amount} items. - * + * * @param id The id. * @param amount The amount. * @return The amount that was removed. @@ -499,7 +499,7 @@ public final class Inventory { /** * An alias for {@code remove(item.getId(), item.getAmount())}. - * + * * @param item The item to remove. * @return The amount that was removed. */ @@ -516,7 +516,7 @@ public final class Inventory { /** * Removes a listener. - * + * * @param listener The listener to remove. */ public void removeListener(InventoryListener listener) { @@ -527,7 +527,7 @@ public final class Inventory { * Removes {@code amount} of the item at the specified {@code slot}. If the item is not stacked, it will only remove * the single item at the slot (meaning it will ignore any amount higher than 1). This means that this method will * under no circumstances make any changes to other slots. - * + * * @param slot The slot. * @param amount The amount to remove. * @return The amount that was removed (0 if nothing was removed). @@ -540,7 +540,7 @@ public final class Inventory { int removed = Math.min(amount, itemAmount); int remainder = itemAmount - removed; - set(slot, (remainder > 0) ? new Item(item.getId(), remainder) : null); + set(slot, remainder > 0 ? new Item(item.getId(), remainder) : null); return removed; } } @@ -550,7 +550,7 @@ public final class Inventory { /** * Removes the item (if any) that is in the specified slot. - * + * * @param slot The slot to reset. * @return The item that was in the slot. */ @@ -569,7 +569,7 @@ public final class Inventory { /** * Sets the item that is in the specified slot. - * + * * @param slot The slot. * @param item The item, or {@code null} to remove the item that is in the slot. * @return The item that was in the slot. @@ -609,7 +609,7 @@ public final class Inventory { /** * Gets the size of this inventory - the number of used slots. - * + * * @return The size. */ public int size() { @@ -618,7 +618,7 @@ public final class Inventory { /** * Gets the inventory slot for the specified id. - * + * * @param id The id. * @return The first slot containing the specified item, or {@code -1} if none of the slots matched the conditions. */ @@ -654,7 +654,7 @@ public final class Inventory { /** * Swaps the two items at the specified slots. - * + * * @param insert If the swap should be done in insertion mode. * @param oldSlot The old slot. * @param newSlot The new slot. @@ -684,7 +684,7 @@ public final class Inventory { /** * Swaps the two items at the specified slots. - * + * * @param oldSlot The old slot. * @param newSlot The new slot. */ diff --git a/src/org/apollo/game/model/inv/InventoryAdapter.java b/src/org/apollo/game/model/inv/InventoryAdapter.java index 52cb6260..15a97276 100644 --- a/src/org/apollo/game/model/inv/InventoryAdapter.java +++ b/src/org/apollo/game/model/inv/InventoryAdapter.java @@ -4,7 +4,7 @@ import org.apollo.game.model.Item; /** * An adapter for the {@link InventoryListener}. - * + * * @author Graham */ public abstract class InventoryAdapter implements InventoryListener { diff --git a/src/org/apollo/game/model/inv/InventoryConstants.java b/src/org/apollo/game/model/inv/InventoryConstants.java index 82fa704a..b3eefa61 100644 --- a/src/org/apollo/game/model/inv/InventoryConstants.java +++ b/src/org/apollo/game/model/inv/InventoryConstants.java @@ -2,7 +2,7 @@ package org.apollo.game.model.inv; /** * Holds {@link Inventory}-related constants. - * + * * @author Graham */ public final class InventoryConstants { diff --git a/src/org/apollo/game/model/inv/InventoryListener.java b/src/org/apollo/game/model/inv/InventoryListener.java index 152fd956..1b6ef81e 100644 --- a/src/org/apollo/game/model/inv/InventoryListener.java +++ b/src/org/apollo/game/model/inv/InventoryListener.java @@ -4,28 +4,28 @@ import org.apollo.game.model.Item; /** * An interface which listens to events from an {@link Inventory}. - * + * * @author Graham */ public interface InventoryListener { /** * Called when the capacity of an inventory has been exceeded. - * + * * @param inventory The inventory. */ public void capacityExceeded(Inventory inventory); /** * Called when items have been updated in bulk. - * + * * @param inventory The inventory. */ public void itemsUpdated(Inventory inventory); /** * Called when an item has been updated. - * + * * @param inventory The inventory. * @param slot The slot. * @param item The new item, or {@code null} if there is no new item. diff --git a/src/org/apollo/game/model/inv/SlottedItem.java b/src/org/apollo/game/model/inv/SlottedItem.java index 266b2109..cf7d2ebf 100644 --- a/src/org/apollo/game/model/inv/SlottedItem.java +++ b/src/org/apollo/game/model/inv/SlottedItem.java @@ -4,7 +4,7 @@ import org.apollo.game.model.Item; /** * A class which contains an {@link Item} and its corresponding slot. - * + * * @author Graham */ public final class SlottedItem { @@ -21,7 +21,7 @@ public final class SlottedItem { /** * Creates a new slotted item. - * + * * @param slot The slot. * @param item The item. */ @@ -32,7 +32,7 @@ public final class SlottedItem { /** * Gets the amount of the {@link Item}. - * + * * @return The amount. */ public int getAmount() { @@ -41,7 +41,7 @@ public final class SlottedItem { /** * Gets the id of the {@link Item}. - * + * * @return The id. */ public int getId() { @@ -50,7 +50,7 @@ public final class SlottedItem { /** * Gets the item. - * + * * @return The item. */ public Item getItem() { @@ -59,7 +59,7 @@ public final class SlottedItem { /** * Gets the slot. - * + * * @return The slot. */ public int getSlot() { diff --git a/src/org/apollo/game/model/inv/SynchronizationInventoryListener.java b/src/org/apollo/game/model/inv/SynchronizationInventoryListener.java index f6b9d7de..9e46970c 100644 --- a/src/org/apollo/game/model/inv/SynchronizationInventoryListener.java +++ b/src/org/apollo/game/model/inv/SynchronizationInventoryListener.java @@ -7,7 +7,7 @@ import org.apollo.game.model.entity.Player; /** * An {@link InventoryListener} which synchronizes the state of the server's inventory with the client's. - * + * * @author Graham */ public final class SynchronizationInventoryListener extends InventoryAdapter { @@ -34,7 +34,7 @@ public final class SynchronizationInventoryListener extends InventoryAdapter { /** * Creates the synchronization inventory listener. - * + * * @param player The player. * @param interfaceId The interface id. */ diff --git a/src/org/apollo/game/model/skill/LevelUpSkillListener.java b/src/org/apollo/game/model/skill/LevelUpSkillListener.java index 3539fb67..915ee1de 100644 --- a/src/org/apollo/game/model/skill/LevelUpSkillListener.java +++ b/src/org/apollo/game/model/skill/LevelUpSkillListener.java @@ -7,7 +7,7 @@ import org.apollo.util.LanguageUtil; /** * A {@link SkillListener} which notifies the player when they have levelled up a skill. - * + * * @author Graham */ public final class LevelUpSkillListener extends SkillAdapter { @@ -19,7 +19,7 @@ public final class LevelUpSkillListener extends SkillAdapter { /** * Creates the level up listener for the specified player. - * + * * @param player The player. */ public LevelUpSkillListener(Player player) { diff --git a/src/org/apollo/game/model/skill/SkillAdapter.java b/src/org/apollo/game/model/skill/SkillAdapter.java index 83c98a34..9cd92856 100644 --- a/src/org/apollo/game/model/skill/SkillAdapter.java +++ b/src/org/apollo/game/model/skill/SkillAdapter.java @@ -5,7 +5,7 @@ import org.apollo.game.model.entity.SkillSet; /** * An adapter for the {@link SkillListener}. - * + * * @author Graham */ public abstract class SkillAdapter implements SkillListener { diff --git a/src/org/apollo/game/model/skill/SkillListener.java b/src/org/apollo/game/model/skill/SkillListener.java index aa6cc33d..d4b1b041 100644 --- a/src/org/apollo/game/model/skill/SkillListener.java +++ b/src/org/apollo/game/model/skill/SkillListener.java @@ -5,14 +5,14 @@ import org.apollo.game.model.entity.SkillSet; /** * An interface which listens to events from a {@link SkillSet}. - * + * * @author Graham */ public interface SkillListener { /** * Called when a {@link Skill} is levelled up. - * + * * @param set The {@link SkillSet}. * @param id The skill's id. * @param skill The skill. @@ -21,14 +21,14 @@ public interface SkillListener { /** * Called when all {@link Skill}s are updated. - * + * * @param set The {@link SkillSet}. */ public void skillsUpdated(SkillSet set); /** * Called when a single {@link Skill} is updated. - * + * * @param set The {@link SkillSet}. * @param id The skill's id. * @param skill The skill. diff --git a/src/org/apollo/game/model/skill/SynchronizationSkillListener.java b/src/org/apollo/game/model/skill/SynchronizationSkillListener.java index 149befe9..8f599f7a 100644 --- a/src/org/apollo/game/model/skill/SynchronizationSkillListener.java +++ b/src/org/apollo/game/model/skill/SynchronizationSkillListener.java @@ -10,7 +10,7 @@ import org.apollo.game.sync.block.SynchronizationBlock; /** * A {@link SkillListener} which synchronizes the state of a {@link SkillSet} with a client. - * + * * @author Graham */ public final class SynchronizationSkillListener extends SkillAdapter { @@ -22,7 +22,7 @@ public final class SynchronizationSkillListener extends SkillAdapter { /** * Creates the skill synchronization listener. - * + * * @param player The player. */ public SynchronizationSkillListener(Player player) { diff --git a/src/org/apollo/game/scheduling/ScheduledTask.java b/src/org/apollo/game/scheduling/ScheduledTask.java index 32ec6421..8f80129d 100644 --- a/src/org/apollo/game/scheduling/ScheduledTask.java +++ b/src/org/apollo/game/scheduling/ScheduledTask.java @@ -4,7 +4,7 @@ import com.google.common.base.Preconditions; /** * A game-related task that is scheduled to run in the future. - * + * * @author Graham */ public abstract class ScheduledTask { @@ -26,7 +26,7 @@ public abstract class ScheduledTask { /** * Creates a new scheduled task. - * + * * @param delay The delay between executions of the task, in pulses. * @param immediate A flag indicating if this task should (for the first execution) be ran immediately, or after the * {@code delay}. @@ -44,7 +44,7 @@ public abstract class ScheduledTask { /** * Checks if this task is running. - * + * * @return {@code true} if so, {@code false} if not. */ public final boolean isRunning() { @@ -63,7 +63,7 @@ public abstract class ScheduledTask { /** * Sets the delay. - * + * * @param delay The delay. * @throws IllegalArgumentException If the delay is less than zero. */ diff --git a/src/org/apollo/game/scheduling/Scheduler.java b/src/org/apollo/game/scheduling/Scheduler.java index c3af4301..725eceee 100644 --- a/src/org/apollo/game/scheduling/Scheduler.java +++ b/src/org/apollo/game/scheduling/Scheduler.java @@ -10,7 +10,7 @@ import org.apollo.util.CollectionUtil; /** * A class which manages {@link ScheduledTask}s. - * + * * @author Graham */ public final class Scheduler { @@ -42,7 +42,7 @@ public final class Scheduler { /** * Schedules a new task. - * + * * @param task The task to schedule. * @return {@code true} if the task was added successfully. */ diff --git a/src/org/apollo/game/scheduling/impl/NpcMovementTask.java b/src/org/apollo/game/scheduling/impl/NpcMovementTask.java index 5072c2f7..7bcdcf73 100644 --- a/src/org/apollo/game/scheduling/impl/NpcMovementTask.java +++ b/src/org/apollo/game/scheduling/impl/NpcMovementTask.java @@ -49,7 +49,7 @@ public final class NpcMovementTask extends ScheduledTask { /** * Creates the NpcMovementTask. - * + * * @param repository The {@link RegionRepository}. */ public NpcMovementTask(RegionRepository repository) { @@ -59,7 +59,7 @@ public final class NpcMovementTask extends ScheduledTask { /** * Adds the {@link Npc} to this {@link ScheduledTask}. - * + * * @param npc The Npc to add. */ public void addNpc(Npc npc) { @@ -82,8 +82,8 @@ public final class NpcMovementTask extends ScheduledTask { int currentX = current.getX(), currentY = current.getY(); boolean negativeX = RANDOM.nextBoolean(), negativeY = RANDOM.nextBoolean(); - int x = RANDOM.nextInt(negativeX ? (currentX - min.getX()) : (max.getX() - currentX)); - int y = RANDOM.nextInt(negativeY ? (currentY - min.getY()) : (max.getY() - currentY)); + int x = RANDOM.nextInt(negativeX ? currentX - min.getX() : max.getX() - currentX); + int y = RANDOM.nextInt(negativeY ? currentY - min.getY() : max.getY() - currentY); int dx = negativeX ? -x : x; int dy = negativeY ? -y : y; diff --git a/src/org/apollo/game/scheduling/impl/SkillNormalizationTask.java b/src/org/apollo/game/scheduling/impl/SkillNormalizationTask.java index 8e88a3fc..2408d87a 100644 --- a/src/org/apollo/game/scheduling/impl/SkillNormalizationTask.java +++ b/src/org/apollo/game/scheduling/impl/SkillNormalizationTask.java @@ -6,7 +6,7 @@ import org.apollo.game.scheduling.ScheduledTask; /** * A {@link ScheduledTask} which normalizes the skills of a player: gradually brings them back to their normal value as * specified by the experience. - * + * * @author Graham */ public final class SkillNormalizationTask extends ScheduledTask { @@ -18,7 +18,7 @@ public final class SkillNormalizationTask extends ScheduledTask { /** * Creates the skill normalization task. - * + * * @param mob The mob. */ public SkillNormalizationTask(Mob mob) { diff --git a/src/org/apollo/game/sync/ClientSynchronizer.java b/src/org/apollo/game/sync/ClientSynchronizer.java index 21237688..56679b65 100644 --- a/src/org/apollo/game/sync/ClientSynchronizer.java +++ b/src/org/apollo/game/sync/ClientSynchronizer.java @@ -13,14 +13,14 @@ import org.apollo.util.MobRepository; * To switch between the two synchronizer implementations, edit the {@code synchronizers.xml} configuration file. The * default implementation is currently {@link ParallelClientSynchronizer} as the vast majority of machines today have * two or more cores. - * + * * @author Graham */ public abstract class ClientSynchronizer { /** * Synchronizes the state of the clients with the state of the server. - * + * * @param players The {@link MobRepository} containing the {@link Player}s. * @param npcs The {@link MobRepository} containing the {@link Npc}s. */ diff --git a/src/org/apollo/game/sync/ParallelClientSynchronizer.java b/src/org/apollo/game/sync/ParallelClientSynchronizer.java index 325a2ce3..54b6b202 100644 --- a/src/org/apollo/game/sync/ParallelClientSynchronizer.java +++ b/src/org/apollo/game/sync/ParallelClientSynchronizer.java @@ -31,7 +31,7 @@ import com.google.common.util.concurrent.ThreadFactoryBuilder; * synchronization. This class will scale well with machines that have multiple cores/processors. The * {@link SequentialClientSynchronizer} will work better on machines with a single core/processor, however, both classes * will work. - * + * * @author Graham * @author Major */ diff --git a/src/org/apollo/game/sync/SequentialClientSynchronizer.java b/src/org/apollo/game/sync/SequentialClientSynchronizer.java index eef83b46..432be137 100644 --- a/src/org/apollo/game/sync/SequentialClientSynchronizer.java +++ b/src/org/apollo/game/sync/SequentialClientSynchronizer.java @@ -23,7 +23,7 @@ import org.apollo.util.MobRepository; * which this is called). Each client is processed sequentially. Therefore this class will work well on machines with a * single core/processor. The {@link ParallelClientSynchronizer} will work better on machines with multiple * cores/processors, however, both classes will work. - * + * * @author Graham * @author Major */ diff --git a/src/org/apollo/game/sync/block/AnimationBlock.java b/src/org/apollo/game/sync/block/AnimationBlock.java index bfee77ef..4e476acc 100644 --- a/src/org/apollo/game/sync/block/AnimationBlock.java +++ b/src/org/apollo/game/sync/block/AnimationBlock.java @@ -4,7 +4,7 @@ import org.apollo.game.model.Animation; /** * The animation {@link SynchronizationBlock}. Both npcs and players can utilise this block. - * + * * @author Graham */ public final class AnimationBlock extends SynchronizationBlock { @@ -16,7 +16,7 @@ public final class AnimationBlock extends SynchronizationBlock { /** * Creates the animation block. - * + * * @param animation The animation. */ AnimationBlock(Animation animation) { @@ -25,7 +25,7 @@ public final class AnimationBlock extends SynchronizationBlock { /** * Gets the {@link Animation}. - * + * * @return The animation. */ public Animation getAnimation() { diff --git a/src/org/apollo/game/sync/block/AppearanceBlock.java b/src/org/apollo/game/sync/block/AppearanceBlock.java index db91ea42..a2a54356 100644 --- a/src/org/apollo/game/sync/block/AppearanceBlock.java +++ b/src/org/apollo/game/sync/block/AppearanceBlock.java @@ -5,7 +5,7 @@ import org.apollo.game.model.inv.Inventory; /** * The appearance {@link SynchronizationBlock}. Only players can utilise this block. - * + * * @author Graham */ public final class AppearanceBlock extends SynchronizationBlock { @@ -52,7 +52,7 @@ public final class AppearanceBlock extends SynchronizationBlock { /** * Creates the appearance block. Assumes that the player is not appearing as an npc. - * + * * @param name The player's username, encoded to base 37. * @param appearance The {@link Appearance}. * @param combat The player's combat. @@ -67,7 +67,7 @@ public final class AppearanceBlock extends SynchronizationBlock { /** * Creates the appearance block. - * + * * @param name The player's username, encoded to base 37. * @param appearance The {@link Appearance}. * @param combat The player's combat. @@ -90,7 +90,7 @@ public final class AppearanceBlock extends SynchronizationBlock { /** * If the player is appearing as an npc or not. - * + * * @return {@code true} if the player is appearing as an npc, otherwise {@code false}. */ public boolean appearingAsNpc() { @@ -99,7 +99,7 @@ public final class AppearanceBlock extends SynchronizationBlock { /** * Gets the player's {@link Appearance}. - * + * * @return The player's appearance. */ public Appearance getAppearance() { @@ -108,7 +108,7 @@ public final class AppearanceBlock extends SynchronizationBlock { /** * Gets the player's combat level. - * + * * @return The player's combat level. */ public int getCombatLevel() { @@ -117,7 +117,7 @@ public final class AppearanceBlock extends SynchronizationBlock { /** * Gets the player's equipment. - * + * * @return The player's equipment. */ public Inventory getEquipment() { @@ -126,7 +126,7 @@ public final class AppearanceBlock extends SynchronizationBlock { /** * Whether or not the player is skulled. - * + * * @return {@code true} if the player is skulled, otherwise {@code false}. */ public boolean isSkulled() { @@ -135,7 +135,7 @@ public final class AppearanceBlock extends SynchronizationBlock { /** * Gets the player's name. - * + * * @return The player's name. */ public long getName() { @@ -144,7 +144,7 @@ public final class AppearanceBlock extends SynchronizationBlock { /** * Gets the npc id the player is appearing as, or {@code -1} if the player is not appearing as one. - * + * * @return The npc id. */ public int getNpcId() { @@ -153,7 +153,7 @@ public final class AppearanceBlock extends SynchronizationBlock { /** * Gets the player's head icon. - * + * * @return The head icon. */ public int getHeadIcon() { @@ -162,7 +162,7 @@ public final class AppearanceBlock extends SynchronizationBlock { /** * Gets the player's skill level. - * + * * @return The player's skill level. */ public int getSkillLevel() { diff --git a/src/org/apollo/game/sync/block/ChatBlock.java b/src/org/apollo/game/sync/block/ChatBlock.java index 14bbba81..241575d5 100644 --- a/src/org/apollo/game/sync/block/ChatBlock.java +++ b/src/org/apollo/game/sync/block/ChatBlock.java @@ -5,7 +5,7 @@ import org.apollo.game.model.entity.setting.PrivilegeLevel; /** * The chat {@link SynchronizationBlock}. Only players can utilise this block. - * + * * @author Graham */ public final class ChatBlock extends SynchronizationBlock { @@ -22,7 +22,7 @@ public final class ChatBlock extends SynchronizationBlock { /** * Creates the chat block. - * + * * @param privilegeLevel The {@link PrivilegeLevel} of the player who said the message. * @param chatMessage The {@link ChatMessage}. */ @@ -33,7 +33,7 @@ public final class ChatBlock extends SynchronizationBlock { /** * Gets the compressed message. - * + * * @return The compressed message. */ public byte[] getCompressedMessage() { @@ -42,7 +42,7 @@ public final class ChatBlock extends SynchronizationBlock { /** * Gets the message. - * + * * @return The message. */ public String getMessage() { @@ -51,7 +51,7 @@ public final class ChatBlock extends SynchronizationBlock { /** * Gets the {@link PrivilegeLevel} of the player who said the message. - * + * * @return The privilege level. */ public PrivilegeLevel getPrivilegeLevel() { @@ -60,7 +60,7 @@ public final class ChatBlock extends SynchronizationBlock { /** * Gets the text color. - * + * * @return The text color. */ public int getTextColor() { @@ -69,7 +69,7 @@ public final class ChatBlock extends SynchronizationBlock { /** * Gets the text effects. - * + * * @return The text effects. */ public int getTextEffects() { diff --git a/src/org/apollo/game/sync/block/ForceChatBlock.java b/src/org/apollo/game/sync/block/ForceChatBlock.java index 1bd0a580..7dae2b8a 100644 --- a/src/org/apollo/game/sync/block/ForceChatBlock.java +++ b/src/org/apollo/game/sync/block/ForceChatBlock.java @@ -3,7 +3,7 @@ package org.apollo.game.sync.block; /** * The force chat {@link SynchronizationBlock}. Both players and npcs can utilise this block. It is not possible to add * colour or effect (e.g. wave or scroll) to this block. - * + * * @author Major */ public final class ForceChatBlock extends SynchronizationBlock { @@ -15,7 +15,7 @@ public final class ForceChatBlock extends SynchronizationBlock { /** * Creates the force chat block. - * + * * @param message The message. */ ForceChatBlock(String message) { @@ -24,7 +24,7 @@ public final class ForceChatBlock extends SynchronizationBlock { /** * Gets the message being sent by this block. - * + * * @return The message. */ public String getMessage() { diff --git a/src/org/apollo/game/sync/block/ForceMovementBlock.java b/src/org/apollo/game/sync/block/ForceMovementBlock.java index 4b22f050..874fe9d1 100644 --- a/src/org/apollo/game/sync/block/ForceMovementBlock.java +++ b/src/org/apollo/game/sync/block/ForceMovementBlock.java @@ -9,7 +9,7 @@ import org.apollo.game.model.Position; * Note: This block is used to force a player to walk to a set location. The player can then perform an action (e.g. an * animation), as used in the Agility skill, hence this block earning the name 'Asynchronous Animation/Walking', * although the action is not restricted to animations. - * + * * @author Major */ public final class ForceMovementBlock extends SynchronizationBlock { @@ -41,7 +41,7 @@ public final class ForceMovementBlock extends SynchronizationBlock { /** * Creates a new force movement block. - * + * * @param initialPosition The initial {@link Position} of the player. * @param finalPosition The final {@link Position} of the player * @param travelDurationX The length of time (in game pulses) the player's movement along the X-axis will last. @@ -58,7 +58,7 @@ public final class ForceMovementBlock extends SynchronizationBlock { /** * Gets the {@link Direction} the player should move. - * + * * @return The direction. */ public Direction getDirection() { @@ -67,7 +67,7 @@ public final class ForceMovementBlock extends SynchronizationBlock { /** * Gets the X coordinate of the final {@link Position}. - * + * * @return The X coordinate. */ public int getFinalX() { @@ -76,7 +76,7 @@ public final class ForceMovementBlock extends SynchronizationBlock { /** * Gets the Y coordinate of the final {@link Position}. - * + * * @return The Y coordinate. */ public int getFinalY() { @@ -85,7 +85,7 @@ public final class ForceMovementBlock extends SynchronizationBlock { /** * Gets the X coordinate of the initial {@link Position}. - * + * * @return The X coordinate. */ public int getInitialX() { @@ -94,7 +94,7 @@ public final class ForceMovementBlock extends SynchronizationBlock { /** * Gets the Y coordinate of the initial {@link Position}. - * + * * @return The Y coordinate. */ public int getInitialY() { @@ -103,7 +103,7 @@ public final class ForceMovementBlock extends SynchronizationBlock { /** * Gets the length of time (in game pulses) the player's movement along the X-axis will last. - * + * * @return The time period. */ public int getTravelDurationX() { @@ -112,7 +112,7 @@ public final class ForceMovementBlock extends SynchronizationBlock { /** * Gets the length of time (in game pulses) the player's movement along the Y-axis will last. - * + * * @return The time period. */ public int getTravelDurationY() { diff --git a/src/org/apollo/game/sync/block/GraphicBlock.java b/src/org/apollo/game/sync/block/GraphicBlock.java index 9377efa9..c263c54e 100644 --- a/src/org/apollo/game/sync/block/GraphicBlock.java +++ b/src/org/apollo/game/sync/block/GraphicBlock.java @@ -4,7 +4,7 @@ import org.apollo.game.model.Graphic; /** * The graphic {@link SynchronizationBlock}. Both players and npcs can utilise this block. - * + * * @author Graham */ public final class GraphicBlock extends SynchronizationBlock { @@ -16,7 +16,7 @@ public final class GraphicBlock extends SynchronizationBlock { /** * Creates the graphic block. - * + * * @param graphic The graphic. */ GraphicBlock(Graphic graphic) { @@ -25,7 +25,7 @@ public final class GraphicBlock extends SynchronizationBlock { /** * Gets the {@link Graphic}. - * + * * @return The graphic. */ public Graphic getGraphic() { diff --git a/src/org/apollo/game/sync/block/HitUpdateBlock.java b/src/org/apollo/game/sync/block/HitUpdateBlock.java index 9fd9f770..b51d4c27 100644 --- a/src/org/apollo/game/sync/block/HitUpdateBlock.java +++ b/src/org/apollo/game/sync/block/HitUpdateBlock.java @@ -2,7 +2,7 @@ package org.apollo.game.sync.block; /** * The hit update {@link SynchronizationBlock}. Both npcs and players can utilise this block. - * + * * @author Major */ public final class HitUpdateBlock extends SynchronizationBlock { @@ -29,7 +29,7 @@ public final class HitUpdateBlock extends SynchronizationBlock { /** * Creates the hit update block. - * + * * @param damage The damage dealt by the hit. * @param type The type of hit. * @param currentHealth The current health of the mob. @@ -44,7 +44,7 @@ public final class HitUpdateBlock extends SynchronizationBlock { /** * Gets the current health of the mob. - * + * * @return The current health; */ public int getCurrentHealth() { @@ -53,7 +53,7 @@ public final class HitUpdateBlock extends SynchronizationBlock { /** * Gets the damage done by the hit. - * + * * @return The damage. */ public int getDamage() { @@ -62,7 +62,7 @@ public final class HitUpdateBlock extends SynchronizationBlock { /** * Gets the maximum health of the mob. - * + * * @return The maximum health. */ public int getMaximumHealth() { @@ -71,7 +71,7 @@ public final class HitUpdateBlock extends SynchronizationBlock { /** * Gets the hit type. - * + * * @return The type. */ public int getType() { diff --git a/src/org/apollo/game/sync/block/InteractingMobBlock.java b/src/org/apollo/game/sync/block/InteractingMobBlock.java index 23c646c9..875988db 100644 --- a/src/org/apollo/game/sync/block/InteractingMobBlock.java +++ b/src/org/apollo/game/sync/block/InteractingMobBlock.java @@ -2,7 +2,7 @@ package org.apollo.game.sync.block; /** * The interacting mob {@link SynchronizationBlock}. Both players and npcs can utilise this block. - * + * * @author Major */ public final class InteractingMobBlock extends SynchronizationBlock { @@ -19,7 +19,7 @@ public final class InteractingMobBlock extends SynchronizationBlock { /** * Creates the interacting mob block. - * + * * @param index The index of the current interacting mob. */ InteractingMobBlock(int index) { @@ -28,7 +28,7 @@ public final class InteractingMobBlock extends SynchronizationBlock { /** * Gets the interacting mob's index. - * + * * @return The index. */ public int getIndex() { diff --git a/src/org/apollo/game/sync/block/SecondaryHitUpdateBlock.java b/src/org/apollo/game/sync/block/SecondaryHitUpdateBlock.java index 21e66686..46c579e6 100644 --- a/src/org/apollo/game/sync/block/SecondaryHitUpdateBlock.java +++ b/src/org/apollo/game/sync/block/SecondaryHitUpdateBlock.java @@ -3,7 +3,7 @@ package org.apollo.game.sync.block; /** * The secondary hit update {@link SynchronizationBlock}. This is used for when multiple attacks happen at once (for * example, the dragon-dagger special attack). Both players and npcs can utilise this block. - * + * * @author Major */ public final class SecondaryHitUpdateBlock extends SynchronizationBlock { @@ -30,7 +30,7 @@ public final class SecondaryHitUpdateBlock extends SynchronizationBlock { /** * Creates a new secondary hit update block. - * + * * @param damage The damage dealt by the hit. * @param type The type of hit. * @param currentHealth The current health of the mob. @@ -45,7 +45,7 @@ public final class SecondaryHitUpdateBlock extends SynchronizationBlock { /** * Gets the current health of the mob. - * + * * @return The current health; */ public int getCurrentHealth() { @@ -54,7 +54,7 @@ public final class SecondaryHitUpdateBlock extends SynchronizationBlock { /** * Gets the damage done by the hit. - * + * * @return The damage. */ public int getDamage() { @@ -63,7 +63,7 @@ public final class SecondaryHitUpdateBlock extends SynchronizationBlock { /** * Gets the maximum health of the mob. - * + * * @return The maximum health. */ public int getMaximumHealth() { @@ -72,7 +72,7 @@ public final class SecondaryHitUpdateBlock extends SynchronizationBlock { /** * Gets the hit type. - * + * * @return The type. */ public int getType() { diff --git a/src/org/apollo/game/sync/block/SynchronizationBlock.java b/src/org/apollo/game/sync/block/SynchronizationBlock.java index b6817c8c..39c3b2e5 100644 --- a/src/org/apollo/game/sync/block/SynchronizationBlock.java +++ b/src/org/apollo/game/sync/block/SynchronizationBlock.java @@ -12,14 +12,14 @@ import org.apollo.game.sync.seg.SynchronizationSegment; * A synchronization block is part of a {@link SynchronizationSegment}. A segment can have up to one block of each type. *

    * This class also has static factory methods for creating {@link SynchronizationBlock}s. - * + * * @author Graham */ public abstract class SynchronizationBlock { /** * Creates an {@link AnimationBlock} with the specified animation. - * + * * @param animation The animation. * @return The animation block. */ @@ -29,7 +29,7 @@ public abstract class SynchronizationBlock { /** * Creates an {@link AppearanceBlock} for the specified player. - * + * * @param player The player. * @return The appearance block. */ @@ -42,7 +42,7 @@ public abstract class SynchronizationBlock { /** * Creates a {@link ChatBlock} for the specified player. - * + * * @param player The player. * @param chatMessage The chat message. * @return The chat block. @@ -53,7 +53,7 @@ public abstract class SynchronizationBlock { /** * Creates a {@link ForceChatBlock} with the specified message. - * + * * @param message The message. * @return The force chat block. */ @@ -63,7 +63,7 @@ public abstract class SynchronizationBlock { /** * Creates a {@link ForceMovementBlock} with the specified parameters. - * + * * @param initialPosition The initial {@link Position} of the player. * @param finalPosition The final position of the player * @param travelDurationX The length of time (in game pulses) the player's movement along the X axis will last. @@ -77,7 +77,7 @@ public abstract class SynchronizationBlock { /** * Creates a {@link GraphicBlock} with the specified graphic. - * + * * @param graphic The graphic. * @return The graphic block. */ @@ -88,7 +88,7 @@ public abstract class SynchronizationBlock { /** * Creates a {@link HitUpdateBlock} or {@link SecondaryHitUpdateBlock}, depending on the value of the * {@code secondary} flag. - * + * * @param damage The damage dealt by the hit. * @param type The type of hit. * @param currentHealth The current health of the mob. @@ -102,7 +102,7 @@ public abstract class SynchronizationBlock { /** * Creates an {@link InteractingMobBlock} with the specified index. - * + * * @param index The index of the mob being interacted with. * @return The interacting mob block. */ @@ -112,7 +112,7 @@ public abstract class SynchronizationBlock { /** * Creates a {@link TransformBlock} with the specified id. - * + * * @param id The id. * @return The transform block. */ @@ -122,7 +122,7 @@ public abstract class SynchronizationBlock { /** * Creates a {@link TurnToPositionBlock} with the specified {@link Position}. - * + * * @param position The position. * @return The turn to position block. */ diff --git a/src/org/apollo/game/sync/block/SynchronizationBlockSet.java b/src/org/apollo/game/sync/block/SynchronizationBlockSet.java index 32ad95a5..1b5a4820 100644 --- a/src/org/apollo/game/sync/block/SynchronizationBlockSet.java +++ b/src/org/apollo/game/sync/block/SynchronizationBlockSet.java @@ -5,7 +5,7 @@ import java.util.Map; /** * A specialized collection of {@link SynchronizationBlock}s. - * + * * @author Graham */ public final class SynchronizationBlockSet implements Cloneable { @@ -17,7 +17,7 @@ public final class SynchronizationBlockSet implements Cloneable { /** * Adds a {@link SynchronizationBlock}. - * + * * @param block The block to add. */ public void add(SynchronizationBlock block) { @@ -41,7 +41,7 @@ public final class SynchronizationBlockSet implements Cloneable { /** * Checks if this set contains the specified {@link SynchronizationBlock}. - * + * * @param clazz The block's class. * @return {@code true} if so, {@code false} if not. */ @@ -51,7 +51,7 @@ public final class SynchronizationBlockSet implements Cloneable { /** * Gets a {@link SynchronizationBlock} from this set. - * + * * @param clazz The block's class. * @return The block. */ @@ -62,7 +62,7 @@ public final class SynchronizationBlockSet implements Cloneable { /** * Removes a {@link SynchronizationBlock} from this set. - * + * * @param clazz The block's class. * @return The removed block. */ @@ -73,7 +73,7 @@ public final class SynchronizationBlockSet implements Cloneable { /** * Gets the size of this set. - * + * * @return The size. */ public int size() { diff --git a/src/org/apollo/game/sync/block/TransformBlock.java b/src/org/apollo/game/sync/block/TransformBlock.java index c0082594..56020b20 100644 --- a/src/org/apollo/game/sync/block/TransformBlock.java +++ b/src/org/apollo/game/sync/block/TransformBlock.java @@ -2,7 +2,7 @@ package org.apollo.game.sync.block; /** * The transform {@link SynchronizationBlock}. Only npcs can utilise this block. - * + * * @author Major */ public final class TransformBlock extends SynchronizationBlock { @@ -14,7 +14,7 @@ public final class TransformBlock extends SynchronizationBlock { /** * Creates a new transform block. - * + * * @param id The id. */ TransformBlock(int id) { @@ -23,7 +23,7 @@ public final class TransformBlock extends SynchronizationBlock { /** * Gets the id of the npc to transform into. - * + * * @return The id. */ public int getId() { diff --git a/src/org/apollo/game/sync/block/TurnToPositionBlock.java b/src/org/apollo/game/sync/block/TurnToPositionBlock.java index ad9af989..a9f94f29 100644 --- a/src/org/apollo/game/sync/block/TurnToPositionBlock.java +++ b/src/org/apollo/game/sync/block/TurnToPositionBlock.java @@ -4,7 +4,7 @@ import org.apollo.game.model.Position; /** * The turn to position {@link SynchronizationBlock}. Both players and npcs can utilise this block. - * + * * @author Graham */ public final class TurnToPositionBlock extends SynchronizationBlock { @@ -16,7 +16,7 @@ public final class TurnToPositionBlock extends SynchronizationBlock { /** * Creates the turn to position block. - * + * * @param position The position to turn to. */ TurnToPositionBlock(Position position) { @@ -25,7 +25,7 @@ public final class TurnToPositionBlock extends SynchronizationBlock { /** * Gets the {@link Position} to turn to. - * + * * @return The position to turn to. */ public Position getPosition() { diff --git a/src/org/apollo/game/sync/seg/AddNpcSegment.java b/src/org/apollo/game/sync/seg/AddNpcSegment.java index 18527207..196ba2b9 100644 --- a/src/org/apollo/game/sync/seg/AddNpcSegment.java +++ b/src/org/apollo/game/sync/seg/AddNpcSegment.java @@ -5,7 +5,7 @@ import org.apollo.game.sync.block.SynchronizationBlockSet; /** * A {@link SynchronizationSegment} that adds an npc. - * + * * @author Major */ public final class AddNpcSegment extends SynchronizationSegment { @@ -27,7 +27,7 @@ public final class AddNpcSegment extends SynchronizationSegment { /** * Creates the add npc segment. - * + * * @param blockSet The block set. * @param index The npcs's index. * @param position The position. @@ -42,7 +42,7 @@ public final class AddNpcSegment extends SynchronizationSegment { /** * Gets the npc's index. - * + * * @return The index. */ public int getIndex() { @@ -51,7 +51,7 @@ public final class AddNpcSegment extends SynchronizationSegment { /** * Gets the npc id. - * + * * @return The npcId */ public int getNpcId() { @@ -60,7 +60,7 @@ public final class AddNpcSegment extends SynchronizationSegment { /** * Gets the position. - * + * * @return The position. */ public Position getPosition() { diff --git a/src/org/apollo/game/sync/seg/AddPlayerSegment.java b/src/org/apollo/game/sync/seg/AddPlayerSegment.java index 69f7d4f9..a48884c3 100644 --- a/src/org/apollo/game/sync/seg/AddPlayerSegment.java +++ b/src/org/apollo/game/sync/seg/AddPlayerSegment.java @@ -5,7 +5,7 @@ import org.apollo.game.sync.block.SynchronizationBlockSet; /** * A {@link SynchronizationSegment} which adds a player. - * + * * @author Graham */ public final class AddPlayerSegment extends SynchronizationSegment { @@ -22,7 +22,7 @@ public final class AddPlayerSegment extends SynchronizationSegment { /** * Creates the add player segment. - * + * * @param blockSet The block set. * @param index The player's index. * @param position The position. @@ -35,7 +35,7 @@ public final class AddPlayerSegment extends SynchronizationSegment { /** * Gets the player's index. - * + * * @return The index. */ public int getIndex() { @@ -44,7 +44,7 @@ public final class AddPlayerSegment extends SynchronizationSegment { /** * Gets the position. - * + * * @return The position. */ public Position getPosition() { diff --git a/src/org/apollo/game/sync/seg/MovementSegment.java b/src/org/apollo/game/sync/seg/MovementSegment.java index 97376791..b0ddf203 100644 --- a/src/org/apollo/game/sync/seg/MovementSegment.java +++ b/src/org/apollo/game/sync/seg/MovementSegment.java @@ -7,7 +7,7 @@ import com.google.common.base.Preconditions; /** * A {@link SynchronizationSegment} where a mob is moved (or doesn't move!). - * + * * @author Graham */ public final class MovementSegment extends SynchronizationSegment { @@ -19,7 +19,7 @@ public final class MovementSegment extends SynchronizationSegment { /** * Creates the movement segment. - * + * * @param blockSet The block set. * @param directions The directions array. * @throws IllegalArgumentException If there are not 0, 1 or 2 directions. @@ -32,7 +32,7 @@ public final class MovementSegment extends SynchronizationSegment { /** * Gets the directions. - * + * * @return The directions. */ public Direction[] getDirections() { diff --git a/src/org/apollo/game/sync/seg/RemoveMobSegment.java b/src/org/apollo/game/sync/seg/RemoveMobSegment.java index 10b6fd08..3175a2f5 100644 --- a/src/org/apollo/game/sync/seg/RemoveMobSegment.java +++ b/src/org/apollo/game/sync/seg/RemoveMobSegment.java @@ -4,7 +4,7 @@ import org.apollo.game.sync.block.SynchronizationBlockSet; /** * A {@link SynchronizationSegment} which removes a mob. - * + * * @author Graham */ public final class RemoveMobSegment extends SynchronizationSegment { diff --git a/src/org/apollo/game/sync/seg/SegmentType.java b/src/org/apollo/game/sync/seg/SegmentType.java index 6e460092..5c3f3aaa 100644 --- a/src/org/apollo/game/sync/seg/SegmentType.java +++ b/src/org/apollo/game/sync/seg/SegmentType.java @@ -2,7 +2,7 @@ package org.apollo.game.sync.seg; /** * An enumeration which contains the types of segments. - * + * * @author Graham */ public enum SegmentType { diff --git a/src/org/apollo/game/sync/seg/SynchronizationSegment.java b/src/org/apollo/game/sync/seg/SynchronizationSegment.java index afc60efd..8d169ec0 100644 --- a/src/org/apollo/game/sync/seg/SynchronizationSegment.java +++ b/src/org/apollo/game/sync/seg/SynchronizationSegment.java @@ -8,7 +8,7 @@ import org.apollo.game.sync.block.SynchronizationBlockSet; /** * A segment contains a set of {@link SynchronizationBlock}s, {@link Direction}s (or teleport {@link Position}s) and any * other things required for the update of a single player. - * + * * @author Graham */ public abstract class SynchronizationSegment { @@ -20,7 +20,7 @@ public abstract class SynchronizationSegment { /** * Creates the segment. - * + * * @param blockSet The block set. */ public SynchronizationSegment(SynchronizationBlockSet blockSet) { @@ -29,7 +29,7 @@ public abstract class SynchronizationSegment { /** * Gets the block set. - * + * * @return The block set. */ public final SynchronizationBlockSet getBlockSet() { @@ -38,7 +38,7 @@ public abstract class SynchronizationSegment { /** * Gets the type of segment. - * + * * @return The type of segment. */ public abstract SegmentType getType(); diff --git a/src/org/apollo/game/sync/seg/TeleportSegment.java b/src/org/apollo/game/sync/seg/TeleportSegment.java index f607d2e6..465ab390 100644 --- a/src/org/apollo/game/sync/seg/TeleportSegment.java +++ b/src/org/apollo/game/sync/seg/TeleportSegment.java @@ -5,7 +5,7 @@ import org.apollo.game.sync.block.SynchronizationBlockSet; /** * A {@link SynchronizationSegment} where the mob is teleported to a new location. - * + * * @author Graham */ public final class TeleportSegment extends SynchronizationSegment { @@ -17,7 +17,7 @@ public final class TeleportSegment extends SynchronizationSegment { /** * Creates the teleport segment. - * + * * @param blockSet The block set. * @param destination The destination. */ @@ -28,7 +28,7 @@ public final class TeleportSegment extends SynchronizationSegment { /** * Gets the destination. - * + * * @return The destination. */ public Position getDestination() { diff --git a/src/org/apollo/game/sync/task/NpcSynchronizationTask.java b/src/org/apollo/game/sync/task/NpcSynchronizationTask.java index e8739cc0..fc0179f2 100644 --- a/src/org/apollo/game/sync/task/NpcSynchronizationTask.java +++ b/src/org/apollo/game/sync/task/NpcSynchronizationTask.java @@ -15,7 +15,7 @@ import org.apollo.game.sync.seg.SynchronizationSegment; /** * A {@link SynchronizationTask} which synchronizes npcs with the specified {@link Player}. - * + * * @author Major */ public final class NpcSynchronizationTask extends SynchronizationTask { @@ -33,7 +33,7 @@ public final class NpcSynchronizationTask extends SynchronizationTask { /** * Creates the {@link NpcSynchronizationTask} for the specified player. - * + * * @param player The player. */ public NpcSynchronizationTask(Player player) { @@ -49,8 +49,7 @@ public final class NpcSynchronizationTask extends SynchronizationTask { for (Iterator it = localNpcs.iterator(); it.hasNext();) { Npc npc = it.next(); - if (!npc.isActive() || npc.isTeleporting() - || npc.getPosition().getLongestDelta(playerPosition) > player.getViewingDistance()) { + if (!npc.isActive() || npc.isTeleporting() || npc.getPosition().getLongestDelta(playerPosition) > player.getViewingDistance()) { it.remove(); segments.add(new RemoveMobSegment()); } else { @@ -69,8 +68,7 @@ public final class NpcSynchronizationTask extends SynchronizationTask { } Position npcPosition = npc.getPosition(); - if (npcPosition.isWithinDistance(playerPosition, player.getViewingDistance()) && !localNpcs.contains(npc) - && npcPosition.getHeight() == playerPosition.getHeight()) { + if (npcPosition.isWithinDistance(playerPosition, player.getViewingDistance()) && !localNpcs.contains(npc) && npcPosition.getHeight() == playerPosition.getHeight()) { localNpcs.add(npc); added++; npc.turnTo(npc.getFacingPosition()); diff --git a/src/org/apollo/game/sync/task/PhasedSynchronizationTask.java b/src/org/apollo/game/sync/task/PhasedSynchronizationTask.java index c6b39da0..6b7a4f3b 100644 --- a/src/org/apollo/game/sync/task/PhasedSynchronizationTask.java +++ b/src/org/apollo/game/sync/task/PhasedSynchronizationTask.java @@ -8,7 +8,7 @@ import java.util.concurrent.Phaser; *

    * The phaser must have already registered this task. This can be done using the {@link Phaser#register()} or * {@link Phaser#bulkRegister(int)} methods. - * + * * @author Graham */ public final class PhasedSynchronizationTask extends SynchronizationTask { @@ -25,7 +25,7 @@ public final class PhasedSynchronizationTask extends SynchronizationTask { /** * Creates the phased synchronization task. - * + * * @param phaser The phaser. * @param task The task. */ diff --git a/src/org/apollo/game/sync/task/PlayerSynchronizationTask.java b/src/org/apollo/game/sync/task/PlayerSynchronizationTask.java index aa888bec..550a7654 100644 --- a/src/org/apollo/game/sync/task/PlayerSynchronizationTask.java +++ b/src/org/apollo/game/sync/task/PlayerSynchronizationTask.java @@ -20,7 +20,7 @@ import org.apollo.util.MobRepository; /** * A {@link SynchronizationTask} which synchronizes the specified {@link Player} . - * + * * @author Graham */ public final class PlayerSynchronizationTask extends SynchronizationTask { @@ -38,7 +38,7 @@ public final class PlayerSynchronizationTask extends SynchronizationTask { /** * Creates the {@link PlayerSynchronizationTask} for the specified player. - * + * * @param player The player. */ public PlayerSynchronizationTask(Player player) { @@ -80,8 +80,7 @@ public final class PlayerSynchronizationTask extends SynchronizationTask { int added = 0; MobRepository repository = player.getWorld().getPlayerRepository(); - for (Iterator it = repository.iterator(); it.hasNext();) { - Player other = it.next(); + for (Player other : repository) { if (localPlayers.size() >= 255) { player.flagExcessivePlayers(); break; diff --git a/src/org/apollo/game/sync/task/PostNpcSynchronizationTask.java b/src/org/apollo/game/sync/task/PostNpcSynchronizationTask.java index 172ffba0..311c483a 100644 --- a/src/org/apollo/game/sync/task/PostNpcSynchronizationTask.java +++ b/src/org/apollo/game/sync/task/PostNpcSynchronizationTask.java @@ -4,7 +4,7 @@ import org.apollo.game.model.entity.Npc; /** * A {@link SynchronizationTask} which does post-synchronization work for the specified {@link Npc}. - * + * * @author Major */ public final class PostNpcSynchronizationTask extends SynchronizationTask { @@ -16,7 +16,7 @@ public final class PostNpcSynchronizationTask extends SynchronizationTask { /** * Creates the {@link PostNpcSynchronizationTask} for the specified player. - * + * * @param npc The npc. */ public PostNpcSynchronizationTask(Npc npc) { diff --git a/src/org/apollo/game/sync/task/PostPlayerSynchronizationTask.java b/src/org/apollo/game/sync/task/PostPlayerSynchronizationTask.java index 5864311c..fc95e3f6 100644 --- a/src/org/apollo/game/sync/task/PostPlayerSynchronizationTask.java +++ b/src/org/apollo/game/sync/task/PostPlayerSynchronizationTask.java @@ -4,7 +4,7 @@ import org.apollo.game.model.entity.Player; /** * A {@link SynchronizationTask} which does post-synchronization work for the specified {@link Player}. - * + * * @author Graham */ public final class PostPlayerSynchronizationTask extends SynchronizationTask { @@ -16,7 +16,7 @@ public final class PostPlayerSynchronizationTask extends SynchronizationTask { /** * Creates the {@link PostPlayerSynchronizationTask} for the specified player. - * + * * @param player The player. */ public PostPlayerSynchronizationTask(Player player) { diff --git a/src/org/apollo/game/sync/task/PreNpcSynchronizationTask.java b/src/org/apollo/game/sync/task/PreNpcSynchronizationTask.java index 28870d99..9d5d8bee 100644 --- a/src/org/apollo/game/sync/task/PreNpcSynchronizationTask.java +++ b/src/org/apollo/game/sync/task/PreNpcSynchronizationTask.java @@ -4,7 +4,7 @@ import org.apollo.game.model.entity.Npc; /** * A {@link SynchronizationTask} which does pre-synchronization work for the specified npc. - * + * * @author Major */ public final class PreNpcSynchronizationTask extends SynchronizationTask { @@ -16,7 +16,7 @@ public final class PreNpcSynchronizationTask extends SynchronizationTask { /** * Creates the {@link PreNpcSynchronizationTask} for the specified npc. - * + * * @param npc The npc. */ public PreNpcSynchronizationTask(Npc npc) { diff --git a/src/org/apollo/game/sync/task/PrePlayerSynchronizationTask.java b/src/org/apollo/game/sync/task/PrePlayerSynchronizationTask.java index 3a1a6074..238d7c88 100644 --- a/src/org/apollo/game/sync/task/PrePlayerSynchronizationTask.java +++ b/src/org/apollo/game/sync/task/PrePlayerSynchronizationTask.java @@ -1,6 +1,12 @@ package org.apollo.game.sync.task; -import com.google.common.collect.ImmutableSet; +import java.util.ArrayList; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.Set; + import org.apollo.game.message.impl.ClearRegionMessage; import org.apollo.game.message.impl.GroupedRegionUpdateMessage; import org.apollo.game.message.impl.RegionChangeMessage; @@ -11,11 +17,11 @@ import org.apollo.game.model.area.RegionCoordinates; import org.apollo.game.model.area.RegionRepository; import org.apollo.game.model.entity.Player; -import java.util.*; +import com.google.common.collect.ImmutableSet; /** * A {@link SynchronizationTask} which does pre-synchronization work for the specified {@link Player}. - * + * * @author Graham * @author Major */ @@ -67,7 +73,7 @@ public final class PrePlayerSynchronizationTask extends SynchronizationTask { /** * Creates the {@link PrePlayerSynchronizationTask} for the specified {@link Player}. - * + * * @param player The Player. * @param updates The {@link Map} containing {@link Region} updates. * @param snapshots The Map containing Region snapshots. @@ -110,7 +116,7 @@ public final class PrePlayerSynchronizationTask extends SynchronizationTask { /** * Gets the {@link Set} of {@link RegionCoordinates} of {@link Region}s that the {@link Player} in this task has * only just became able to view. - * + * * @param old The old {@link Position} of the Player. * @param next The new Position of the Player. * @return The Set of RegionCoordinates. Will not be {@code null}, but may be empty. @@ -152,7 +158,7 @@ public final class PrePlayerSynchronizationTask extends SynchronizationTask { /** * Gets the {@link List} of {@link GroupedRegionUpdateMessage}s. - * + * * @param mode The {@link RegionUpdateMode} used when creating the Messages. * @param newRegions The {@link Set} of {@link RegionCoordinates} that should be sent as a full update. */ @@ -192,7 +198,7 @@ public final class PrePlayerSynchronizationTask extends SynchronizationTask { /** * Checks if a region update is required. - * + * * @return {@code true} if a Region update is required, {@code false} if not. */ private boolean isRegionUpdateRequired() { @@ -202,13 +208,13 @@ public final class PrePlayerSynchronizationTask extends SynchronizationTask { int deltaX = current.getLocalX(last); int deltaY = current.getLocalY(last); - return deltaX <= Position.MAX_DISTANCE || deltaX >= (VIEWPORT_WIDTH - Position.MAX_DISTANCE - 1) || deltaY <= Position.MAX_DISTANCE || deltaY >= (VIEWPORT_WIDTH - Position.MAX_DISTANCE - 1); + return deltaX <= Position.MAX_DISTANCE || deltaX >= VIEWPORT_WIDTH - Position.MAX_DISTANCE - 1 || deltaY <= Position.MAX_DISTANCE || deltaY >= VIEWPORT_WIDTH - Position.MAX_DISTANCE - 1; } /** * Creates a {@link GroupedRegionUpdateMessage} using the specified {@link RegionUpdateMode}, returning * {@link Optional#empty()} if no update message is required. - * + * * @param mode The RegionUpdateMode for the Message. * @param lastKnownRegion The last known region {@link Position} of the Player. * @param coordinates The {@link RegionCoordinates} of the {@link Region}. diff --git a/src/org/apollo/game/sync/task/SynchronizationTask.java b/src/org/apollo/game/sync/task/SynchronizationTask.java index 8716a5d6..c09ace38 100644 --- a/src/org/apollo/game/sync/task/SynchronizationTask.java +++ b/src/org/apollo/game/sync/task/SynchronizationTask.java @@ -5,7 +5,7 @@ import org.apollo.game.sync.ClientSynchronizer; /** * Represents some task that must be completed during the client synchronization process (see {@link ClientSynchronizer} * for more information). - * + * * @author Graham */ public abstract class SynchronizationTask implements Runnable { diff --git a/src/org/apollo/io/EquipmentDefinitionParser.java b/src/org/apollo/io/EquipmentDefinitionParser.java index e1f9333f..ca6638a7 100644 --- a/src/org/apollo/io/EquipmentDefinitionParser.java +++ b/src/org/apollo/io/EquipmentDefinitionParser.java @@ -8,7 +8,7 @@ import org.apollo.game.model.def.EquipmentDefinition; /** * A class that parses the {@code data/equipment-[release].dat} file to create an array of {@link EquipmentDefinition}s. - * + * * @author Graham */ public final class EquipmentDefinitionParser { @@ -20,7 +20,7 @@ public final class EquipmentDefinitionParser { /** * Creates the equipment definition parser. - * + * * @param is The input stream. */ public EquipmentDefinitionParser(InputStream is) { @@ -29,7 +29,7 @@ public final class EquipmentDefinitionParser { /** * Parses the input stream. - * + * * @return The equipment definition array. * @throws IOException If an I/O error occurs. */ diff --git a/src/org/apollo/io/MessageHandlerChainSetParser.java b/src/org/apollo/io/MessageHandlerChainSetParser.java index 73cf3c2c..1b308551 100644 --- a/src/org/apollo/io/MessageHandlerChainSetParser.java +++ b/src/org/apollo/io/MessageHandlerChainSetParser.java @@ -14,7 +14,7 @@ import org.xml.sax.SAXException; /** * A class that parses the {@code messages.xml} file to produce {@link MessageHandlerChainSet}s. - * + * * @author Graham */ public final class MessageHandlerChainSetParser { @@ -31,7 +31,7 @@ public final class MessageHandlerChainSetParser { /** * Creates the message chain parser. - * + * * @param is The source {@link InputStream}. * @throws SAXException If a SAX error occurs. */ @@ -41,7 +41,7 @@ public final class MessageHandlerChainSetParser { /** * Parses the XML and produces a group of {@link MessageHandlerChain}s. - * + * * @param world The {@link World} this MessageHandlerChainGroup is for. * @return A {@link MessageHandlerChainSet}. * @throws IOException If an I/O error occurs. diff --git a/src/org/apollo/io/PluginMetaDataParser.java b/src/org/apollo/io/PluginMetaDataParser.java index 45e8ccac..3cc953da 100644 --- a/src/org/apollo/io/PluginMetaDataParser.java +++ b/src/org/apollo/io/PluginMetaDataParser.java @@ -12,7 +12,7 @@ import org.xml.sax.SAXException; /** * A class that parses {@code plugin.xml} files into {@link PluginMetaData} objects. - * + * * @author Graham */ public final class PluginMetaDataParser { @@ -34,7 +34,7 @@ public final class PluginMetaDataParser { /** * Creates the plugin meta data parser. - * + * * @param is The input stream. * @throws SAXException If a SAX error occurs. */ @@ -45,7 +45,7 @@ public final class PluginMetaDataParser { /** * Gets the specified child element, if it exists. - * + * * @param node The root node. * @param name The element name. * @return The node object. @@ -57,7 +57,7 @@ public final class PluginMetaDataParser { /** * Parses the XML and creates a meta data object. - * + * * @param base The base path for this plugin * @return The meta data object. * @throws SAXException If a SAX error occurs. diff --git a/src/org/apollo/io/player/BinaryFileUtils.java b/src/org/apollo/io/player/BinaryFileUtils.java index 00c747a4..67c50b19 100644 --- a/src/org/apollo/io/player/BinaryFileUtils.java +++ b/src/org/apollo/io/player/BinaryFileUtils.java @@ -11,7 +11,7 @@ import org.apollo.util.NameUtil; /** * A utility class with common functionality used by the binary player loader/ savers. - * + * * @author Graham * @author Major */ @@ -37,7 +37,7 @@ public final class BinaryFileUtils { /** * Gets the save {@link File} for the specified player. - * + * * @param username The username of the player. * @return The file. */ diff --git a/src/org/apollo/io/player/BinaryPlayerSerializer.java b/src/org/apollo/io/player/BinaryPlayerSerializer.java index a73cf368..3e373e59 100644 --- a/src/org/apollo/io/player/BinaryPlayerSerializer.java +++ b/src/org/apollo/io/player/BinaryPlayerSerializer.java @@ -45,7 +45,7 @@ import com.lambdaworks.crypto.SCryptUtil; /** * A {@link PlayerSerializer} implementation that uses a binary file to store player data. - * + * * @author Graham * @author Major */ @@ -107,7 +107,7 @@ public final class BinaryPlayerSerializer extends PlayerSerializer { int y = in.readUnsignedShort(); int height = in.readUnsignedByte(); - Gender gender = (in.readUnsignedByte() == Gender.MALE.toInteger()) ? Gender.MALE : Gender.FEMALE; + Gender gender = in.readUnsignedByte() == Gender.MALE.toInteger() ? Gender.MALE : Gender.FEMALE; int[] style = new int[7]; for (int slot = 0; slot < style.length; slot++) { style[slot] = in.readUnsignedByte(); @@ -239,7 +239,7 @@ public final class BinaryPlayerSerializer extends PlayerSerializer { /** * Gets the save {@link File} for the specified player. - * + * * @param username The username of the player. * @return The file. */ @@ -250,7 +250,7 @@ public final class BinaryPlayerSerializer extends PlayerSerializer { /** * Reads the player's {@link Attribute}s. - * + * * @param in The input stream. * @return The {@link Map} of attribute names to attributes. * @throws IOException If there is an error reading from the stream. @@ -289,7 +289,7 @@ public final class BinaryPlayerSerializer extends PlayerSerializer { /** * Reads an inventory from the input stream. - * + * * @param in The input stream. * @param inventory The inventory. * @throws IOException If an I/O error occurs. @@ -315,7 +315,7 @@ public final class BinaryPlayerSerializer extends PlayerSerializer { /** * Writes an inventory to the specified output stream. - * + * * @param out The output stream. * @param inventory The inventory. * @throws IOException If an I/O error occurs. diff --git a/src/org/apollo/io/player/DummyPlayerSerializer.java b/src/org/apollo/io/player/DummyPlayerSerializer.java index 07ec539e..705955e4 100644 --- a/src/org/apollo/io/player/DummyPlayerSerializer.java +++ b/src/org/apollo/io/player/DummyPlayerSerializer.java @@ -9,7 +9,7 @@ import org.apollo.security.PlayerCredentials; /** * A {@link PlayerSerializer} that saves no data and returns an administrator member account, ideal for debugging. - * + * * @author Graham * @author Major */ diff --git a/src/org/apollo/io/player/JdbcPlayerSerializer.java b/src/org/apollo/io/player/JdbcPlayerSerializer.java index a08e149f..3c510bba 100644 --- a/src/org/apollo/io/player/JdbcPlayerSerializer.java +++ b/src/org/apollo/io/player/JdbcPlayerSerializer.java @@ -6,7 +6,7 @@ import org.apollo.security.PlayerCredentials; /** * A {@link PlayerSerializer} that utilises {@code JDBC} to communicate with an SQL database containing player data. - * + * * @author Major */ public final class JdbcPlayerSerializer extends PlayerSerializer { diff --git a/src/org/apollo/io/player/PlayerLoaderResponse.java b/src/org/apollo/io/player/PlayerLoaderResponse.java index 2e5f2811..dfe91645 100644 --- a/src/org/apollo/io/player/PlayerLoaderResponse.java +++ b/src/org/apollo/io/player/PlayerLoaderResponse.java @@ -9,7 +9,7 @@ import com.google.common.base.Preconditions; /** * A response for the {@link PlayerSerializer#loadPlayer} call. - * + * * @author Graham * @author Major */ @@ -27,7 +27,7 @@ public final class PlayerLoaderResponse { /** * Creates a {@link PlayerLoaderResponse} with only a status code. - * + * * @param status The status code. * @throws IllegalArgumentException If the status code is {@link LoginConstants#STATUS_OK} or * {@link LoginConstants#STATUS_RECONNECTION_OK}. @@ -40,7 +40,7 @@ public final class PlayerLoaderResponse { /** * Creates a {@link PlayerLoaderResponse} with a status code and {@link Player}. - * + * * @param status The status code. * @param player The player. * @throws IllegalArgumentException If the status code does not need a player. @@ -54,7 +54,7 @@ public final class PlayerLoaderResponse { /** * Gets the player. - * + * * @return The player, wrapped in an {@link Optional}. */ public Optional getPlayer() { @@ -63,7 +63,7 @@ public final class PlayerLoaderResponse { /** * Gets the status code. - * + * * @return The status code. */ public int getStatus() { diff --git a/src/org/apollo/io/player/PlayerSerializer.java b/src/org/apollo/io/player/PlayerSerializer.java index 11ce058b..86c581eb 100644 --- a/src/org/apollo/io/player/PlayerSerializer.java +++ b/src/org/apollo/io/player/PlayerSerializer.java @@ -8,7 +8,7 @@ import org.apollo.security.PlayerCredentials; /** * An interface which may be implemented by others which are capable of serializing and deserializing players. For * example, implementations might include text-based, binary and SQL serializers. - * + * * @author Graham * @author Major */ @@ -35,7 +35,7 @@ public abstract class PlayerSerializer { /** * Loads a {@link Player}. - * + * * @param credentials The {@link PlayerCredentials}. * @return The {@link PlayerLoaderResponse}. * @throws Exception If an error occurs. @@ -44,7 +44,7 @@ public abstract class PlayerSerializer { /** * Saves a {@link Player}. - * + * * @param player The Player to save. * @throws Exception If an error occurs. */ diff --git a/src/org/apollo/login/LoginService.java b/src/org/apollo/login/LoginService.java index 873e265d..206f43e9 100644 --- a/src/org/apollo/login/LoginService.java +++ b/src/org/apollo/login/LoginService.java @@ -24,7 +24,7 @@ import com.google.common.util.concurrent.ThreadFactoryBuilder; /** * The {@link LoginService} manages {@link LoginRequest}s. - * + * * @author Graham * @author Major */ @@ -42,7 +42,7 @@ public final class LoginService extends Service { /** * Creates the login service. - * + * * @param world The {@link World} to log Players in to. * @throws Exception If an error occurs. */ @@ -53,7 +53,7 @@ public final class LoginService extends Service { /** * Initialises the login service. - * + * * @throws SAXException If there is an error parsing the XML file. * @throws IOException If there is an error accessing the file. * @throws ReflectiveOperationException If the {@link PlayerSerializer} implementation could not be created. @@ -89,7 +89,7 @@ public final class LoginService extends Service { /** * Submits a login request. - * + * * @param session The session submitting this request. * @param request The login request. */ @@ -105,7 +105,7 @@ public final class LoginService extends Service { /** * Submits a save request. - * + * * @param session The session submitting this request. * @param player The player to save. */ diff --git a/src/org/apollo/login/PlayerLoaderWorker.java b/src/org/apollo/login/PlayerLoaderWorker.java index 0553fe77..368dfbf7 100644 --- a/src/org/apollo/login/PlayerLoaderWorker.java +++ b/src/org/apollo/login/PlayerLoaderWorker.java @@ -11,7 +11,7 @@ import org.apollo.net.session.LoginSession; /** * A class which processes a single login request. - * + * * @author Graham */ public final class PlayerLoaderWorker implements Runnable { @@ -38,7 +38,7 @@ public final class PlayerLoaderWorker implements Runnable { /** * Creates a {@link PlayerLoaderWorker} which will do the work for a single player load request. - * + * * @param loader The {@link PlayerSerializer}. * @param session The {@link LoginSession} which initiated the request. * @param request The {@link LoginRequest} object. diff --git a/src/org/apollo/login/PlayerSaverWorker.java b/src/org/apollo/login/PlayerSaverWorker.java index 6ea2495c..43b8fa3b 100644 --- a/src/org/apollo/login/PlayerSaverWorker.java +++ b/src/org/apollo/login/PlayerSaverWorker.java @@ -9,7 +9,7 @@ import org.apollo.net.session.GameSession; /** * A class which processes a single save request. - * + * * @author Graham */ public final class PlayerSaverWorker implements Runnable { @@ -36,7 +36,7 @@ public final class PlayerSaverWorker implements Runnable { /** * Creates the player saver worker. - * + * * @param saver The player saver. * @param session The game session. * @param player The player to save. diff --git a/src/org/apollo/net/ApolloHandler.java b/src/org/apollo/net/ApolloHandler.java index 78b029e6..312f2076 100644 --- a/src/org/apollo/net/ApolloHandler.java +++ b/src/org/apollo/net/ApolloHandler.java @@ -21,7 +21,7 @@ import org.apollo.net.session.UpdateSession; /** * An implementation of {@link ChannelInboundHandlerAdapter} which handles incoming upstream events from Netty. - * + * * @author Graham */ @Sharable @@ -39,7 +39,7 @@ public final class ApolloHandler extends ChannelInboundHandlerAdapter { /** * Creates the Apollo event handler. - * + * * @param context The server context. */ public ApolloHandler(ServerContext context) { diff --git a/src/org/apollo/net/HttpChannelInitializer.java b/src/org/apollo/net/HttpChannelInitializer.java index c64315e0..210da8b2 100644 --- a/src/org/apollo/net/HttpChannelInitializer.java +++ b/src/org/apollo/net/HttpChannelInitializer.java @@ -10,7 +10,7 @@ import io.netty.handler.timeout.IdleStateHandler; /** * A {@link ChannelInitializer} for the HTTP protocol. - * + * * @author Graham */ public final class HttpChannelInitializer extends ChannelInitializer { @@ -27,7 +27,7 @@ public final class HttpChannelInitializer extends ChannelInitializer { @@ -52,7 +52,7 @@ public final class JagGrabChannelInitializer extends ChannelInitializer { @@ -21,7 +21,7 @@ public final class ServiceChannelInitializer extends ChannelInitializer 1}. - * + * * @author Graham */ public enum DataOrder { diff --git a/src/org/apollo/net/codec/game/DataTransformation.java b/src/org/apollo/net/codec/game/DataTransformation.java index 6b62e208..2754a114 100644 --- a/src/org/apollo/net/codec/game/DataTransformation.java +++ b/src/org/apollo/net/codec/game/DataTransformation.java @@ -2,7 +2,7 @@ package org.apollo.net.codec.game; /** * Represents the different ways data values can be transformed. - * + * * @author Graham */ public enum DataTransformation { diff --git a/src/org/apollo/net/codec/game/DataType.java b/src/org/apollo/net/codec/game/DataType.java index 7dbfb7ef..4e15b380 100644 --- a/src/org/apollo/net/codec/game/DataType.java +++ b/src/org/apollo/net/codec/game/DataType.java @@ -2,7 +2,7 @@ package org.apollo.net.codec.game; /** * Represents the different simple data types. - * + * * @author Graham */ public enum DataType { @@ -39,7 +39,7 @@ public enum DataType { /** * Creates a data type. - * + * * @param bytes The number of bytes it occupies. */ private DataType(int bytes) { @@ -48,7 +48,7 @@ public enum DataType { /** * Gets the number of bytes the data type occupies. - * + * * @return The number of bytes. */ public int getBytes() { diff --git a/src/org/apollo/net/codec/game/GameDecoderState.java b/src/org/apollo/net/codec/game/GameDecoderState.java index b69a2ec5..da4fd260 100644 --- a/src/org/apollo/net/codec/game/GameDecoderState.java +++ b/src/org/apollo/net/codec/game/GameDecoderState.java @@ -2,7 +2,7 @@ package org.apollo.net.codec.game; /** * An enumeration with the different states the {@link GamePacketDecoder} can be in. - * + * * @author Graham */ public enum GameDecoderState { diff --git a/src/org/apollo/net/codec/game/GameMessageDecoder.java b/src/org/apollo/net/codec/game/GameMessageDecoder.java index 4726fdf2..25fc1916 100644 --- a/src/org/apollo/net/codec/game/GameMessageDecoder.java +++ b/src/org/apollo/net/codec/game/GameMessageDecoder.java @@ -11,7 +11,7 @@ import org.apollo.net.release.Release; /** * A {@link MessageToMessageDecoder} that decodes {@link GamePacket}s into {@link Message}s. - * + * * @author Graham */ public final class GameMessageDecoder extends MessageToMessageDecoder { @@ -23,7 +23,7 @@ public final class GameMessageDecoder extends MessageToMessageDecoder { @@ -23,7 +23,7 @@ public final class GameMessageEncoder extends MessageToMessageEncoder { /** * Creates the game message encoder with the specified release. - * + * * @param release The release. */ public GameMessageEncoder(Release release) { diff --git a/src/org/apollo/net/codec/game/GamePacket.java b/src/org/apollo/net/codec/game/GamePacket.java index d93a70fc..0f51e9cb 100644 --- a/src/org/apollo/net/codec/game/GamePacket.java +++ b/src/org/apollo/net/codec/game/GamePacket.java @@ -6,7 +6,7 @@ import org.apollo.net.meta.PacketType; /** * Represents a single packet used in the in-game protocol. - * + * * @author Graham */ public final class GamePacket { @@ -33,7 +33,7 @@ public final class GamePacket { /** * Creates the game packet. - * + * * @param opcode The opcode. * @param type The packet type. * @param payload The payload. @@ -47,7 +47,7 @@ public final class GamePacket { /** * Gets the payload length. - * + * * @return The payload length. */ public int getLength() { @@ -56,7 +56,7 @@ public final class GamePacket { /** * Gets the opcode. - * + * * @return The opcode. */ public int getOpcode() { @@ -65,7 +65,7 @@ public final class GamePacket { /** * Gets the payload. - * + * * @return The payload. */ public ByteBuf getPayload() { @@ -74,7 +74,7 @@ public final class GamePacket { /** * Gets the packet type. - * + * * @return The packet type. */ public PacketType getType() { diff --git a/src/org/apollo/net/codec/game/GamePacketBuilder.java b/src/org/apollo/net/codec/game/GamePacketBuilder.java index 740dd10e..50be0d60 100644 --- a/src/org/apollo/net/codec/game/GamePacketBuilder.java +++ b/src/org/apollo/net/codec/game/GamePacketBuilder.java @@ -8,7 +8,7 @@ import org.apollo.net.meta.PacketType; /** * A class which assists in creating a {@link GamePacket}. - * + * * @author Graham */ public final class GamePacketBuilder { @@ -48,7 +48,7 @@ public final class GamePacketBuilder { /** * Creates the {@link GamePacketBuilder} for a {@link PacketType#FIXED} packet with the specified opcode. - * + * * @param opcode The opcode. */ public GamePacketBuilder(int opcode) { @@ -57,7 +57,7 @@ public final class GamePacketBuilder { /** * Creates the {@link GamePacketBuilder} for the specified packet type and opcode. - * + * * @param opcode The opcode. * @param type The packet type. */ @@ -68,7 +68,7 @@ public final class GamePacketBuilder { /** * Checks that this builder is in the bit access mode. - * + * * @throws IllegalStateException If the builder is not in bit access mode. */ private void checkBitAccess() { @@ -79,7 +79,7 @@ public final class GamePacketBuilder { /** * Checks that this builder is in the byte access mode. - * + * * @throws IllegalStateException If the builder is not in byte access mode. */ private void checkByteAccess() { @@ -90,7 +90,7 @@ public final class GamePacketBuilder { /** * Gets the current length of the builder's buffer. - * + * * @return The length of the buffer. */ public int getLength() { @@ -100,7 +100,7 @@ public final class GamePacketBuilder { /** * Puts a standard data type with the specified value, byte order and transformation. - * + * * @param type The data type. * @param order The byte order. * @param transformation The transformation. @@ -172,7 +172,7 @@ public final class GamePacketBuilder { /** * Puts a standard data type with the specified value and byte order. - * + * * @param type The data type. * @param order The byte order. * @param value The value. @@ -183,7 +183,7 @@ public final class GamePacketBuilder { /** * Puts a standard data type with the specified value and transformation. - * + * * @param type The type. * @param transformation The transformation. * @param value The value. @@ -194,7 +194,7 @@ public final class GamePacketBuilder { /** * Puts a standard data type with the specified value. - * + * * @param type The data type. * @param value The value. */ @@ -205,7 +205,7 @@ public final class GamePacketBuilder { /** * Puts a single bit into the buffer. If {@code flag} is {@code true}, the value of the bit is {@code 1}. If * {@code flag} is {@code false}, the value of the bit is {@code 0}. - * + * * @param flag The flag. */ public void putBit(boolean flag) { @@ -214,7 +214,7 @@ public final class GamePacketBuilder { /** * Puts a single bit into the buffer with the value {@code value}. - * + * * @param value The value. */ public void putBit(int value) { @@ -223,7 +223,7 @@ public final class GamePacketBuilder { /** * Puts {@code numBits} into the buffer with the value {@code value}. - * + * * @param numBits The number of bits to put into the buffer. * @param value The value. * @throws IllegalArgumentException If the number of bits is not between 1 and 31 inclusive. @@ -265,7 +265,7 @@ public final class GamePacketBuilder { /** * Puts the specified byte array into the buffer. - * + * * @param bytes The byte array. */ public void putBytes(byte[] bytes) { @@ -274,7 +274,7 @@ public final class GamePacketBuilder { /** * Puts the bytes from the specified buffer into this packet's buffer. - * + * * @param buffer The source {@link ByteBuf}. */ public void putBytes(ByteBuf buffer) { @@ -290,7 +290,7 @@ public final class GamePacketBuilder { /** * Puts the bytes into the buffer with the specified transformation. - * + * * @param transformation The transformation. * @param bytes The byte array. */ @@ -306,7 +306,7 @@ public final class GamePacketBuilder { /** * Puts the specified byte array into the buffer in reverse. - * + * * @param bytes The byte array. */ public void putBytesReverse(byte[] bytes) { @@ -318,7 +318,7 @@ public final class GamePacketBuilder { /** * Puts the bytes from the specified buffer into this packet's buffer, in reverse. - * + * * @param buffer The source {@link ByteBuf}. */ public void putBytesReverse(ByteBuf buffer) { @@ -334,7 +334,7 @@ public final class GamePacketBuilder { /** * Puts the specified byte array into the buffer in reverse with the specified transformation. - * + * * @param transformation The transformation. * @param bytes The byte array. */ @@ -350,7 +350,7 @@ public final class GamePacketBuilder { /** * Puts a raw builder. Both builders (this and parameter) must be in byte access mode. - * + * * @param builder The builder. * @throws IllegalArgumentException If the builder is not raw. */ @@ -365,7 +365,7 @@ public final class GamePacketBuilder { /** * Puts a raw builder in reverse. Both builders (this and parameter) must be in byte access mode. - * + * * @param builder The builder. * @throws IllegalArgumentException If the builder is not raw. */ @@ -380,7 +380,7 @@ public final class GamePacketBuilder { /** * Puts a smart into the buffer. - * + * * @param value The value. */ public void putSmart(int value) { @@ -394,7 +394,7 @@ public final class GamePacketBuilder { /** * Puts a string into the buffer. - * + * * @param str The string. */ public void putString(String str) { @@ -408,7 +408,7 @@ public final class GamePacketBuilder { /** * Switches this builder's mode to the bit access mode. - * + * * @throws IllegalStateException If the builder is already in bit access mode. */ public void switchToBitAccess() { @@ -421,7 +421,7 @@ public final class GamePacketBuilder { /** * Switches this builder's mode to the byte access mode. - * + * * @throws IllegalStateException If the builder is already in byte access mode. */ public void switchToByteAccess() { @@ -434,7 +434,7 @@ public final class GamePacketBuilder { /** * Creates a {@link GamePacket} based on the current contents of this builder. - * + * * @return The {@link GamePacket}. * @throws IllegalStateException If the builder is not in byte access mode, or if the packet is raw. */ diff --git a/src/org/apollo/net/codec/game/GamePacketDecoder.java b/src/org/apollo/net/codec/game/GamePacketDecoder.java index 6991d519..dd80aa2e 100644 --- a/src/org/apollo/net/codec/game/GamePacketDecoder.java +++ b/src/org/apollo/net/codec/game/GamePacketDecoder.java @@ -17,7 +17,7 @@ import com.google.common.base.Preconditions; /** * A {@link StatefulFrameDecoder} that decodes {@link GamePacket}s. - * + * * @author Graham */ public final class GamePacketDecoder extends StatefulFrameDecoder { @@ -49,7 +49,7 @@ public final class GamePacketDecoder extends StatefulFrameDecoder { @@ -25,7 +25,7 @@ public final class GamePacketEncoder extends MessageToMessageEncoder /** * Creates the {@link GamePacketEncoder}. - * + * * @param random The random number generator. */ public GamePacketEncoder(IsaacRandom random) { diff --git a/src/org/apollo/net/codec/game/GamePacketReader.java b/src/org/apollo/net/codec/game/GamePacketReader.java index 810dde21..34dcb04d 100644 --- a/src/org/apollo/net/codec/game/GamePacketReader.java +++ b/src/org/apollo/net/codec/game/GamePacketReader.java @@ -8,7 +8,7 @@ import com.google.common.base.Preconditions; /** * A utility class for reading {@link GamePacket}s. - * + * * @author Graham */ public final class GamePacketReader { @@ -30,7 +30,7 @@ public final class GamePacketReader { /** * Creates the reader. - * + * * @param packet The packet. */ public GamePacketReader(GamePacket packet) { @@ -39,7 +39,7 @@ public final class GamePacketReader { /** * Checks that this reader is in the bit access mode. - * + * * @throws IllegalStateException If the reader is not in bit access mode. */ private void checkBitAccess() { @@ -48,7 +48,7 @@ public final class GamePacketReader { /** * Checks that this reader is in the byte access mode. - * + * * @throws IllegalStateException If the reader is not in byte access mode. */ private void checkByteAccess() { @@ -57,7 +57,7 @@ public final class GamePacketReader { /** * Reads a standard data type from the buffer with the specified order and transformation. - * + * * @param type The data type. * @param order The data order. * @param transformation The data transformation. @@ -131,7 +131,7 @@ public final class GamePacketReader { /** * Gets a bit from the buffer. - * + * * @return The value. * @throws IllegalStateException If the reader is not in bit access mode. */ @@ -141,7 +141,7 @@ public final class GamePacketReader { /** * Gets the specified amount of bits from the buffer. - * + * * @param amount The amount of bits. * @return The value. * @throws IllegalStateException If the reader is not in bit access mode. @@ -170,7 +170,7 @@ public final class GamePacketReader { /** * Gets bytes. - * + * * @param bytes The target byte array. * @throws IllegalStateException If this reader is not in byte access mode. */ @@ -183,7 +183,7 @@ public final class GamePacketReader { /** * Gets bytes with the specified transformation. - * + * * @param transformation The transformation. * @param bytes The target byte array. * @throws IllegalStateException If this reader is not in byte access mode. @@ -200,7 +200,7 @@ public final class GamePacketReader { /** * Gets bytes in reverse. - * + * * @param bytes The target byte array. * @throws IllegalStateException If this reader is not in byte access mode. */ @@ -213,7 +213,7 @@ public final class GamePacketReader { /** * Gets bytes in reverse with the specified transformation. - * + * * @param transformation The transformation. * @param bytes The target byte array. * @throws IllegalStateException If this reader is not in byte access mode. @@ -230,7 +230,7 @@ public final class GamePacketReader { /** * Gets the length of this reader. - * + * * @return The length of this reader. */ public int getLength() { @@ -240,7 +240,7 @@ public final class GamePacketReader { /** * Gets a signed data type from the buffer. - * + * * @param type The data type. * @return The value. * @throws IllegalStateException If this reader is not in byte access mode. @@ -251,7 +251,7 @@ public final class GamePacketReader { /** * Gets a signed data type from the buffer with the specified order. - * + * * @param type The data type. * @param order The byte order. * @return The value. @@ -264,7 +264,7 @@ public final class GamePacketReader { /** * Gets a signed data type from the buffer with the specified order and transformation. - * + * * @param type The data type. * @param order The byte order. * @param transformation The data transformation. @@ -285,7 +285,7 @@ public final class GamePacketReader { /** * Gets a signed data type from the buffer with the specified transformation. - * + * * @param type The data type. * @param transformation The data transformation. * @return The value. @@ -298,7 +298,7 @@ public final class GamePacketReader { /** * Gets a signed smart from the buffer. - * + * * @return The smart. * @throws IllegalStateException If this reader is not in byte access mode. */ @@ -313,7 +313,7 @@ public final class GamePacketReader { /** * Gets a string from the buffer. - * + * * @return The string. * @throws IllegalStateException If this reader is not in byte access mode. */ @@ -324,7 +324,7 @@ public final class GamePacketReader { /** * Gets an unsigned data type from the buffer. - * + * * @param type The data type. * @return The value. * @throws IllegalStateException If this reader is not in byte access mode. @@ -335,7 +335,7 @@ public final class GamePacketReader { /** * Gets an unsigned data type from the buffer with the specified order. - * + * * @param type The data type. * @param order The byte order. * @return The value. @@ -348,7 +348,7 @@ public final class GamePacketReader { /** * Gets an unsigned data type from the buffer with the specified order and transformation. - * + * * @param type The data type. * @param order The byte order. * @param transformation The data transformation. @@ -364,7 +364,7 @@ public final class GamePacketReader { /** * Gets an unsigned data type from the buffer with the specified transformation. - * + * * @param type The data type. * @param transformation The data transformation. * @return The value. @@ -377,7 +377,7 @@ public final class GamePacketReader { /** * Gets an unsigned smart from the buffer. - * + * * @return The smart. * @throws IllegalStateException If this reader is not in byte access mode. */ @@ -392,7 +392,7 @@ public final class GamePacketReader { /** * Switches this builder's mode to the bit access mode. - * + * * @throws IllegalStateException If the builder is already in bit access mode. */ public void switchToBitAccess() { @@ -403,7 +403,7 @@ public final class GamePacketReader { /** * Switches this builder's mode to the byte access mode. - * + * * @throws IllegalStateException If the builder is already in byte access mode. */ public void switchToByteAccess() { diff --git a/src/org/apollo/net/codec/handshake/HandshakeConstants.java b/src/org/apollo/net/codec/handshake/HandshakeConstants.java index e3cdffc4..94861b7b 100644 --- a/src/org/apollo/net/codec/handshake/HandshakeConstants.java +++ b/src/org/apollo/net/codec/handshake/HandshakeConstants.java @@ -2,7 +2,7 @@ package org.apollo.net.codec.handshake; /** * Holds handshake-related constants. - * + * * @author Graham */ public final class HandshakeConstants { diff --git a/src/org/apollo/net/codec/handshake/HandshakeDecoder.java b/src/org/apollo/net/codec/handshake/HandshakeDecoder.java index d60615a4..aa768ae8 100644 --- a/src/org/apollo/net/codec/handshake/HandshakeDecoder.java +++ b/src/org/apollo/net/codec/handshake/HandshakeDecoder.java @@ -15,7 +15,7 @@ import org.apollo.net.codec.update.UpdateEncoder; /** * A {@link ByteToMessageDecoder} which decodes the handshake and makes changes to the pipeline as appropriate for the * selected service. - * + * * @author Graham */ public final class HandshakeDecoder extends ByteToMessageDecoder { diff --git a/src/org/apollo/net/codec/handshake/HandshakeMessage.java b/src/org/apollo/net/codec/handshake/HandshakeMessage.java index bc82a468..c21a5311 100644 --- a/src/org/apollo/net/codec/handshake/HandshakeMessage.java +++ b/src/org/apollo/net/codec/handshake/HandshakeMessage.java @@ -2,7 +2,7 @@ package org.apollo.net.codec.handshake; /** * A handshake message in the service handshake protocol. - * + * * @author Graham */ public final class HandshakeMessage { @@ -14,7 +14,7 @@ public final class HandshakeMessage { /** * Creates the handshake message. - * + * * @param serviceId The service id. */ public HandshakeMessage(int serviceId) { @@ -23,7 +23,7 @@ public final class HandshakeMessage { /** * Gets the service id. - * + * * @return The service id. */ public int getServiceId() { diff --git a/src/org/apollo/net/codec/jaggrab/JagGrabRequest.java b/src/org/apollo/net/codec/jaggrab/JagGrabRequest.java index a3f65d2c..4ef7f0db 100644 --- a/src/org/apollo/net/codec/jaggrab/JagGrabRequest.java +++ b/src/org/apollo/net/codec/jaggrab/JagGrabRequest.java @@ -2,7 +2,7 @@ package org.apollo.net.codec.jaggrab; /** * Represents the request for a single file using the JAGGRAB protocol. - * + * * @author Graham */ public final class JagGrabRequest { @@ -14,7 +14,7 @@ public final class JagGrabRequest { /** * Creates the request. - * + * * @param filePath The file path. */ public JagGrabRequest(String filePath) { @@ -23,7 +23,7 @@ public final class JagGrabRequest { /** * Gets the file path. - * + * * @return The file path. */ public String getFilePath() { diff --git a/src/org/apollo/net/codec/jaggrab/JagGrabRequestDecoder.java b/src/org/apollo/net/codec/jaggrab/JagGrabRequestDecoder.java index 71487974..4d8706c3 100644 --- a/src/org/apollo/net/codec/jaggrab/JagGrabRequestDecoder.java +++ b/src/org/apollo/net/codec/jaggrab/JagGrabRequestDecoder.java @@ -7,7 +7,7 @@ import java.util.List; /** * A {@link MessageToMessageDecoder} for the JAGGRAB protocol. - * + * * @author Graham */ public final class JagGrabRequestDecoder extends MessageToMessageDecoder { diff --git a/src/org/apollo/net/codec/jaggrab/JagGrabResponse.java b/src/org/apollo/net/codec/jaggrab/JagGrabResponse.java index a9e52da6..b82a13bd 100644 --- a/src/org/apollo/net/codec/jaggrab/JagGrabResponse.java +++ b/src/org/apollo/net/codec/jaggrab/JagGrabResponse.java @@ -4,7 +4,7 @@ import io.netty.buffer.ByteBuf; /** * Represents a single JAGGRAB response. - * + * * @author Graham */ public final class JagGrabResponse { @@ -16,7 +16,7 @@ public final class JagGrabResponse { /** * Creates the response. - * + * * @param fileData The file data. */ public JagGrabResponse(ByteBuf fileData) { @@ -25,7 +25,7 @@ public final class JagGrabResponse { /** * Gets the file data. - * + * * @return The file data. */ public ByteBuf getFileData() { diff --git a/src/org/apollo/net/codec/jaggrab/JagGrabResponseEncoder.java b/src/org/apollo/net/codec/jaggrab/JagGrabResponseEncoder.java index 28781e44..d2c67936 100644 --- a/src/org/apollo/net/codec/jaggrab/JagGrabResponseEncoder.java +++ b/src/org/apollo/net/codec/jaggrab/JagGrabResponseEncoder.java @@ -7,7 +7,7 @@ import java.util.List; /** * A {@link MessageToMessageEncoder} for the JAGGRAB protocol. - * + * * @author Graham */ public final class JagGrabResponseEncoder extends MessageToMessageEncoder { diff --git a/src/org/apollo/net/codec/login/LoginConstants.java b/src/org/apollo/net/codec/login/LoginConstants.java index d74604ea..fb345efd 100644 --- a/src/org/apollo/net/codec/login/LoginConstants.java +++ b/src/org/apollo/net/codec/login/LoginConstants.java @@ -2,7 +2,7 @@ package org.apollo.net.codec.login; /** * Holds login-related constants. - * + * * @author Graham */ public final class LoginConstants { diff --git a/src/org/apollo/net/codec/login/LoginDecoder.java b/src/org/apollo/net/codec/login/LoginDecoder.java index 1bb136ce..0ed6f036 100644 --- a/src/org/apollo/net/codec/login/LoginDecoder.java +++ b/src/org/apollo/net/codec/login/LoginDecoder.java @@ -23,7 +23,7 @@ import com.google.common.net.InetAddresses; /** * A {@link StatefulFrameDecoder} which decodes the login request frames. - * + * * @author Graham */ public final class LoginDecoder extends StatefulFrameDecoder { @@ -79,7 +79,7 @@ public final class LoginDecoder extends StatefulFrameDecoder /** * Decodes in the handshake state. - * + * * @param ctx The channel handler context. * @param buffer The buffer. * @param out The {@link List} of objects to pass forward through the pipeline. @@ -101,7 +101,7 @@ public final class LoginDecoder extends StatefulFrameDecoder /** * Decodes in the header state. - * + * * @param ctx The channel handler context. * @param buffer The buffer. * @param out The {@link List} of objects to pass forward through the pipeline. @@ -124,7 +124,7 @@ public final class LoginDecoder extends StatefulFrameDecoder /** * Decodes in the payload state. - * + * * @param ctx The channel handler context. * @param buffer The buffer. * @param out The {@link List} of objects to pass forward through the pipeline. diff --git a/src/org/apollo/net/codec/login/LoginDecoderState.java b/src/org/apollo/net/codec/login/LoginDecoderState.java index ff833557..bdef7345 100644 --- a/src/org/apollo/net/codec/login/LoginDecoderState.java +++ b/src/org/apollo/net/codec/login/LoginDecoderState.java @@ -2,7 +2,7 @@ package org.apollo.net.codec.login; /** * An enumeration with the different states the {@link LoginDecoder} can be in. - * + * * @author Graham */ public enum LoginDecoderState { diff --git a/src/org/apollo/net/codec/login/LoginEncoder.java b/src/org/apollo/net/codec/login/LoginEncoder.java index 53f176ac..7ce64aa5 100644 --- a/src/org/apollo/net/codec/login/LoginEncoder.java +++ b/src/org/apollo/net/codec/login/LoginEncoder.java @@ -8,7 +8,7 @@ import java.util.List; /** * A {@link MessageToMessageEncoder} which encodes login response messages. - * + * * @author Graham */ public final class LoginEncoder extends MessageToMessageEncoder { diff --git a/src/org/apollo/net/codec/login/LoginRequest.java b/src/org/apollo/net/codec/login/LoginRequest.java index c30c620f..e77e5e86 100644 --- a/src/org/apollo/net/codec/login/LoginRequest.java +++ b/src/org/apollo/net/codec/login/LoginRequest.java @@ -5,7 +5,7 @@ import org.apollo.security.PlayerCredentials; /** * Represents a login request. - * + * * @author Graham */ public final class LoginRequest { @@ -47,7 +47,7 @@ public final class LoginRequest { /** * Creates a login request. - * + * * @param credentials The player credentials. * @param randomPair The pair of random number generators. * @param lowMemory The low memory flag. @@ -68,7 +68,7 @@ public final class LoginRequest { /** * Gets the archive CRCs. - * + * * @return The array of archive CRCs. */ public int[] getArchiveCrcs() { @@ -77,7 +77,7 @@ public final class LoginRequest { /** * Gets the value denoting the client's (modified) version. - * + * * @return The client version. */ public int getClientVersion() { @@ -86,7 +86,7 @@ public final class LoginRequest { /** * Gets the player's credentials. - * + * * @return The player's credentials. */ public PlayerCredentials getCredentials() { @@ -95,7 +95,7 @@ public final class LoginRequest { /** * Gets the pair of random number generators. - * + * * @return The pair of random number generators. */ public IsaacRandomPair getRandomPair() { @@ -104,7 +104,7 @@ public final class LoginRequest { /** * Gets the release number. - * + * * @return The release number. */ public int getReleaseNumber() { @@ -113,7 +113,7 @@ public final class LoginRequest { /** * Checks if this client is in low memory mode. - * + * * @return {@code true} if so, {@code false} if not. */ public boolean isLowMemory() { @@ -122,7 +122,7 @@ public final class LoginRequest { /** * Checks if this client is reconnecting. - * + * * @return {@code true} if so, {@code false} if not. */ public boolean isReconnecting() { diff --git a/src/org/apollo/net/codec/login/LoginResponse.java b/src/org/apollo/net/codec/login/LoginResponse.java index 426c78c6..bf1fa5b7 100644 --- a/src/org/apollo/net/codec/login/LoginResponse.java +++ b/src/org/apollo/net/codec/login/LoginResponse.java @@ -2,7 +2,7 @@ package org.apollo.net.codec.login; /** * Represents a login response. - * + * * @author Graham */ public final class LoginResponse { @@ -24,7 +24,7 @@ public final class LoginResponse { /** * Creates the login response. - * + * * @param status The login status. * @param rights The rights level. * @param flagged The flagged flag. @@ -37,7 +37,7 @@ public final class LoginResponse { /** * Gets the rights level. - * + * * @return The rights level. */ public int getRights() { @@ -46,7 +46,7 @@ public final class LoginResponse { /** * Gets the status. - * + * * @return The status. */ public int getStatus() { @@ -55,7 +55,7 @@ public final class LoginResponse { /** * Checks if the player should be flagged. - * + * * @return The flagged flag. */ public boolean isFlagged() { diff --git a/src/org/apollo/net/codec/update/OnDemandRequest.java b/src/org/apollo/net/codec/update/OnDemandRequest.java index d91737a8..a782ae02 100644 --- a/src/org/apollo/net/codec/update/OnDemandRequest.java +++ b/src/org/apollo/net/codec/update/OnDemandRequest.java @@ -4,7 +4,7 @@ import org.apollo.fs.FileDescriptor; /** * Represents a single 'on-demand' request. - * + * * @author Graham */ public final class OnDemandRequest implements Comparable { @@ -32,7 +32,7 @@ public final class OnDemandRequest implements Comparable { /** * Converts the integer value to a Priority. - * + * * @param value The integer value. * @return The priority. * @throws IllegalArgumentException If the value is outside of the range 1-3 inclusive. @@ -57,7 +57,7 @@ public final class OnDemandRequest implements Comparable { /** * Creates the Priority. - * + * * @param value The integer value. */ private Priority(int value) { @@ -68,7 +68,7 @@ public final class OnDemandRequest implements Comparable { * Compares this Priority with the specified other Priority. *

    * Used as an ordinal-independent variant of {@link #compareTo}. - * + * * @param other The other Priority. * @return 1 if this Priority is greater than {@code other}, 0 if they are equal, otherwise -1. */ @@ -78,7 +78,7 @@ public final class OnDemandRequest implements Comparable { /** * Converts the priority to an integer. - * + * * @return The integer value. */ public int toInteger() { @@ -99,7 +99,7 @@ public final class OnDemandRequest implements Comparable { /** * Creates the OnDemandRequest. - * + * * @param descriptor The {@link FileDescriptor}. * @param priority The {@link Priority}. */ @@ -115,7 +115,7 @@ public final class OnDemandRequest implements Comparable { /** * Gets the {@link FileDescriptor}. - * + * * @return The FileDescriptor. */ public FileDescriptor getFileDescriptor() { @@ -124,7 +124,7 @@ public final class OnDemandRequest implements Comparable { /** * Gets the {@link Priority}. - * + * * @return The Priority. */ public Priority getPriority() { diff --git a/src/org/apollo/net/codec/update/OnDemandResponse.java b/src/org/apollo/net/codec/update/OnDemandResponse.java index a4441603..12dda46a 100644 --- a/src/org/apollo/net/codec/update/OnDemandResponse.java +++ b/src/org/apollo/net/codec/update/OnDemandResponse.java @@ -6,7 +6,7 @@ import org.apollo.fs.FileDescriptor; /** * Represents a single 'on-demand' response. - * + * * @author Graham */ public final class OnDemandResponse { @@ -33,7 +33,7 @@ public final class OnDemandResponse { /** * Creates the 'on-demand' response. - * + * * @param fileDescriptor The file descriptor. * @param fileSize The file size. * @param chunkId The chunk id. @@ -48,7 +48,7 @@ public final class OnDemandResponse { /** * Gets the chunk data. - * + * * @return The chunk data. */ public ByteBuf getChunkData() { @@ -57,7 +57,7 @@ public final class OnDemandResponse { /** * Gets the chunk id. - * + * * @return The chunk id. */ public int getChunkId() { @@ -66,7 +66,7 @@ public final class OnDemandResponse { /** * Gets the file descriptor. - * + * * @return The file descriptor. */ public FileDescriptor getFileDescriptor() { @@ -75,7 +75,7 @@ public final class OnDemandResponse { /** * Gets the file size. - * + * * @return The file size. */ public int getFileSize() { diff --git a/src/org/apollo/net/codec/update/UpdateDecoder.java b/src/org/apollo/net/codec/update/UpdateDecoder.java index fd2e97aa..73c521d9 100644 --- a/src/org/apollo/net/codec/update/UpdateDecoder.java +++ b/src/org/apollo/net/codec/update/UpdateDecoder.java @@ -11,7 +11,7 @@ import org.apollo.net.codec.update.OnDemandRequest.Priority; /** * A {@link ByteToMessageDecoder} for the 'on-demand' protocol. - * + * * @author Graham */ public final class UpdateDecoder extends ByteToMessageDecoder { diff --git a/src/org/apollo/net/codec/update/UpdateEncoder.java b/src/org/apollo/net/codec/update/UpdateEncoder.java index c46d8bca..e9de39bd 100644 --- a/src/org/apollo/net/codec/update/UpdateEncoder.java +++ b/src/org/apollo/net/codec/update/UpdateEncoder.java @@ -10,7 +10,7 @@ import org.apollo.fs.FileDescriptor; /** * A {@link MessageToMessageEncoder} for the 'on-demand' protocol. - * + * * @author Graham */ public final class UpdateEncoder extends MessageToMessageEncoder { diff --git a/src/org/apollo/net/meta/PacketMetaData.java b/src/org/apollo/net/meta/PacketMetaData.java index 07af6605..2c22f90a 100644 --- a/src/org/apollo/net/meta/PacketMetaData.java +++ b/src/org/apollo/net/meta/PacketMetaData.java @@ -4,14 +4,14 @@ import com.google.common.base.Preconditions; /** * A class containing meta data for a single type of packet. - * + * * @author Graham */ public final class PacketMetaData { /** * Creates packet meta data for a fixed-length packet. - * + * * @param length The length of the packet. * @return The packet meta data. * @throws IllegalArgumentException If {@code length} is less than 0. @@ -23,7 +23,7 @@ public final class PacketMetaData { /** * Creates a packet meta data object for a variable byte length packet. - * + * * @return The packet meta data object. */ public static PacketMetaData createVariableByte() { @@ -32,7 +32,7 @@ public final class PacketMetaData { /** * Creates a packet meta data object for a variable short length packet. - * + * * @return The packet meta data object. */ public static PacketMetaData createVariableShort() { @@ -52,7 +52,7 @@ public final class PacketMetaData { /** * Creates the packet meta data object. This should not be called directly. Use the {@link #createFixed}, * {@link #createVariableByte}, and {@link #createVariableShort} methods instead! - * + * * @param type The type of packet. * @param length The length of the packet. */ @@ -63,7 +63,7 @@ public final class PacketMetaData { /** * Gets the length of this packet. - * + * * @return The length of this packet. * @throws IllegalStateException If the packet is not a fixed-size packet. */ @@ -74,7 +74,7 @@ public final class PacketMetaData { /** * Gets the type of packet. - * + * * @return The type of packet. */ public PacketType getType() { diff --git a/src/org/apollo/net/meta/PacketMetaDataGroup.java b/src/org/apollo/net/meta/PacketMetaDataGroup.java index 8b2a0da9..f4ad397b 100644 --- a/src/org/apollo/net/meta/PacketMetaDataGroup.java +++ b/src/org/apollo/net/meta/PacketMetaDataGroup.java @@ -4,14 +4,14 @@ import com.google.common.base.Preconditions; /** * A class containing a group of {@link PacketMetaData} objects. - * + * * @author Graham */ public final class PacketMetaDataGroup { /** * Creates a packet meta data group from the packet length array. - * + * * @param lengths The packet lengths. * @return The packet meta data group. * @throws IllegalArgumentException If the array length is not 256, or if there is an element in the array with a @@ -51,7 +51,7 @@ public final class PacketMetaDataGroup { /** * Gets the meta data for the specified packet. - * + * * @param opcode The opcode of the packet. * @return The {@link PacketMetaData}, or {@code null} if the packet does not exist. * @throws IllegalArgumentException If the opcode is less than 0, or greater than 255. diff --git a/src/org/apollo/net/meta/PacketType.java b/src/org/apollo/net/meta/PacketType.java index 67cb9b41..c8521cb1 100644 --- a/src/org/apollo/net/meta/PacketType.java +++ b/src/org/apollo/net/meta/PacketType.java @@ -2,7 +2,7 @@ package org.apollo.net.meta; /** * An enumeration which contains the different types of packets. - * + * * @author Graham */ public enum PacketType { diff --git a/src/org/apollo/net/release/MessageDecoder.java b/src/org/apollo/net/release/MessageDecoder.java index 99f05202..fca8b7a0 100644 --- a/src/org/apollo/net/release/MessageDecoder.java +++ b/src/org/apollo/net/release/MessageDecoder.java @@ -6,7 +6,7 @@ import org.apollo.net.codec.game.GamePacket; /** * A {@link MessageDecoder} decodes a {@link GamePacket} into a {@link Message} object which can be processed by the * server. - * + * * @author Graham * @param The type of message. */ @@ -14,7 +14,7 @@ public abstract class MessageDecoder { /** * Decodes the specified packet into a message. - * + * * @param packet The packet. * @return The message. */ diff --git a/src/org/apollo/net/release/MessageEncoder.java b/src/org/apollo/net/release/MessageEncoder.java index 235861da..236f57ff 100644 --- a/src/org/apollo/net/release/MessageEncoder.java +++ b/src/org/apollo/net/release/MessageEncoder.java @@ -5,7 +5,7 @@ import org.apollo.net.codec.game.GamePacket; /** * A {@link MessageEncoder} encodes {@link Message} objects into {@link GamePacket}s which can be sent over the network. - * + * * @author Graham * @param The type of message. */ @@ -13,7 +13,7 @@ public abstract class MessageEncoder { /** * Encodes the specified message into a packet. - * + * * @param message The message. * @return The packet. */ diff --git a/src/org/apollo/net/release/Release.java b/src/org/apollo/net/release/Release.java index 05063bf1..69551d3f 100644 --- a/src/org/apollo/net/release/Release.java +++ b/src/org/apollo/net/release/Release.java @@ -11,7 +11,7 @@ import com.google.common.base.Preconditions; /** * A {@link Release} is a distinct client version, e.g. {@code 317}. - * + * * @author Graham */ public abstract class Release { @@ -38,7 +38,7 @@ public abstract class Release { /** * Creates the release. - * + * * @param releaseNumber The release number. * @param incomingPacketMetaData The incoming packet meta data. */ @@ -49,7 +49,7 @@ public abstract class Release { /** * Gets meta data for the specified incoming packet. - * + * * @param opcode The opcode of the incoming packet. * @return The {@link PacketMetaData} object. */ @@ -59,7 +59,7 @@ public abstract class Release { /** * Gets the {@link MessageDecoder} for the specified opcode. - * + * * @param opcode The opcode. * @return The message decoder. * @throws IndexOutOfBoundsException If the opcode is less than 0, or greater than 255. @@ -71,7 +71,7 @@ public abstract class Release { /** * Gets the {@link MessageEncoder} for the specified message type. - * + * * @param type The type of message. * @return The message encoder. */ @@ -82,7 +82,7 @@ public abstract class Release { /** * Gets the release number. - * + * * @return The release number. */ public final int getReleaseNumber() { @@ -91,7 +91,7 @@ public abstract class Release { /** * Registers a {@link MessageEncoder} for the specified message type. - * + * * @param type The message type. * @param encoder The message encoder. */ @@ -101,7 +101,7 @@ public abstract class Release { /** * Registers a {@link MessageDecoder} for the specified opcode. - * + * * @param opcode The opcode, between 0 and 255 inclusive. * @param decoder The message decoder. * @throws IndexOutOfBoundsException If the opcode is less than 0, or greater than 255. diff --git a/src/org/apollo/net/release/r317/AddFriendMessageDecoder.java b/src/org/apollo/net/release/r317/AddFriendMessageDecoder.java index 6a47861c..07772cc9 100644 --- a/src/org/apollo/net/release/r317/AddFriendMessageDecoder.java +++ b/src/org/apollo/net/release/r317/AddFriendMessageDecoder.java @@ -9,7 +9,7 @@ import org.apollo.util.NameUtil; /** * A {@link MessageDecoder} for the {@link AddFriendMessage}. - * + * * @author Major */ public final class AddFriendMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/AddGlobalTileItemMessageEncoder.java b/src/org/apollo/net/release/r317/AddGlobalTileItemMessageEncoder.java index 9e083ce1..a81246c4 100644 --- a/src/org/apollo/net/release/r317/AddGlobalTileItemMessageEncoder.java +++ b/src/org/apollo/net/release/r317/AddGlobalTileItemMessageEncoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link SendPublicTileItemMessage}. - * + * * @author Major */ public final class AddGlobalTileItemMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/AddIgnoreMessageDecoder.java b/src/org/apollo/net/release/r317/AddIgnoreMessageDecoder.java index 28439b40..78262d6d 100644 --- a/src/org/apollo/net/release/r317/AddIgnoreMessageDecoder.java +++ b/src/org/apollo/net/release/r317/AddIgnoreMessageDecoder.java @@ -9,7 +9,7 @@ import org.apollo.util.NameUtil; /** * A {@link MessageDecoder} for the {@link AddIgnoreMessage}. - * + * * @author Major */ public final class AddIgnoreMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/AddTileItemMessageEncoder.java b/src/org/apollo/net/release/r317/AddTileItemMessageEncoder.java index 07a775c8..b27a3fd0 100644 --- a/src/org/apollo/net/release/r317/AddTileItemMessageEncoder.java +++ b/src/org/apollo/net/release/r317/AddTileItemMessageEncoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link SendTileItemMessage}. - * + * * @author Major */ public final class AddTileItemMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/ArrowKeyMessageDecoder.java b/src/org/apollo/net/release/r317/ArrowKeyMessageDecoder.java index 5cb603d2..232f647c 100644 --- a/src/org/apollo/net/release/r317/ArrowKeyMessageDecoder.java +++ b/src/org/apollo/net/release/r317/ArrowKeyMessageDecoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link ArrowKeyMessage}. - * + * * @author Major */ public final class ArrowKeyMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/ButtonMessageDecoder.java b/src/org/apollo/net/release/r317/ButtonMessageDecoder.java index 5c8dcea7..0222db9e 100644 --- a/src/org/apollo/net/release/r317/ButtonMessageDecoder.java +++ b/src/org/apollo/net/release/r317/ButtonMessageDecoder.java @@ -8,7 +8,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link ButtonMessage}. - * + * * @author Graham */ public final class ButtonMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/ChatMessageDecoder.java b/src/org/apollo/net/release/r317/ChatMessageDecoder.java index 33e500e5..6cfe51d7 100644 --- a/src/org/apollo/net/release/r317/ChatMessageDecoder.java +++ b/src/org/apollo/net/release/r317/ChatMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.util.TextUtil; /** * A {@link MessageDecoder} for the {@link ChatMessage}. - * + * * @author Graham */ public final class ChatMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/CloseInterfaceMessageEncoder.java b/src/org/apollo/net/release/r317/CloseInterfaceMessageEncoder.java index cfabc5df..b2f3dcac 100644 --- a/src/org/apollo/net/release/r317/CloseInterfaceMessageEncoder.java +++ b/src/org/apollo/net/release/r317/CloseInterfaceMessageEncoder.java @@ -7,7 +7,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link CloseInterfaceMessage}. - * + * * @author Graham */ public final class CloseInterfaceMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/ClosedInterfaceMessageDecoder.java b/src/org/apollo/net/release/r317/ClosedInterfaceMessageDecoder.java index 431fda4e..e9a5604b 100644 --- a/src/org/apollo/net/release/r317/ClosedInterfaceMessageDecoder.java +++ b/src/org/apollo/net/release/r317/ClosedInterfaceMessageDecoder.java @@ -6,7 +6,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link ClosedInterfaceMessage}. - * + * * @author Graham */ public final class ClosedInterfaceMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/CommandMessageDecoder.java b/src/org/apollo/net/release/r317/CommandMessageDecoder.java index d031ecb2..94f8c602 100644 --- a/src/org/apollo/net/release/r317/CommandMessageDecoder.java +++ b/src/org/apollo/net/release/r317/CommandMessageDecoder.java @@ -7,7 +7,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link CommandMessage}. - * + * * @author Graham */ public final class CommandMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/ConfigMessageEncoder.java b/src/org/apollo/net/release/r317/ConfigMessageEncoder.java index 8c9375ea..092bfc8e 100644 --- a/src/org/apollo/net/release/r317/ConfigMessageEncoder.java +++ b/src/org/apollo/net/release/r317/ConfigMessageEncoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link ConfigMessage}. - * + * * @author Chris Fletcher * @author Major */ diff --git a/src/org/apollo/net/release/r317/DialogueContinueMessageDecoder.java b/src/org/apollo/net/release/r317/DialogueContinueMessageDecoder.java index f5d9ee10..50210104 100644 --- a/src/org/apollo/net/release/r317/DialogueContinueMessageDecoder.java +++ b/src/org/apollo/net/release/r317/DialogueContinueMessageDecoder.java @@ -8,7 +8,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link DialogueContinueMessage}. - * + * * @author Chris Fletcher */ public final class DialogueContinueMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/DisplayCrossbonesMessageEncoder.java b/src/org/apollo/net/release/r317/DisplayCrossbonesMessageEncoder.java index f9b5f9b5..aa4d9070 100644 --- a/src/org/apollo/net/release/r317/DisplayCrossbonesMessageEncoder.java +++ b/src/org/apollo/net/release/r317/DisplayCrossbonesMessageEncoder.java @@ -8,7 +8,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link DisplayCrossbonesMessage}. - * + * * @author Major */ public final class DisplayCrossbonesMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/DisplayTabInterfaceMessageEncoder.java b/src/org/apollo/net/release/r317/DisplayTabInterfaceMessageEncoder.java index d6f7789b..c21a5f5f 100644 --- a/src/org/apollo/net/release/r317/DisplayTabInterfaceMessageEncoder.java +++ b/src/org/apollo/net/release/r317/DisplayTabInterfaceMessageEncoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link DisplayTabInterfaceMessage}. - * + * * @author Chris Fletcher */ final class DisplayTabInterfaceMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/EnterAmountMessageEncoder.java b/src/org/apollo/net/release/r317/EnterAmountMessageEncoder.java index 1ef8f8e2..8e32b2c2 100644 --- a/src/org/apollo/net/release/r317/EnterAmountMessageEncoder.java +++ b/src/org/apollo/net/release/r317/EnterAmountMessageEncoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link EnterAmountMessage}. - * + * * @author Graham */ public final class EnterAmountMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/EnteredAmountMessageDecoder.java b/src/org/apollo/net/release/r317/EnteredAmountMessageDecoder.java index 352d345a..e53fe6d8 100644 --- a/src/org/apollo/net/release/r317/EnteredAmountMessageDecoder.java +++ b/src/org/apollo/net/release/r317/EnteredAmountMessageDecoder.java @@ -8,7 +8,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link EnteredAmountMessage}. - * + * * @author Graham */ public final class EnteredAmountMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/FifthItemActionMessageDecoder.java b/src/org/apollo/net/release/r317/FifthItemActionMessageDecoder.java index 4ecb589e..2cc2e6d4 100644 --- a/src/org/apollo/net/release/r317/FifthItemActionMessageDecoder.java +++ b/src/org/apollo/net/release/r317/FifthItemActionMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link FifthItemActionMessage}. - * + * * @author Graham */ public final class FifthItemActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/FifthItemOptionMessageDecoder.java b/src/org/apollo/net/release/r317/FifthItemOptionMessageDecoder.java index b435561f..30876b12 100644 --- a/src/org/apollo/net/release/r317/FifthItemOptionMessageDecoder.java +++ b/src/org/apollo/net/release/r317/FifthItemOptionMessageDecoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link FifthItemOptionMessage}. - * + * * @author Chris Fletcher */ final class FifthItemOptionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/FifthPlayerActionMessageDecoder.java b/src/org/apollo/net/release/r317/FifthPlayerActionMessageDecoder.java index 74e29752..2510ef1d 100644 --- a/src/org/apollo/net/release/r317/FifthPlayerActionMessageDecoder.java +++ b/src/org/apollo/net/release/r317/FifthPlayerActionMessageDecoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link FifthPlayerActionMessage}. - * + * * @author Major */ public final class FifthPlayerActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/FirstItemActionMessageDecoder.java b/src/org/apollo/net/release/r317/FirstItemActionMessageDecoder.java index 6505fefa..808713b4 100644 --- a/src/org/apollo/net/release/r317/FirstItemActionMessageDecoder.java +++ b/src/org/apollo/net/release/r317/FirstItemActionMessageDecoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link FirstItemActionMessage}. - * + * * @author Graham */ public final class FirstItemActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/FirstItemOptionMessageDecoder.java b/src/org/apollo/net/release/r317/FirstItemOptionMessageDecoder.java index a2fd8545..9704607b 100644 --- a/src/org/apollo/net/release/r317/FirstItemOptionMessageDecoder.java +++ b/src/org/apollo/net/release/r317/FirstItemOptionMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link FirstItemOptionMessage}. - * + * * @author Graham */ final class FirstItemOptionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/FirstNpcActionMessageDecoder.java b/src/org/apollo/net/release/r317/FirstNpcActionMessageDecoder.java index fbe8fb45..fb292e6a 100644 --- a/src/org/apollo/net/release/r317/FirstNpcActionMessageDecoder.java +++ b/src/org/apollo/net/release/r317/FirstNpcActionMessageDecoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link FirstNpcActionMessage}. - * + * * @author Major */ public final class FirstNpcActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/FirstObjectActionMessageDecoder.java b/src/org/apollo/net/release/r317/FirstObjectActionMessageDecoder.java index 51185cec..8df3369e 100644 --- a/src/org/apollo/net/release/r317/FirstObjectActionMessageDecoder.java +++ b/src/org/apollo/net/release/r317/FirstObjectActionMessageDecoder.java @@ -11,7 +11,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link FirstObjectActionMessage}. - * + * * @author Graham */ public final class FirstObjectActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/FirstPlayerActionMessageDecoder.java b/src/org/apollo/net/release/r317/FirstPlayerActionMessageDecoder.java index c05eeb94..fb64bd00 100644 --- a/src/org/apollo/net/release/r317/FirstPlayerActionMessageDecoder.java +++ b/src/org/apollo/net/release/r317/FirstPlayerActionMessageDecoder.java @@ -8,7 +8,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link FirstPlayerActionMessage}. - * + * * @author Major */ public final class FirstPlayerActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/FlaggedMouseEventMessageDecoder.java b/src/org/apollo/net/release/r317/FlaggedMouseEventMessageDecoder.java index 4279ca05..a43a5f9d 100644 --- a/src/org/apollo/net/release/r317/FlaggedMouseEventMessageDecoder.java +++ b/src/org/apollo/net/release/r317/FlaggedMouseEventMessageDecoder.java @@ -8,7 +8,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link org.apollo.game.message.impl.FlaggedMouseEventMessage}. - * + * * @author Major */ public final class FlaggedMouseEventMessageDecoder extends MessageDecoder { @@ -19,8 +19,8 @@ public final class FlaggedMouseEventMessageDecoder extends MessageDecoder> 12); - int dX = (read >> 6) & 0x3f; + int clicks = read >> 12; + int dX = read >> 6 & 0x3f; int dY = read & 0x3f; return new FlaggedMouseEventMessage(clicks, dX, dY, true); } else if (reader.getLength() == 3) { @@ -29,7 +29,7 @@ public final class FlaggedMouseEventMessageDecoder extends MessageDecoder> 19); + int clicks = read >> 19; int x = (read & 0x7f) % 765; int y = (read & 0x7f) / 765; diff --git a/src/org/apollo/net/release/r317/FocusUpdateMessageDecoder.java b/src/org/apollo/net/release/r317/FocusUpdateMessageDecoder.java index dd0e89ad..00a9913d 100644 --- a/src/org/apollo/net/release/r317/FocusUpdateMessageDecoder.java +++ b/src/org/apollo/net/release/r317/FocusUpdateMessageDecoder.java @@ -8,7 +8,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link FocusUpdateMessage}. - * + * * @author Major */ public final class FocusUpdateMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/ForwardPrivateChatMessageEncoder.java b/src/org/apollo/net/release/r317/ForwardPrivateChatMessageEncoder.java index d53649e0..3f43ec3c 100644 --- a/src/org/apollo/net/release/r317/ForwardPrivateChatMessageEncoder.java +++ b/src/org/apollo/net/release/r317/ForwardPrivateChatMessageEncoder.java @@ -12,7 +12,7 @@ import org.apollo.util.NameUtil; /** * A {@link MessageEncoder} for the {@link ForwardPrivateChatMessage}. - * + * * @author Major */ public final class ForwardPrivateChatMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/FourthItemActionMessageDecoder.java b/src/org/apollo/net/release/r317/FourthItemActionMessageDecoder.java index b7fbd650..f5311a87 100644 --- a/src/org/apollo/net/release/r317/FourthItemActionMessageDecoder.java +++ b/src/org/apollo/net/release/r317/FourthItemActionMessageDecoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link FourthItemActionMessage}. - * + * * @author Graham */ public final class FourthItemActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/FourthItemOptionMessageDecoder.java b/src/org/apollo/net/release/r317/FourthItemOptionMessageDecoder.java index 555ced90..2ebbe763 100644 --- a/src/org/apollo/net/release/r317/FourthItemOptionMessageDecoder.java +++ b/src/org/apollo/net/release/r317/FourthItemOptionMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link FourthItemOptionMessage}. - * + * * @author Chris Fletcher */ final class FourthItemOptionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/FourthPlayerActionMessageDecoder.java b/src/org/apollo/net/release/r317/FourthPlayerActionMessageDecoder.java index 2ebe856b..0530429a 100644 --- a/src/org/apollo/net/release/r317/FourthPlayerActionMessageDecoder.java +++ b/src/org/apollo/net/release/r317/FourthPlayerActionMessageDecoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link FourthPlayerActionMessage}. - * + * * @author Major */ public final class FourthPlayerActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/FriendServerStatusMessageEncoder.java b/src/org/apollo/net/release/r317/FriendServerStatusMessageEncoder.java index 7fce26fa..d69a6f04 100644 --- a/src/org/apollo/net/release/r317/FriendServerStatusMessageEncoder.java +++ b/src/org/apollo/net/release/r317/FriendServerStatusMessageEncoder.java @@ -8,7 +8,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link FriendServerStatusMessage}. - * + * * @author Major */ public final class FriendServerStatusMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/GroupedRegionUpdateMessageEncoder.java b/src/org/apollo/net/release/r317/GroupedRegionUpdateMessageEncoder.java index bfdbc008..26a762fd 100644 --- a/src/org/apollo/net/release/r317/GroupedRegionUpdateMessageEncoder.java +++ b/src/org/apollo/net/release/r317/GroupedRegionUpdateMessageEncoder.java @@ -39,7 +39,7 @@ public final class GroupedRegionUpdateMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/IgnoreListMessageEncoder.java b/src/org/apollo/net/release/r317/IgnoreListMessageEncoder.java index 6793bbf4..e8de8058 100644 --- a/src/org/apollo/net/release/r317/IgnoreListMessageEncoder.java +++ b/src/org/apollo/net/release/r317/IgnoreListMessageEncoder.java @@ -12,7 +12,7 @@ import org.apollo.util.NameUtil; /** * A {@link MessageEncoder} for the {@link IgnoreListMessage}. - * + * * @author Major */ public final class IgnoreListMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/ItemOnItemMessageDecoder.java b/src/org/apollo/net/release/r317/ItemOnItemMessageDecoder.java index 7a1f8a77..2825b64c 100644 --- a/src/org/apollo/net/release/r317/ItemOnItemMessageDecoder.java +++ b/src/org/apollo/net/release/r317/ItemOnItemMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link ItemOnItemMessageDecoder}. - * + * * @author Chris Fletcher */ final class ItemOnItemMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/ItemOnObjectMessageDecoder.java b/src/org/apollo/net/release/r317/ItemOnObjectMessageDecoder.java index 282251be..e487bc0d 100644 --- a/src/org/apollo/net/release/r317/ItemOnObjectMessageDecoder.java +++ b/src/org/apollo/net/release/r317/ItemOnObjectMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link ItemOnObjectMessage}. - * + * * @author Major */ public final class ItemOnObjectMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/KeepAliveMessageDecoder.java b/src/org/apollo/net/release/r317/KeepAliveMessageDecoder.java index 4fb689bd..7511e575 100644 --- a/src/org/apollo/net/release/r317/KeepAliveMessageDecoder.java +++ b/src/org/apollo/net/release/r317/KeepAliveMessageDecoder.java @@ -6,7 +6,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link KeepAliveMessage}. - * + * * @author Graham */ public final class KeepAliveMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/LogoutMessageEncoder.java b/src/org/apollo/net/release/r317/LogoutMessageEncoder.java index 2175b016..49056ffb 100644 --- a/src/org/apollo/net/release/r317/LogoutMessageEncoder.java +++ b/src/org/apollo/net/release/r317/LogoutMessageEncoder.java @@ -7,7 +7,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link LogoutMessage}. - * + * * @author Graham */ public final class LogoutMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/MagicOnItemMessageDecoder.java b/src/org/apollo/net/release/r317/MagicOnItemMessageDecoder.java index 9631294d..34deb977 100644 --- a/src/org/apollo/net/release/r317/MagicOnItemMessageDecoder.java +++ b/src/org/apollo/net/release/r317/MagicOnItemMessageDecoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link MagicOnItemMessage}. - * + * * @author Chris Fletcher */ final class MagicOnItemMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/MobAnimationResetMessageEncoder.java b/src/org/apollo/net/release/r317/MobAnimationResetMessageEncoder.java index dd6dc4ad..f0e73054 100644 --- a/src/org/apollo/net/release/r317/MobAnimationResetMessageEncoder.java +++ b/src/org/apollo/net/release/r317/MobAnimationResetMessageEncoder.java @@ -7,7 +7,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link MobAnimationResetMessage}. - * + * * @author Major */ public final class MobAnimationResetMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/MouseClickedMessageDecoder.java b/src/org/apollo/net/release/r317/MouseClickedMessageDecoder.java index 96de8f9e..7793d072 100644 --- a/src/org/apollo/net/release/r317/MouseClickedMessageDecoder.java +++ b/src/org/apollo/net/release/r317/MouseClickedMessageDecoder.java @@ -19,9 +19,9 @@ public final class MouseClickedMessageDecoder extends MessageDecoder> 20) * 50; - boolean right = ((value >> 19) & 0x1) == 1; + boolean right = (value >> 19 & 0x1) == 1; - int cords = (value & 0x3FFFF); + int cords = value & 0x3FFFF; int x = cords % 765; int y = cords / 765; diff --git a/src/org/apollo/net/release/r317/NpcSynchronizationMessageEncoder.java b/src/org/apollo/net/release/r317/NpcSynchronizationMessageEncoder.java index a8acc59d..2e6d6efa 100644 --- a/src/org/apollo/net/release/r317/NpcSynchronizationMessageEncoder.java +++ b/src/org/apollo/net/release/r317/NpcSynchronizationMessageEncoder.java @@ -28,7 +28,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link NpcSynchronizationMessage}. - * + * * @author Major */ public final class NpcSynchronizationMessageEncoder extends MessageEncoder { @@ -67,7 +67,7 @@ public final class NpcSynchronizationMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/OpenDialogueOverlayMessageEncoder.java b/src/org/apollo/net/release/r317/OpenDialogueOverlayMessageEncoder.java index a53afa78..5a292433 100644 --- a/src/org/apollo/net/release/r317/OpenDialogueOverlayMessageEncoder.java +++ b/src/org/apollo/net/release/r317/OpenDialogueOverlayMessageEncoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link OpenDialogueOverlayMessage}. - * + * * @author Major */ public final class OpenDialogueOverlayMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/OpenInterfaceMessageEncoder.java b/src/org/apollo/net/release/r317/OpenInterfaceMessageEncoder.java index e0c29dcb..f44456e8 100644 --- a/src/org/apollo/net/release/r317/OpenInterfaceMessageEncoder.java +++ b/src/org/apollo/net/release/r317/OpenInterfaceMessageEncoder.java @@ -8,7 +8,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link OpenInterfaceMessage}. - * + * * @author Graham */ public final class OpenInterfaceMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/OpenInterfaceSidebarMessageEncoder.java b/src/org/apollo/net/release/r317/OpenInterfaceSidebarMessageEncoder.java index a13edd65..f0abe4a8 100644 --- a/src/org/apollo/net/release/r317/OpenInterfaceSidebarMessageEncoder.java +++ b/src/org/apollo/net/release/r317/OpenInterfaceSidebarMessageEncoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link OpenInterfaceSidebarMessage}. - * + * * @author Graham */ public final class OpenInterfaceSidebarMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/PlayerDesignMessageDecoder.java b/src/org/apollo/net/release/r317/PlayerDesignMessageDecoder.java index 52d684ef..71f81106 100644 --- a/src/org/apollo/net/release/r317/PlayerDesignMessageDecoder.java +++ b/src/org/apollo/net/release/r317/PlayerDesignMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link PlayerDesignMessage}. - * + * * @author Graham */ public final class PlayerDesignMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/PlayerSynchronizationMessageEncoder.java b/src/org/apollo/net/release/r317/PlayerSynchronizationMessageEncoder.java index 9b9eeca0..4e9cf4d1 100644 --- a/src/org/apollo/net/release/r317/PlayerSynchronizationMessageEncoder.java +++ b/src/org/apollo/net/release/r317/PlayerSynchronizationMessageEncoder.java @@ -37,7 +37,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link PlayerSynchronizationMessage}. - * + * * @author Graham * @author Major */ @@ -81,7 +81,7 @@ public final class PlayerSynchronizationMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/PrivacyOptionMessageEncoder.java b/src/org/apollo/net/release/r317/PrivacyOptionMessageEncoder.java index 32c4324f..8575e42e 100644 --- a/src/org/apollo/net/release/r317/PrivacyOptionMessageEncoder.java +++ b/src/org/apollo/net/release/r317/PrivacyOptionMessageEncoder.java @@ -8,7 +8,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link PrivacyOptionMessage}. - * + * * @author Kyle Stevenson */ public final class PrivacyOptionMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/PrivateChatMessageDecoder.java b/src/org/apollo/net/release/r317/PrivateChatMessageDecoder.java index a1c18fc4..ebb069ca 100644 --- a/src/org/apollo/net/release/r317/PrivateChatMessageDecoder.java +++ b/src/org/apollo/net/release/r317/PrivateChatMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.util.TextUtil; /** * A {@link MessageDecoder} for the {@link PrivateChatMessage}. - * + * * @author Major */ public final class PrivateChatMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/RegionChangeMessageEncoder.java b/src/org/apollo/net/release/r317/RegionChangeMessageEncoder.java index ee56f722..6ddd4929 100644 --- a/src/org/apollo/net/release/r317/RegionChangeMessageEncoder.java +++ b/src/org/apollo/net/release/r317/RegionChangeMessageEncoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link RegionChangeMessage}. - * + * * @author Graham */ public final class RegionChangeMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/Release317.java b/src/org/apollo/net/release/r317/Release317.java index edeed4f9..e91cd84f 100644 --- a/src/org/apollo/net/release/r317/Release317.java +++ b/src/org/apollo/net/release/r317/Release317.java @@ -51,7 +51,7 @@ import org.apollo.net.release.Release; /** * A {@link Release} implementation for the 317 protocol. - * + * * @author Graham */ public final class Release317 extends Release { diff --git a/src/org/apollo/net/release/r317/RemoveFriendMessageDecoder.java b/src/org/apollo/net/release/r317/RemoveFriendMessageDecoder.java index 59aa41c8..330e2a2b 100644 --- a/src/org/apollo/net/release/r317/RemoveFriendMessageDecoder.java +++ b/src/org/apollo/net/release/r317/RemoveFriendMessageDecoder.java @@ -9,7 +9,7 @@ import org.apollo.util.NameUtil; /** * A {@link MessageDecoder} for the {@link RemoveFriendMessage}. - * + * * @author Major */ public final class RemoveFriendMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/RemoveIgnoreMessageDecoder.java b/src/org/apollo/net/release/r317/RemoveIgnoreMessageDecoder.java index 2ec28020..b88e9157 100644 --- a/src/org/apollo/net/release/r317/RemoveIgnoreMessageDecoder.java +++ b/src/org/apollo/net/release/r317/RemoveIgnoreMessageDecoder.java @@ -9,7 +9,7 @@ import org.apollo.util.NameUtil; /** * A {@link MessageDecoder} for the {@link RemoveIgnoreMessage}. - * + * * @author Major */ public final class RemoveIgnoreMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/RemoveObjectMessageEncoder.java b/src/org/apollo/net/release/r317/RemoveObjectMessageEncoder.java index fe09f3a2..5dad6d73 100644 --- a/src/org/apollo/net/release/r317/RemoveObjectMessageEncoder.java +++ b/src/org/apollo/net/release/r317/RemoveObjectMessageEncoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link RemoveObjectMessage}. - * + * * @author Major */ public final class RemoveObjectMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/RemoveTileItemMessageEncoder.java b/src/org/apollo/net/release/r317/RemoveTileItemMessageEncoder.java index 23fa0e02..0fcb803c 100644 --- a/src/org/apollo/net/release/r317/RemoveTileItemMessageEncoder.java +++ b/src/org/apollo/net/release/r317/RemoveTileItemMessageEncoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link RemoveTileItemMessage}. - * + * * @author Major */ public final class RemoveTileItemMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/SecondItemActionMessageDecoder.java b/src/org/apollo/net/release/r317/SecondItemActionMessageDecoder.java index 544c8459..3380cbf5 100644 --- a/src/org/apollo/net/release/r317/SecondItemActionMessageDecoder.java +++ b/src/org/apollo/net/release/r317/SecondItemActionMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link SecondItemActionMessage}. - * + * * @author Graham */ public final class SecondItemActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/SecondItemOptionMessageDecoder.java b/src/org/apollo/net/release/r317/SecondItemOptionMessageDecoder.java index 29230a36..77d7b07e 100644 --- a/src/org/apollo/net/release/r317/SecondItemOptionMessageDecoder.java +++ b/src/org/apollo/net/release/r317/SecondItemOptionMessageDecoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link SecondItemOptionMessage}. - * + * * @author Graham */ final class SecondItemOptionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/SecondNpcActionMessageDecoder.java b/src/org/apollo/net/release/r317/SecondNpcActionMessageDecoder.java index 7b25cd13..62a01e33 100644 --- a/src/org/apollo/net/release/r317/SecondNpcActionMessageDecoder.java +++ b/src/org/apollo/net/release/r317/SecondNpcActionMessageDecoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link SecondNpcActionMessage}. - * + * * @author Major */ public final class SecondNpcActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/SecondObjectActionMessageDecoder.java b/src/org/apollo/net/release/r317/SecondObjectActionMessageDecoder.java index 0e5cfb61..ec4d089b 100644 --- a/src/org/apollo/net/release/r317/SecondObjectActionMessageDecoder.java +++ b/src/org/apollo/net/release/r317/SecondObjectActionMessageDecoder.java @@ -11,7 +11,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link SecondObjectActionMessage}. - * + * * @author Graham */ public final class SecondObjectActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/SecondPlayerActionMessageDecoder.java b/src/org/apollo/net/release/r317/SecondPlayerActionMessageDecoder.java index 3c9981a7..503a5edb 100644 --- a/src/org/apollo/net/release/r317/SecondPlayerActionMessageDecoder.java +++ b/src/org/apollo/net/release/r317/SecondPlayerActionMessageDecoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link SecondPlayerActionMessage}. - * + * * @author Major */ public final class SecondPlayerActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/SendFriendMessageEncoder.java b/src/org/apollo/net/release/r317/SendFriendMessageEncoder.java index 8aa06fab..d40b80b2 100644 --- a/src/org/apollo/net/release/r317/SendFriendMessageEncoder.java +++ b/src/org/apollo/net/release/r317/SendFriendMessageEncoder.java @@ -9,7 +9,7 @@ import org.apollo.util.NameUtil; /** * A {@link MessageEncoder} for the {@link SendFriendMessage}. - * + * * @author Major */ public final class SendFriendMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/SendObjectMessageEncoder.java b/src/org/apollo/net/release/r317/SendObjectMessageEncoder.java index 4a815aee..edf1acec 100644 --- a/src/org/apollo/net/release/r317/SendObjectMessageEncoder.java +++ b/src/org/apollo/net/release/r317/SendObjectMessageEncoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link SendObjectMessage}. - * + * * @author Major */ public final class SendObjectMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/ServerMessageMessageEncoder.java b/src/org/apollo/net/release/r317/ServerMessageMessageEncoder.java index dfaf714b..c89bf32b 100644 --- a/src/org/apollo/net/release/r317/ServerMessageMessageEncoder.java +++ b/src/org/apollo/net/release/r317/ServerMessageMessageEncoder.java @@ -8,7 +8,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link ServerChatMessage}. - * + * * @author Graham */ public final class ServerMessageMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/SetPlayerActionMessageEncoder.java b/src/org/apollo/net/release/r317/SetPlayerActionMessageEncoder.java index eb596b88..39828080 100644 --- a/src/org/apollo/net/release/r317/SetPlayerActionMessageEncoder.java +++ b/src/org/apollo/net/release/r317/SetPlayerActionMessageEncoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageEncoder; /** * The {@link MessageEncoder} for the {@link SetPlayerActionMessage}. - * + * * @author Major */ public final class SetPlayerActionMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/SetUpdatedRegionMessageEncoder.java b/src/org/apollo/net/release/r317/SetUpdatedRegionMessageEncoder.java index d6391fee..0d5ed583 100644 --- a/src/org/apollo/net/release/r317/SetUpdatedRegionMessageEncoder.java +++ b/src/org/apollo/net/release/r317/SetUpdatedRegionMessageEncoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link SetUpdatedRegionMessage}. - * + * * @author Chris Fletcher */ final class SetUpdatedRegionMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/SetWidgetItemModelMessageEncoder.java b/src/org/apollo/net/release/r317/SetWidgetItemModelMessageEncoder.java index e5570120..f92170df 100644 --- a/src/org/apollo/net/release/r317/SetWidgetItemModelMessageEncoder.java +++ b/src/org/apollo/net/release/r317/SetWidgetItemModelMessageEncoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link SetWidgetItemModelMessage}. - * + * * @author Chris Fletcher */ final class SetWidgetItemModelMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/SetWidgetModelAnimationMessageEncoder.java b/src/org/apollo/net/release/r317/SetWidgetModelAnimationMessageEncoder.java index ff197a23..8d37b87f 100644 --- a/src/org/apollo/net/release/r317/SetWidgetModelAnimationMessageEncoder.java +++ b/src/org/apollo/net/release/r317/SetWidgetModelAnimationMessageEncoder.java @@ -8,7 +8,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link SetWidgetModelAnimationMessage}. - * + * * @author Chris Fletcher */ final class SetWidgetModelAnimationMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/SetWidgetNpcModelMessageEncoder.java b/src/org/apollo/net/release/r317/SetWidgetNpcModelMessageEncoder.java index c4853441..eb0ae82e 100644 --- a/src/org/apollo/net/release/r317/SetWidgetNpcModelMessageEncoder.java +++ b/src/org/apollo/net/release/r317/SetWidgetNpcModelMessageEncoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link SetWidgetNpcModelMessage}. - * + * * @author Chris Fletcher */ final class SetWidgetNpcModelMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/SetWidgetPlayerModelMessageEncoder.java b/src/org/apollo/net/release/r317/SetWidgetPlayerModelMessageEncoder.java index 9c9e1f94..159c2f89 100644 --- a/src/org/apollo/net/release/r317/SetWidgetPlayerModelMessageEncoder.java +++ b/src/org/apollo/net/release/r317/SetWidgetPlayerModelMessageEncoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link SetWidgetPlayerModelMessage}. - * + * * @author Chris Fletcher */ final class SetWidgetPlayerModelMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/SetWidgetTextMessageEncoder.java b/src/org/apollo/net/release/r317/SetWidgetTextMessageEncoder.java index ae68eb78..9d500f12 100644 --- a/src/org/apollo/net/release/r317/SetWidgetTextMessageEncoder.java +++ b/src/org/apollo/net/release/r317/SetWidgetTextMessageEncoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link SetWidgetTextMessage}. - * + * * @author The Wanderer */ public final class SetWidgetTextMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/SetWidgetVisibilityMessageEncoder.java b/src/org/apollo/net/release/r317/SetWidgetVisibilityMessageEncoder.java index 9ff63892..94e0c179 100644 --- a/src/org/apollo/net/release/r317/SetWidgetVisibilityMessageEncoder.java +++ b/src/org/apollo/net/release/r317/SetWidgetVisibilityMessageEncoder.java @@ -8,7 +8,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link SetWidgetVisibilityMessage}. - * + * * @author Major */ final class SetWidgetVisibilityMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/SpamPacketMessageDecoder.java b/src/org/apollo/net/release/r317/SpamPacketMessageDecoder.java index 655c5c4e..ddafc32a 100644 --- a/src/org/apollo/net/release/r317/SpamPacketMessageDecoder.java +++ b/src/org/apollo/net/release/r317/SpamPacketMessageDecoder.java @@ -6,7 +6,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link SpamPacketMessage}. - * + * * @author Major */ public final class SpamPacketMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/SwitchItemMessageDecoder.java b/src/org/apollo/net/release/r317/SwitchItemMessageDecoder.java index 694929a9..6b6de48d 100644 --- a/src/org/apollo/net/release/r317/SwitchItemMessageDecoder.java +++ b/src/org/apollo/net/release/r317/SwitchItemMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link SwitchItemMessage}. - * + * * @author Graham */ public final class SwitchItemMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/SwitchTabInterfaceMessageEncoder.java b/src/org/apollo/net/release/r317/SwitchTabInterfaceMessageEncoder.java index e8e90bbb..e14dbf87 100644 --- a/src/org/apollo/net/release/r317/SwitchTabInterfaceMessageEncoder.java +++ b/src/org/apollo/net/release/r317/SwitchTabInterfaceMessageEncoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link SwitchTabInterfaceMessage}. - * + * * @author Graham */ public final class SwitchTabInterfaceMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/TakeTileItemMessageDecoder.java b/src/org/apollo/net/release/r317/TakeTileItemMessageDecoder.java index 6a07b101..d2aa2f80 100644 --- a/src/org/apollo/net/release/r317/TakeTileItemMessageDecoder.java +++ b/src/org/apollo/net/release/r317/TakeTileItemMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link TakeTileItemMessage}. - * + * * @author Major */ public final class TakeTileItemMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/ThirdItemActionMessageDecoder.java b/src/org/apollo/net/release/r317/ThirdItemActionMessageDecoder.java index 2cf6bf5a..8ff784d2 100644 --- a/src/org/apollo/net/release/r317/ThirdItemActionMessageDecoder.java +++ b/src/org/apollo/net/release/r317/ThirdItemActionMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link ThirdItemActionMessage}. - * + * * @author Graham */ public final class ThirdItemActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/ThirdItemOptionMessageDecoder.java b/src/org/apollo/net/release/r317/ThirdItemOptionMessageDecoder.java index ce11509c..9c02f5d1 100644 --- a/src/org/apollo/net/release/r317/ThirdItemOptionMessageDecoder.java +++ b/src/org/apollo/net/release/r317/ThirdItemOptionMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link ThirdItemOptionMessage}. - * + * * @author Chris Fletcher */ final class ThirdItemOptionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/ThirdNpcActionMessageDecoder.java b/src/org/apollo/net/release/r317/ThirdNpcActionMessageDecoder.java index b85c2396..f191c511 100644 --- a/src/org/apollo/net/release/r317/ThirdNpcActionMessageDecoder.java +++ b/src/org/apollo/net/release/r317/ThirdNpcActionMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link ThirdNpcActionMessage}. - * + * * @author Major */ public final class ThirdNpcActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/ThirdObjectActionMessageDecoder.java b/src/org/apollo/net/release/r317/ThirdObjectActionMessageDecoder.java index e1cf8263..08e090f4 100644 --- a/src/org/apollo/net/release/r317/ThirdObjectActionMessageDecoder.java +++ b/src/org/apollo/net/release/r317/ThirdObjectActionMessageDecoder.java @@ -11,7 +11,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link ThirdObjectActionMessage}. - * + * * @author Graham */ public final class ThirdObjectActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/ThirdPlayerActionMessageDecoder.java b/src/org/apollo/net/release/r317/ThirdPlayerActionMessageDecoder.java index cf9e3a68..f8395928 100644 --- a/src/org/apollo/net/release/r317/ThirdPlayerActionMessageDecoder.java +++ b/src/org/apollo/net/release/r317/ThirdPlayerActionMessageDecoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link ThirdPlayerActionMessage}. - * + * * @author Major */ public final class ThirdPlayerActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r317/UpdateItemsMessageEncoder.java b/src/org/apollo/net/release/r317/UpdateItemsMessageEncoder.java index 60551024..fb6df18d 100644 --- a/src/org/apollo/net/release/r317/UpdateItemsMessageEncoder.java +++ b/src/org/apollo/net/release/r317/UpdateItemsMessageEncoder.java @@ -12,7 +12,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link UpdateItemsMessage}. - * + * * @author Graham */ public final class UpdateItemsMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/UpdateRunEnergyMessageEncoder.java b/src/org/apollo/net/release/r317/UpdateRunEnergyMessageEncoder.java index 0072a087..91204d2c 100644 --- a/src/org/apollo/net/release/r317/UpdateRunEnergyMessageEncoder.java +++ b/src/org/apollo/net/release/r317/UpdateRunEnergyMessageEncoder.java @@ -8,7 +8,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link UpdateRunEnergyMessage} - * + * * @author Major */ public final class UpdateRunEnergyMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/UpdateSkillMessageEncoder.java b/src/org/apollo/net/release/r317/UpdateSkillMessageEncoder.java index 9a586667..10ceb3ed 100644 --- a/src/org/apollo/net/release/r317/UpdateSkillMessageEncoder.java +++ b/src/org/apollo/net/release/r317/UpdateSkillMessageEncoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link UpdateSkillMessage}. - * + * * @author Graham */ public final class UpdateSkillMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/UpdateSlottedItemsMessageEncoder.java b/src/org/apollo/net/release/r317/UpdateSlottedItemsMessageEncoder.java index b26283c4..4da2bd95 100644 --- a/src/org/apollo/net/release/r317/UpdateSlottedItemsMessageEncoder.java +++ b/src/org/apollo/net/release/r317/UpdateSlottedItemsMessageEncoder.java @@ -11,7 +11,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link UpdateSlottedItemsMessage}. - * + * * @author Graham */ public final class UpdateSlottedItemsMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/UpdateTileItemMessageEncoder.java b/src/org/apollo/net/release/r317/UpdateTileItemMessageEncoder.java index e8d78b58..57af9756 100644 --- a/src/org/apollo/net/release/r317/UpdateTileItemMessageEncoder.java +++ b/src/org/apollo/net/release/r317/UpdateTileItemMessageEncoder.java @@ -8,7 +8,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link UpdateTileItemMessage}. - * + * * @author Major */ public final class UpdateTileItemMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/UpdateWeightMessageEncoder.java b/src/org/apollo/net/release/r317/UpdateWeightMessageEncoder.java index f66e12b7..b19a245e 100644 --- a/src/org/apollo/net/release/r317/UpdateWeightMessageEncoder.java +++ b/src/org/apollo/net/release/r317/UpdateWeightMessageEncoder.java @@ -8,7 +8,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link UpdateWeightMessage}. - * + * * @author Major */ public final class UpdateWeightMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r317/WalkMessageDecoder.java b/src/org/apollo/net/release/r317/WalkMessageDecoder.java index ced9e6ec..960bd664 100644 --- a/src/org/apollo/net/release/r317/WalkMessageDecoder.java +++ b/src/org/apollo/net/release/r317/WalkMessageDecoder.java @@ -11,7 +11,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link WalkMessage}. - * + * * @author Graham */ public final class WalkMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/AddFriendMessageDecoder.java b/src/org/apollo/net/release/r377/AddFriendMessageDecoder.java index bd2fb2f6..e7381dd9 100644 --- a/src/org/apollo/net/release/r377/AddFriendMessageDecoder.java +++ b/src/org/apollo/net/release/r377/AddFriendMessageDecoder.java @@ -9,7 +9,7 @@ import org.apollo.util.NameUtil; /** * A {@link MessageDecoder} for the {@link AddFriendMessage}. - * + * * @author Major */ public final class AddFriendMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/AddGlobalTileItemMessageEncoder.java b/src/org/apollo/net/release/r377/AddGlobalTileItemMessageEncoder.java index a9b9774e..5b9e01eb 100644 --- a/src/org/apollo/net/release/r377/AddGlobalTileItemMessageEncoder.java +++ b/src/org/apollo/net/release/r377/AddGlobalTileItemMessageEncoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link SendPublicTileItemMessage}. - * + * * @author Major */ public final class AddGlobalTileItemMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/AddIgnoreMessageDecoder.java b/src/org/apollo/net/release/r377/AddIgnoreMessageDecoder.java index 58e48947..05ddd42a 100644 --- a/src/org/apollo/net/release/r377/AddIgnoreMessageDecoder.java +++ b/src/org/apollo/net/release/r377/AddIgnoreMessageDecoder.java @@ -9,7 +9,7 @@ import org.apollo.util.NameUtil; /** * A {@link MessageDecoder} for the {@link AddIgnoreMessage}. - * + * * @author Major */ public final class AddIgnoreMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/AddTileItemMessageEncoder.java b/src/org/apollo/net/release/r377/AddTileItemMessageEncoder.java index 26a41933..b84d08ea 100644 --- a/src/org/apollo/net/release/r377/AddTileItemMessageEncoder.java +++ b/src/org/apollo/net/release/r377/AddTileItemMessageEncoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link SendTileItemMessage}. - * + * * @author Major */ public final class AddTileItemMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/ArrowKeyMessageDecoder.java b/src/org/apollo/net/release/r377/ArrowKeyMessageDecoder.java index cb216890..666c50f8 100644 --- a/src/org/apollo/net/release/r377/ArrowKeyMessageDecoder.java +++ b/src/org/apollo/net/release/r377/ArrowKeyMessageDecoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link ArrowKeyMessage}. - * + * * @author Major */ public final class ArrowKeyMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/ButtonMessageDecoder.java b/src/org/apollo/net/release/r377/ButtonMessageDecoder.java index 63afacf9..44bfd007 100644 --- a/src/org/apollo/net/release/r377/ButtonMessageDecoder.java +++ b/src/org/apollo/net/release/r377/ButtonMessageDecoder.java @@ -8,7 +8,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link ButtonMessage}. - * + * * @author Graham */ public final class ButtonMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/ChatMessageDecoder.java b/src/org/apollo/net/release/r377/ChatMessageDecoder.java index a1c24ae7..37fd57e4 100644 --- a/src/org/apollo/net/release/r377/ChatMessageDecoder.java +++ b/src/org/apollo/net/release/r377/ChatMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.util.TextUtil; /** * A {@link MessageDecoder} for the {@link ChatMessage}. - * + * * @author Graham */ public final class ChatMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/CloseInterfaceMessageEncoder.java b/src/org/apollo/net/release/r377/CloseInterfaceMessageEncoder.java index d4aa1ac3..ed18393a 100644 --- a/src/org/apollo/net/release/r377/CloseInterfaceMessageEncoder.java +++ b/src/org/apollo/net/release/r377/CloseInterfaceMessageEncoder.java @@ -7,7 +7,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link CloseInterfaceMessage}. - * + * * @author Graham */ public final class CloseInterfaceMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/ClosedInterfaceMessageDecoder.java b/src/org/apollo/net/release/r377/ClosedInterfaceMessageDecoder.java index b5187df7..76de1ba0 100644 --- a/src/org/apollo/net/release/r377/ClosedInterfaceMessageDecoder.java +++ b/src/org/apollo/net/release/r377/ClosedInterfaceMessageDecoder.java @@ -6,7 +6,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link ClosedInterfaceMessage}. - * + * * @author Graham */ public final class ClosedInterfaceMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/CommandMessageDecoder.java b/src/org/apollo/net/release/r377/CommandMessageDecoder.java index 39989d05..da216b7e 100644 --- a/src/org/apollo/net/release/r377/CommandMessageDecoder.java +++ b/src/org/apollo/net/release/r377/CommandMessageDecoder.java @@ -7,7 +7,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link CommandMessage}. - * + * * @author Graham */ public final class CommandMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/ConfigMessageEncoder.java b/src/org/apollo/net/release/r377/ConfigMessageEncoder.java index e85cac23..691fb5ef 100644 --- a/src/org/apollo/net/release/r377/ConfigMessageEncoder.java +++ b/src/org/apollo/net/release/r377/ConfigMessageEncoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link ConfigMessage}. - * + * * @author Chris Fletcher * @author Major */ diff --git a/src/org/apollo/net/release/r377/DialogueContinueMessageDecoder.java b/src/org/apollo/net/release/r377/DialogueContinueMessageDecoder.java index 7ec4d5ea..6f34f106 100644 --- a/src/org/apollo/net/release/r377/DialogueContinueMessageDecoder.java +++ b/src/org/apollo/net/release/r377/DialogueContinueMessageDecoder.java @@ -8,7 +8,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link DialogueContinueMessage}. - * + * * @author Chris Fletcher */ final class DialogueContinueMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/DisplayCrossbonesMessageEncoder.java b/src/org/apollo/net/release/r377/DisplayCrossbonesMessageEncoder.java index 2d25c827..77426da2 100644 --- a/src/org/apollo/net/release/r377/DisplayCrossbonesMessageEncoder.java +++ b/src/org/apollo/net/release/r377/DisplayCrossbonesMessageEncoder.java @@ -8,7 +8,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link DisplayCrossbonesMessage}. - * + * * @author Major */ public final class DisplayCrossbonesMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/DisplayTabInterfaceMessageEncoder.java b/src/org/apollo/net/release/r377/DisplayTabInterfaceMessageEncoder.java index c8ad7cc0..9f4184ec 100644 --- a/src/org/apollo/net/release/r377/DisplayTabInterfaceMessageEncoder.java +++ b/src/org/apollo/net/release/r377/DisplayTabInterfaceMessageEncoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link DisplayTabInterfaceMessage}. - * + * * @author Chris Fletcher */ final class DisplayTabInterfaceMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/EnterAmountMessageEncoder.java b/src/org/apollo/net/release/r377/EnterAmountMessageEncoder.java index b46a9712..f9747ced 100644 --- a/src/org/apollo/net/release/r377/EnterAmountMessageEncoder.java +++ b/src/org/apollo/net/release/r377/EnterAmountMessageEncoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link EnterAmountMessage}. - * + * * @author Graham */ public final class EnterAmountMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/EnteredAmountMessageDecoder.java b/src/org/apollo/net/release/r377/EnteredAmountMessageDecoder.java index 139e1f41..c0f0a4dc 100644 --- a/src/org/apollo/net/release/r377/EnteredAmountMessageDecoder.java +++ b/src/org/apollo/net/release/r377/EnteredAmountMessageDecoder.java @@ -8,7 +8,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link EnteredAmountMessage}. - * + * * @author Graham */ public final class EnteredAmountMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/FifthItemActionMessageDecoder.java b/src/org/apollo/net/release/r377/FifthItemActionMessageDecoder.java index 62449679..8a92b568 100644 --- a/src/org/apollo/net/release/r377/FifthItemActionMessageDecoder.java +++ b/src/org/apollo/net/release/r377/FifthItemActionMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link FifthItemActionMessage}. - * + * * @author Graham */ public final class FifthItemActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/FifthItemOptionMessageDecoder.java b/src/org/apollo/net/release/r377/FifthItemOptionMessageDecoder.java index d44c032b..f4f2c24f 100644 --- a/src/org/apollo/net/release/r377/FifthItemOptionMessageDecoder.java +++ b/src/org/apollo/net/release/r377/FifthItemOptionMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link FifthItemOptionMessage}. - * + * * @author Chris Fletcher */ final class FifthItemOptionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/FifthPlayerActionMessageDecoder.java b/src/org/apollo/net/release/r377/FifthPlayerActionMessageDecoder.java index f7e76f2b..51d92f5a 100644 --- a/src/org/apollo/net/release/r377/FifthPlayerActionMessageDecoder.java +++ b/src/org/apollo/net/release/r377/FifthPlayerActionMessageDecoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link FifthPlayerActionMessage}. - * + * * @author Major */ public final class FifthPlayerActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/FirstItemActionMessageDecoder.java b/src/org/apollo/net/release/r377/FirstItemActionMessageDecoder.java index faace640..b559c56c 100644 --- a/src/org/apollo/net/release/r377/FirstItemActionMessageDecoder.java +++ b/src/org/apollo/net/release/r377/FirstItemActionMessageDecoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link FirstItemActionMessage}. - * + * * @author Graham */ public final class FirstItemActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/FirstItemOptionMessageDecoder.java b/src/org/apollo/net/release/r377/FirstItemOptionMessageDecoder.java index c9aace72..64ca57be 100644 --- a/src/org/apollo/net/release/r377/FirstItemOptionMessageDecoder.java +++ b/src/org/apollo/net/release/r377/FirstItemOptionMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link FirstItemOptionMessage}. - * + * * @author Chris Fletcher */ final class FirstItemOptionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/FirstNpcActionMessageDecoder.java b/src/org/apollo/net/release/r377/FirstNpcActionMessageDecoder.java index 2b5b4f4f..ed49b4e1 100644 --- a/src/org/apollo/net/release/r377/FirstNpcActionMessageDecoder.java +++ b/src/org/apollo/net/release/r377/FirstNpcActionMessageDecoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageDecoder; /** * The {@link MessageDecoder} for the {@link FirstNpcActionMessage}. - * + * * @author Major */ public final class FirstNpcActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/FirstObjectActionMessageDecoder.java b/src/org/apollo/net/release/r377/FirstObjectActionMessageDecoder.java index 8c34b0d6..1636075d 100644 --- a/src/org/apollo/net/release/r377/FirstObjectActionMessageDecoder.java +++ b/src/org/apollo/net/release/r377/FirstObjectActionMessageDecoder.java @@ -11,7 +11,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link FirstObjectActionMessage}. - * + * * @author Graham */ public final class FirstObjectActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/FirstPlayerActionMessageDecoder.java b/src/org/apollo/net/release/r377/FirstPlayerActionMessageDecoder.java index 189b6c29..b1e94ee3 100644 --- a/src/org/apollo/net/release/r377/FirstPlayerActionMessageDecoder.java +++ b/src/org/apollo/net/release/r377/FirstPlayerActionMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link FirstPlayerActionMessage}. - * + * * @author Major */ public final class FirstPlayerActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/FlaggedMouseEventMessageDecoder.java b/src/org/apollo/net/release/r377/FlaggedMouseEventMessageDecoder.java index 61ecf663..d74d3efd 100644 --- a/src/org/apollo/net/release/r377/FlaggedMouseEventMessageDecoder.java +++ b/src/org/apollo/net/release/r377/FlaggedMouseEventMessageDecoder.java @@ -8,7 +8,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link org.apollo.game.message.impl.FlaggedMouseEventMessage}. - * + * * @author Major */ public final class FlaggedMouseEventMessageDecoder extends MessageDecoder { @@ -20,8 +20,8 @@ public final class FlaggedMouseEventMessageDecoder extends MessageDecoder> 12); - x = (read >> 6) & 0x3f; + clicks = read >> 12; + x = read >> 6 & 0x3f; y = read & 0x3f; return new FlaggedMouseEventMessage(clicks, x, y, true); } else if (reader.getLength() == 3) { @@ -30,7 +30,7 @@ public final class FlaggedMouseEventMessageDecoder extends MessageDecoder> 19); + clicks = read >> 19; x = (read & 0x7f) % 765; y = (read & 0x7f) / 765; return new FlaggedMouseEventMessage(clicks, x, y, false); diff --git a/src/org/apollo/net/release/r377/FocusUpdateMessageDecoder.java b/src/org/apollo/net/release/r377/FocusUpdateMessageDecoder.java index 34bacde5..c44e0ea0 100644 --- a/src/org/apollo/net/release/r377/FocusUpdateMessageDecoder.java +++ b/src/org/apollo/net/release/r377/FocusUpdateMessageDecoder.java @@ -8,7 +8,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link FocusUpdateMessage}. - * + * * @author Major */ public final class FocusUpdateMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/ForwardPrivateChatMessageEncoder.java b/src/org/apollo/net/release/r377/ForwardPrivateChatMessageEncoder.java index a0ebf98c..8c225683 100644 --- a/src/org/apollo/net/release/r377/ForwardPrivateChatMessageEncoder.java +++ b/src/org/apollo/net/release/r377/ForwardPrivateChatMessageEncoder.java @@ -12,7 +12,7 @@ import org.apollo.util.NameUtil; /** * A {@link MessageEncoder} for the {@link ForwardPrivateChatMessage}. - * + * * @author Major */ public final class ForwardPrivateChatMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/FourthItemActionMessageDecoder.java b/src/org/apollo/net/release/r377/FourthItemActionMessageDecoder.java index c1b38320..e8403f6b 100644 --- a/src/org/apollo/net/release/r377/FourthItemActionMessageDecoder.java +++ b/src/org/apollo/net/release/r377/FourthItemActionMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link FourthItemActionMessage}. - * + * * @author Graham */ public final class FourthItemActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/FourthItemOptionMessageDecoder.java b/src/org/apollo/net/release/r377/FourthItemOptionMessageDecoder.java index c837a237..3de1c408 100644 --- a/src/org/apollo/net/release/r377/FourthItemOptionMessageDecoder.java +++ b/src/org/apollo/net/release/r377/FourthItemOptionMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link FourthItemOptionMessage}. - * + * * @author Chris Fletcher */ final class FourthItemOptionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/FourthPlayerActionMessageDecoder.java b/src/org/apollo/net/release/r377/FourthPlayerActionMessageDecoder.java index 850c1a38..491bd1bf 100644 --- a/src/org/apollo/net/release/r377/FourthPlayerActionMessageDecoder.java +++ b/src/org/apollo/net/release/r377/FourthPlayerActionMessageDecoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link FourthPlayerActionMessage}. - * + * * @author Major */ public final class FourthPlayerActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/FriendServerStatusMessageEncoder.java b/src/org/apollo/net/release/r377/FriendServerStatusMessageEncoder.java index 01bccf59..5cd35192 100644 --- a/src/org/apollo/net/release/r377/FriendServerStatusMessageEncoder.java +++ b/src/org/apollo/net/release/r377/FriendServerStatusMessageEncoder.java @@ -8,7 +8,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link FriendServerStatusMessage}. - * + * * @author Major */ public final class FriendServerStatusMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/IdAssignmentMessageEncoder.java b/src/org/apollo/net/release/r377/IdAssignmentMessageEncoder.java index b399e4e7..4ef63978 100644 --- a/src/org/apollo/net/release/r377/IdAssignmentMessageEncoder.java +++ b/src/org/apollo/net/release/r377/IdAssignmentMessageEncoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link IdAssignmentMessage}. - * + * * @author Graham */ public final class IdAssignmentMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/IgnoreListMessageEncoder.java b/src/org/apollo/net/release/r377/IgnoreListMessageEncoder.java index a31219af..27f8e21a 100644 --- a/src/org/apollo/net/release/r377/IgnoreListMessageEncoder.java +++ b/src/org/apollo/net/release/r377/IgnoreListMessageEncoder.java @@ -11,7 +11,7 @@ import org.apollo.util.NameUtil; /** * A {@link MessageEncoder} for the {@link IgnoreListMessage}. - * + * * @author Major */ public final class IgnoreListMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/ItemOnItemMessageDecoder.java b/src/org/apollo/net/release/r377/ItemOnItemMessageDecoder.java index 74ce09ae..cbfc33c0 100644 --- a/src/org/apollo/net/release/r377/ItemOnItemMessageDecoder.java +++ b/src/org/apollo/net/release/r377/ItemOnItemMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link ItemOnItemMessageDecoder}. - * + * * @author Chris Fletcher */ final class ItemOnItemMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/ItemOnObjectMessageDecoder.java b/src/org/apollo/net/release/r377/ItemOnObjectMessageDecoder.java index edc02a42..30c331d5 100644 --- a/src/org/apollo/net/release/r377/ItemOnObjectMessageDecoder.java +++ b/src/org/apollo/net/release/r377/ItemOnObjectMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link ItemOnObjectMessage}. - * + * * @author Major */ public final class ItemOnObjectMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/KeepAliveMessageDecoder.java b/src/org/apollo/net/release/r377/KeepAliveMessageDecoder.java index 65028c12..236b815f 100644 --- a/src/org/apollo/net/release/r377/KeepAliveMessageDecoder.java +++ b/src/org/apollo/net/release/r377/KeepAliveMessageDecoder.java @@ -6,7 +6,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link KeepAliveMessage}. - * + * * @author Graham */ public final class KeepAliveMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/LogoutMessageEncoder.java b/src/org/apollo/net/release/r377/LogoutMessageEncoder.java index 4c4e3fc1..c2b32a80 100644 --- a/src/org/apollo/net/release/r377/LogoutMessageEncoder.java +++ b/src/org/apollo/net/release/r377/LogoutMessageEncoder.java @@ -7,7 +7,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link LogoutMessage}. - * + * * @author Graham */ public final class LogoutMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/MagicOnItemMessageDecoder.java b/src/org/apollo/net/release/r377/MagicOnItemMessageDecoder.java index 44dd7927..22f3e277 100644 --- a/src/org/apollo/net/release/r377/MagicOnItemMessageDecoder.java +++ b/src/org/apollo/net/release/r377/MagicOnItemMessageDecoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link MagicOnItemMessage}. - * + * * @author Chris Fletcher */ final class MagicOnItemMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/MobAnimationResetMessageEncoder.java b/src/org/apollo/net/release/r377/MobAnimationResetMessageEncoder.java index 2360c6af..ce92d084 100644 --- a/src/org/apollo/net/release/r377/MobAnimationResetMessageEncoder.java +++ b/src/org/apollo/net/release/r377/MobAnimationResetMessageEncoder.java @@ -7,7 +7,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link MobAnimationResetMessage}. - * + * * @author Major */ public final class MobAnimationResetMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/MouseClickedMessageDecoder.java b/src/org/apollo/net/release/r377/MouseClickedMessageDecoder.java index 2a502c60..75f81e3e 100644 --- a/src/org/apollo/net/release/r377/MouseClickedMessageDecoder.java +++ b/src/org/apollo/net/release/r377/MouseClickedMessageDecoder.java @@ -19,9 +19,9 @@ public final class MouseClickedMessageDecoder extends MessageDecoder> 20) * 50; - boolean right = ((value >> 19) & 0x1) == 1; + boolean right = (value >> 19 & 0x1) == 1; - int cords = (value & 0x3FFFF); + int cords = value & 0x3FFFF; int x = cords % 765; int y = cords / 765; diff --git a/src/org/apollo/net/release/r377/NpcSynchronizationMessageEncoder.java b/src/org/apollo/net/release/r377/NpcSynchronizationMessageEncoder.java index 8702363f..45ade55e 100644 --- a/src/org/apollo/net/release/r377/NpcSynchronizationMessageEncoder.java +++ b/src/org/apollo/net/release/r377/NpcSynchronizationMessageEncoder.java @@ -28,7 +28,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link NpcSynchronizationMessage}. - * + * * @author Major */ public final class NpcSynchronizationMessageEncoder extends MessageEncoder { @@ -67,7 +67,7 @@ public final class NpcSynchronizationMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/OpenDialogueOverlayMessageEncoder.java b/src/org/apollo/net/release/r377/OpenDialogueOverlayMessageEncoder.java index aff73005..d8fcfb78 100644 --- a/src/org/apollo/net/release/r377/OpenDialogueOverlayMessageEncoder.java +++ b/src/org/apollo/net/release/r377/OpenDialogueOverlayMessageEncoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link OpenDialogueOverlayMessage}. - * + * * @author Major */ public final class OpenDialogueOverlayMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/OpenInterfaceMessageEncoder.java b/src/org/apollo/net/release/r377/OpenInterfaceMessageEncoder.java index b7c167be..4dd24ab3 100644 --- a/src/org/apollo/net/release/r377/OpenInterfaceMessageEncoder.java +++ b/src/org/apollo/net/release/r377/OpenInterfaceMessageEncoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link OpenInterfaceMessage}. - * + * * @author Graham */ public final class OpenInterfaceMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/OpenInterfaceSidebarMessageEncoder.java b/src/org/apollo/net/release/r377/OpenInterfaceSidebarMessageEncoder.java index 543c509a..34c26114 100644 --- a/src/org/apollo/net/release/r377/OpenInterfaceSidebarMessageEncoder.java +++ b/src/org/apollo/net/release/r377/OpenInterfaceSidebarMessageEncoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link OpenInterfaceSidebarMessage}. - * + * * @author Graham */ public final class OpenInterfaceSidebarMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/PlayerDesignMessageDecoder.java b/src/org/apollo/net/release/r377/PlayerDesignMessageDecoder.java index 61593731..53036b8e 100644 --- a/src/org/apollo/net/release/r377/PlayerDesignMessageDecoder.java +++ b/src/org/apollo/net/release/r377/PlayerDesignMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link PlayerDesignMessage}. - * + * * @author Graham */ public final class PlayerDesignMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/PlayerSynchronizationMessageEncoder.java b/src/org/apollo/net/release/r377/PlayerSynchronizationMessageEncoder.java index 4bfc1d82..bb6e9077 100644 --- a/src/org/apollo/net/release/r377/PlayerSynchronizationMessageEncoder.java +++ b/src/org/apollo/net/release/r377/PlayerSynchronizationMessageEncoder.java @@ -37,7 +37,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link PlayerSynchronizationMessage}. - * + * * @author Graham * @author Major */ @@ -81,7 +81,7 @@ public final class PlayerSynchronizationMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/PrivacyOptionMessageEncoder.java b/src/org/apollo/net/release/r377/PrivacyOptionMessageEncoder.java index d5ac16b8..1024f094 100644 --- a/src/org/apollo/net/release/r377/PrivacyOptionMessageEncoder.java +++ b/src/org/apollo/net/release/r377/PrivacyOptionMessageEncoder.java @@ -8,7 +8,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link PrivacyOptionMessage}. - * + * * @author Major */ public final class PrivacyOptionMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/PrivateChatMessageDecoder.java b/src/org/apollo/net/release/r377/PrivateChatMessageDecoder.java index a7030687..c249533d 100644 --- a/src/org/apollo/net/release/r377/PrivateChatMessageDecoder.java +++ b/src/org/apollo/net/release/r377/PrivateChatMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.util.TextUtil; /** * A {@link MessageDecoder} for the {@link PrivateChatMessage}. - * + * * @author Major */ public final class PrivateChatMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/RegionChangeMessageEncoder.java b/src/org/apollo/net/release/r377/RegionChangeMessageEncoder.java index b8d1f991..a0e3521e 100644 --- a/src/org/apollo/net/release/r377/RegionChangeMessageEncoder.java +++ b/src/org/apollo/net/release/r377/RegionChangeMessageEncoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link RegionChangeMessage}. - * + * * @author Graham */ public final class RegionChangeMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/Release377.java b/src/org/apollo/net/release/r377/Release377.java index e0180ce0..20160ab1 100644 --- a/src/org/apollo/net/release/r377/Release377.java +++ b/src/org/apollo/net/release/r377/Release377.java @@ -56,7 +56,7 @@ import org.apollo.net.release.Release; /** * A {@link Release} implementation for the 377 protocol. - * + * * @author Graham */ public final class Release377 extends Release { diff --git a/src/org/apollo/net/release/r377/RemoveFriendMessageDecoder.java b/src/org/apollo/net/release/r377/RemoveFriendMessageDecoder.java index f7d9fa1d..26e4d33b 100644 --- a/src/org/apollo/net/release/r377/RemoveFriendMessageDecoder.java +++ b/src/org/apollo/net/release/r377/RemoveFriendMessageDecoder.java @@ -9,7 +9,7 @@ import org.apollo.util.NameUtil; /** * A {@link MessageDecoder} for the {@link RemoveFriendMessage}. - * + * * @author Major */ public final class RemoveFriendMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/RemoveIgnoreMessageDecoder.java b/src/org/apollo/net/release/r377/RemoveIgnoreMessageDecoder.java index f2389d9d..6b4d809c 100644 --- a/src/org/apollo/net/release/r377/RemoveIgnoreMessageDecoder.java +++ b/src/org/apollo/net/release/r377/RemoveIgnoreMessageDecoder.java @@ -9,7 +9,7 @@ import org.apollo.util.NameUtil; /** * A {@link MessageDecoder} for the {@link RemoveIgnoreMessage}. - * + * * @author Major */ public final class RemoveIgnoreMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/RemoveObjectMessageEncoder.java b/src/org/apollo/net/release/r377/RemoveObjectMessageEncoder.java index 197cf2a1..5fe9b295 100644 --- a/src/org/apollo/net/release/r377/RemoveObjectMessageEncoder.java +++ b/src/org/apollo/net/release/r377/RemoveObjectMessageEncoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link RemoveObjectMessage}. - * + * * @author Major */ public final class RemoveObjectMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/RemoveTileItemMessageEncoder.java b/src/org/apollo/net/release/r377/RemoveTileItemMessageEncoder.java index 451c8810..faab8485 100644 --- a/src/org/apollo/net/release/r377/RemoveTileItemMessageEncoder.java +++ b/src/org/apollo/net/release/r377/RemoveTileItemMessageEncoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link RemoveTileItemMessage}. - * + * * @author Major */ public final class RemoveTileItemMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/SecondItemActionMessageDecoder.java b/src/org/apollo/net/release/r377/SecondItemActionMessageDecoder.java index 0d8bacad..c5c71f4d 100644 --- a/src/org/apollo/net/release/r377/SecondItemActionMessageDecoder.java +++ b/src/org/apollo/net/release/r377/SecondItemActionMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link SecondItemActionMessage}. - * + * * @author Graham */ public final class SecondItemActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/SecondItemOptionMessageDecoder.java b/src/org/apollo/net/release/r377/SecondItemOptionMessageDecoder.java index 7c728b21..4dc683f9 100644 --- a/src/org/apollo/net/release/r377/SecondItemOptionMessageDecoder.java +++ b/src/org/apollo/net/release/r377/SecondItemOptionMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link SecondItemOptionMessage}. - * + * * @author Graham */ final class SecondItemOptionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/SecondNpcActionMessageDecoder.java b/src/org/apollo/net/release/r377/SecondNpcActionMessageDecoder.java index 79d87516..c7e086b8 100644 --- a/src/org/apollo/net/release/r377/SecondNpcActionMessageDecoder.java +++ b/src/org/apollo/net/release/r377/SecondNpcActionMessageDecoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageDecoder; /** * The {@link MessageDecoder} for the {@link SecondNpcActionMessage}. - * + * * @author Major */ public final class SecondNpcActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/SecondObjectActionMessageDecoder.java b/src/org/apollo/net/release/r377/SecondObjectActionMessageDecoder.java index 70dc3c3b..59b28510 100644 --- a/src/org/apollo/net/release/r377/SecondObjectActionMessageDecoder.java +++ b/src/org/apollo/net/release/r377/SecondObjectActionMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link SecondObjectActionMessage}. - * + * * @author Graham */ public final class SecondObjectActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/SecondPlayerActionMessageDecoder.java b/src/org/apollo/net/release/r377/SecondPlayerActionMessageDecoder.java index f0c58fed..162d3375 100644 --- a/src/org/apollo/net/release/r377/SecondPlayerActionMessageDecoder.java +++ b/src/org/apollo/net/release/r377/SecondPlayerActionMessageDecoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link SecondPlayerActionMessage}. - * + * * @author Major */ public final class SecondPlayerActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/SendFriendMessageEncoder.java b/src/org/apollo/net/release/r377/SendFriendMessageEncoder.java index 87cec30a..3b992e43 100644 --- a/src/org/apollo/net/release/r377/SendFriendMessageEncoder.java +++ b/src/org/apollo/net/release/r377/SendFriendMessageEncoder.java @@ -9,7 +9,7 @@ import org.apollo.util.NameUtil; /** * A {@link MessageEncoder} for the {@link SendFriendMessage}. - * + * * @author Major */ public final class SendFriendMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/SendObjectMessageEncoder.java b/src/org/apollo/net/release/r377/SendObjectMessageEncoder.java index 69d7e1a8..488cd776 100644 --- a/src/org/apollo/net/release/r377/SendObjectMessageEncoder.java +++ b/src/org/apollo/net/release/r377/SendObjectMessageEncoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link SendObjectMessage}. - * + * * @author Major */ public final class SendObjectMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/ServerMessageMessageEncoder.java b/src/org/apollo/net/release/r377/ServerMessageMessageEncoder.java index 03e64e4a..a4f06743 100644 --- a/src/org/apollo/net/release/r377/ServerMessageMessageEncoder.java +++ b/src/org/apollo/net/release/r377/ServerMessageMessageEncoder.java @@ -8,7 +8,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link ServerChatMessage}. - * + * * @author Graham */ public final class ServerMessageMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/SetPlayerActionMessageEncoder.java b/src/org/apollo/net/release/r377/SetPlayerActionMessageEncoder.java index 9822e189..32eb46f7 100644 --- a/src/org/apollo/net/release/r377/SetPlayerActionMessageEncoder.java +++ b/src/org/apollo/net/release/r377/SetPlayerActionMessageEncoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageEncoder; /** * The {@link MessageEncoder} for the {@link SetPlayerActionMessage}. - * + * * @author Major */ public final class SetPlayerActionMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/SetUpdatedRegionMessageEncoder.java b/src/org/apollo/net/release/r377/SetUpdatedRegionMessageEncoder.java index dcb0bd9a..959ecac3 100644 --- a/src/org/apollo/net/release/r377/SetUpdatedRegionMessageEncoder.java +++ b/src/org/apollo/net/release/r377/SetUpdatedRegionMessageEncoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link SetUpdatedRegionMessage}. - * + * * @author Chris Fletcher * @author Major */ diff --git a/src/org/apollo/net/release/r377/SetWidgetItemModelMessageEncoder.java b/src/org/apollo/net/release/r377/SetWidgetItemModelMessageEncoder.java index e202d9fb..08ba7f87 100644 --- a/src/org/apollo/net/release/r377/SetWidgetItemModelMessageEncoder.java +++ b/src/org/apollo/net/release/r377/SetWidgetItemModelMessageEncoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link SetWidgetItemModelMessage}. - * + * * @author Chris Fletcher */ final class SetWidgetItemModelMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/SetWidgetModelAnimationMessageEncoder.java b/src/org/apollo/net/release/r377/SetWidgetModelAnimationMessageEncoder.java index f435ed5b..751209b2 100644 --- a/src/org/apollo/net/release/r377/SetWidgetModelAnimationMessageEncoder.java +++ b/src/org/apollo/net/release/r377/SetWidgetModelAnimationMessageEncoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link SetWidgetModelAnimationMessage}. - * + * * @author Chris Fletcher */ final class SetWidgetModelAnimationMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/SetWidgetNpcModelMessageEncoder.java b/src/org/apollo/net/release/r377/SetWidgetNpcModelMessageEncoder.java index 95c3c109..613bbcf4 100644 --- a/src/org/apollo/net/release/r377/SetWidgetNpcModelMessageEncoder.java +++ b/src/org/apollo/net/release/r377/SetWidgetNpcModelMessageEncoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link SetWidgetNpcModelMessage}. - * + * * @author Chris Fletcher */ final class SetWidgetNpcModelMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/SetWidgetPlayerModelMessageEncoder.java b/src/org/apollo/net/release/r377/SetWidgetPlayerModelMessageEncoder.java index ff686f87..cdc55090 100644 --- a/src/org/apollo/net/release/r377/SetWidgetPlayerModelMessageEncoder.java +++ b/src/org/apollo/net/release/r377/SetWidgetPlayerModelMessageEncoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link SetWidgetPlayerModelMessage}. - * + * * @author Chris Fletcher */ final class SetWidgetPlayerModelMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/SetWidgetTexMessageEncoder.java b/src/org/apollo/net/release/r377/SetWidgetTexMessageEncoder.java index be38f99f..3f6f98a6 100644 --- a/src/org/apollo/net/release/r377/SetWidgetTexMessageEncoder.java +++ b/src/org/apollo/net/release/r377/SetWidgetTexMessageEncoder.java @@ -11,7 +11,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link SetWidgetTextMessage}. - * + * * @author Graham */ public final class SetWidgetTexMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/SetWidgetVisibilityMessageEncoder.java b/src/org/apollo/net/release/r377/SetWidgetVisibilityMessageEncoder.java index bea2655b..b47d2fc4 100644 --- a/src/org/apollo/net/release/r377/SetWidgetVisibilityMessageEncoder.java +++ b/src/org/apollo/net/release/r377/SetWidgetVisibilityMessageEncoder.java @@ -8,7 +8,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link SetWidgetVisibilityMessage}. - * + * * @author Chris Fletcher */ final class SetWidgetVisibilityMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/SpamPacketMessageDecoder.java b/src/org/apollo/net/release/r377/SpamPacketMessageDecoder.java index 5ce36a1e..493aefff 100644 --- a/src/org/apollo/net/release/r377/SpamPacketMessageDecoder.java +++ b/src/org/apollo/net/release/r377/SpamPacketMessageDecoder.java @@ -6,7 +6,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link SpamPacketMessage}. - * + * * @author Major */ public final class SpamPacketMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/SwitchItemMessageDecoder.java b/src/org/apollo/net/release/r377/SwitchItemMessageDecoder.java index d87e65bf..9d54a791 100644 --- a/src/org/apollo/net/release/r377/SwitchItemMessageDecoder.java +++ b/src/org/apollo/net/release/r377/SwitchItemMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link SwitchItemMessage}. - * + * * @author Graham */ public final class SwitchItemMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/SwitchTabInterfaceMessageEncoder.java b/src/org/apollo/net/release/r377/SwitchTabInterfaceMessageEncoder.java index 778cc844..4ef2fcc4 100644 --- a/src/org/apollo/net/release/r377/SwitchTabInterfaceMessageEncoder.java +++ b/src/org/apollo/net/release/r377/SwitchTabInterfaceMessageEncoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link SwitchTabInterfaceMessage}. - * + * * @author Graham */ public final class SwitchTabInterfaceMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/TakeTileItemMessageDecoder.java b/src/org/apollo/net/release/r377/TakeTileItemMessageDecoder.java index 344c55c8..69adf4c7 100644 --- a/src/org/apollo/net/release/r377/TakeTileItemMessageDecoder.java +++ b/src/org/apollo/net/release/r377/TakeTileItemMessageDecoder.java @@ -11,7 +11,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link TakeTileItemMessage}. - * + * * @author Major */ public final class TakeTileItemMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/ThirdItemActionMessageDecoder.java b/src/org/apollo/net/release/r377/ThirdItemActionMessageDecoder.java index a4851fa5..5a9dfbf0 100644 --- a/src/org/apollo/net/release/r377/ThirdItemActionMessageDecoder.java +++ b/src/org/apollo/net/release/r377/ThirdItemActionMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link ThirdItemActionMessage}. - * + * * @author Graham */ public final class ThirdItemActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/ThirdItemOptionMessageDecoder.java b/src/org/apollo/net/release/r377/ThirdItemOptionMessageDecoder.java index 54e6a63e..66e2d3d8 100644 --- a/src/org/apollo/net/release/r377/ThirdItemOptionMessageDecoder.java +++ b/src/org/apollo/net/release/r377/ThirdItemOptionMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link ThirdItemOptionMessage}. - * + * * @author Chris Fletcher */ final class ThirdItemOptionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/ThirdNpcActionMessageDecoder.java b/src/org/apollo/net/release/r377/ThirdNpcActionMessageDecoder.java index f5b48c48..10fe0902 100644 --- a/src/org/apollo/net/release/r377/ThirdNpcActionMessageDecoder.java +++ b/src/org/apollo/net/release/r377/ThirdNpcActionMessageDecoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageDecoder; /** * The {@link MessageDecoder} for the {@link ThirdNpcActionMessage}. - * + * * @author Major */ public final class ThirdNpcActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/ThirdObjectActionMessageDecoder.java b/src/org/apollo/net/release/r377/ThirdObjectActionMessageDecoder.java index abf62ad5..e725fbba 100644 --- a/src/org/apollo/net/release/r377/ThirdObjectActionMessageDecoder.java +++ b/src/org/apollo/net/release/r377/ThirdObjectActionMessageDecoder.java @@ -11,7 +11,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link ThirdObjectActionMessage}. - * + * * @author Graham */ public final class ThirdObjectActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/ThirdPlayerActionMessageDecoder.java b/src/org/apollo/net/release/r377/ThirdPlayerActionMessageDecoder.java index 40a55528..2e8e3173 100644 --- a/src/org/apollo/net/release/r377/ThirdPlayerActionMessageDecoder.java +++ b/src/org/apollo/net/release/r377/ThirdPlayerActionMessageDecoder.java @@ -9,7 +9,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link ThirdPlayerActionMessage}. - * + * * @author Major */ public final class ThirdPlayerActionMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/release/r377/UpdateItemsMessageEncoder.java b/src/org/apollo/net/release/r377/UpdateItemsMessageEncoder.java index 7ef547b3..198de979 100644 --- a/src/org/apollo/net/release/r377/UpdateItemsMessageEncoder.java +++ b/src/org/apollo/net/release/r377/UpdateItemsMessageEncoder.java @@ -12,7 +12,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link UpdateItemsMessage}. - * + * * @author Graham */ public final class UpdateItemsMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/UpdateRunEnergyMessageEncoder.java b/src/org/apollo/net/release/r377/UpdateRunEnergyMessageEncoder.java index 977e9c02..7027b59d 100644 --- a/src/org/apollo/net/release/r377/UpdateRunEnergyMessageEncoder.java +++ b/src/org/apollo/net/release/r377/UpdateRunEnergyMessageEncoder.java @@ -8,7 +8,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link UpdateRunEnergyMessage} - * + * * @author Major */ public final class UpdateRunEnergyMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/UpdateSkillMessageEncoder.java b/src/org/apollo/net/release/r377/UpdateSkillMessageEncoder.java index 7cbf9437..039fd1b4 100644 --- a/src/org/apollo/net/release/r377/UpdateSkillMessageEncoder.java +++ b/src/org/apollo/net/release/r377/UpdateSkillMessageEncoder.java @@ -10,7 +10,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link UpdateSkillMessage}. - * + * * @author Graham */ public final class UpdateSkillMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/UpdateSlottedItemsMessageEncoder.java b/src/org/apollo/net/release/r377/UpdateSlottedItemsMessageEncoder.java index ae48477c..4ad2ebfb 100644 --- a/src/org/apollo/net/release/r377/UpdateSlottedItemsMessageEncoder.java +++ b/src/org/apollo/net/release/r377/UpdateSlottedItemsMessageEncoder.java @@ -11,7 +11,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link UpdateSlottedItemsMessage}. - * + * * @author Graham */ public final class UpdateSlottedItemsMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/UpdateTileItemMessageEncoder.java b/src/org/apollo/net/release/r377/UpdateTileItemMessageEncoder.java index 31eb114b..c6f697b2 100644 --- a/src/org/apollo/net/release/r377/UpdateTileItemMessageEncoder.java +++ b/src/org/apollo/net/release/r377/UpdateTileItemMessageEncoder.java @@ -8,7 +8,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link UpdateTileItemMessage}. - * + * * @author Major */ public final class UpdateTileItemMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/UpdateWeightMessageEncoder.java b/src/org/apollo/net/release/r377/UpdateWeightMessageEncoder.java index c2281ff1..5e2fe0b4 100644 --- a/src/org/apollo/net/release/r377/UpdateWeightMessageEncoder.java +++ b/src/org/apollo/net/release/r377/UpdateWeightMessageEncoder.java @@ -8,7 +8,7 @@ import org.apollo.net.release.MessageEncoder; /** * A {@link MessageEncoder} for the {@link UpdateWeightMessage}. - * + * * @author Major */ public final class UpdateWeightMessageEncoder extends MessageEncoder { diff --git a/src/org/apollo/net/release/r377/WalkMessageDecoder.java b/src/org/apollo/net/release/r377/WalkMessageDecoder.java index 8aed9b28..73eed8f9 100644 --- a/src/org/apollo/net/release/r377/WalkMessageDecoder.java +++ b/src/org/apollo/net/release/r377/WalkMessageDecoder.java @@ -11,7 +11,7 @@ import org.apollo.net.release.MessageDecoder; /** * A {@link MessageDecoder} for the {@link WalkMessage}. - * + * * @author Graham */ public final class WalkMessageDecoder extends MessageDecoder { diff --git a/src/org/apollo/net/session/GameSession.java b/src/org/apollo/net/session/GameSession.java index 05a487c9..e90e3678 100644 --- a/src/org/apollo/net/session/GameSession.java +++ b/src/org/apollo/net/session/GameSession.java @@ -20,7 +20,7 @@ import org.apollo.util.CollectionUtil; /** * A game session. - * + * * @author Graham */ public final class GameSession extends Session { @@ -47,7 +47,7 @@ public final class GameSession extends Session { /** * Creates a login session for the specified channel. - * + * * @param channel The channel. * @param context The server context. * @param player The player. @@ -65,7 +65,7 @@ public final class GameSession extends Session { /** * Encodes and dispatches the specified message. - * + * * @param message The message. */ public void dispatchMessage(Message message) { @@ -80,7 +80,7 @@ public final class GameSession extends Session { /** * Handles pending messages for this session. - * + * * @param chainSet The {@link MessageHandlerChainSet} */ public void handlePendingMessages(MessageHandlerChainSet chainSet) { @@ -95,7 +95,7 @@ public final class GameSession extends Session { /** * Handles a player saver response. - * + * * @param success A flag indicating if the save was successful. */ public void handlePlayerSaverResponse(boolean success) { diff --git a/src/org/apollo/net/session/LoginSession.java b/src/org/apollo/net/session/LoginSession.java index 59c4d463..55ef7f9f 100644 --- a/src/org/apollo/net/session/LoginSession.java +++ b/src/org/apollo/net/session/LoginSession.java @@ -27,7 +27,7 @@ import org.apollo.security.IsaacRandomPair; /** * A login session. - * + * * @author Graham */ public final class LoginSession extends Session { @@ -44,13 +44,13 @@ public final class LoginSession extends Session { /** * Creates a login session for the specified channel. - * + * * @param ctx The context of the {@link ApolloHandler}. * @param serverContext The server context. */ public LoginSession(ChannelHandlerContext ctx, ServerContext serverContext) { super(ctx.channel()); - this.channelContext = ctx; + channelContext = ctx; this.serverContext = serverContext; } @@ -61,7 +61,7 @@ public final class LoginSession extends Session { /** * Gets the release. - * + * * @return The release. */ public Release getRelease() { @@ -70,7 +70,7 @@ public final class LoginSession extends Session { /** * Handles a login request. - * + * * @param request The login request. */ private void handleLoginRequest(LoginRequest request) { @@ -80,7 +80,7 @@ public final class LoginSession extends Session { /** * Handles a response from the login service. - * + * * @param request The request this response corresponds to. * @param response The response. */ @@ -103,7 +103,7 @@ public final class LoginSession extends Session { optional = Optional.empty(); rights = 0; - status = (registration == RegistrationStatus.ALREADY_ONLINE) ? LoginConstants.STATUS_ACCOUNT_ONLINE : LoginConstants.STATUS_SERVER_FULL; + status = registration == RegistrationStatus.ALREADY_ONLINE ? LoginConstants.STATUS_ACCOUNT_ONLINE : LoginConstants.STATUS_SERVER_FULL; } } diff --git a/src/org/apollo/net/session/Session.java b/src/org/apollo/net/session/Session.java index 734b40e8..118078a3 100644 --- a/src/org/apollo/net/session/Session.java +++ b/src/org/apollo/net/session/Session.java @@ -5,7 +5,7 @@ import io.netty.channel.ChannelHandlerContext; /** * A session which is used as an attribute of a {@link ChannelHandlerContext} in Netty. - * + * * @author Graham */ public abstract class Session { @@ -17,7 +17,7 @@ public abstract class Session { /** * Creates a session for the specified channel. - * + * * @param channel The channel. */ public Session(Channel channel) { @@ -31,7 +31,7 @@ public abstract class Session { /** * Gets the channel. - * + * * @return The channel. */ protected final Channel getChannel() { @@ -40,7 +40,7 @@ public abstract class Session { /** * Processes a message received from the channel. - * + * * @param message The message. */ public abstract void messageReceived(Object message); diff --git a/src/org/apollo/net/session/UpdateSession.java b/src/org/apollo/net/session/UpdateSession.java index ace8d228..2cbfeb6c 100644 --- a/src/org/apollo/net/session/UpdateSession.java +++ b/src/org/apollo/net/session/UpdateSession.java @@ -11,7 +11,7 @@ import org.apollo.update.UpdateService; /** * An update session. - * + * * @author Graham */ public final class UpdateSession extends Session { @@ -23,7 +23,7 @@ public final class UpdateSession extends Session { /** * Creates an update session for the specified channel. - * + * * @param channel The channel. * @param context The server context. */ diff --git a/src/org/apollo/security/IsaacRandomPair.java b/src/org/apollo/security/IsaacRandomPair.java index c4d14196..a9c96d05 100644 --- a/src/org/apollo/security/IsaacRandomPair.java +++ b/src/org/apollo/security/IsaacRandomPair.java @@ -5,7 +5,7 @@ import net.burtleburtle.bob.rand.IsaacRandom; /** * A pair of two {@link IsaacRandom} random number generators used as a stream cipher. One takes the role of an encoder * for this endpoint, the other takes the role of a decoder for this endpoint. - * + * * @author Graham */ public final class IsaacRandomPair { @@ -22,7 +22,7 @@ public final class IsaacRandomPair { /** * Creates the pair of random number generators. - * + * * @param encodingRandom The random number generator used for encoding. * @param decodingRandom The random number generator used for decoding. */ @@ -33,7 +33,7 @@ public final class IsaacRandomPair { /** * Gets the random number generator used for decoding. - * + * * @return The random number generator used for decoding. */ public IsaacRandom getDecodingRandom() { @@ -42,7 +42,7 @@ public final class IsaacRandomPair { /** * Gets the random number generator used for encoding. - * + * * @return The random number generator used for encoding. */ public IsaacRandom getEncodingRandom() { diff --git a/src/org/apollo/security/PlayerCredentials.java b/src/org/apollo/security/PlayerCredentials.java index 80dd4fb5..f2cc07f4 100644 --- a/src/org/apollo/security/PlayerCredentials.java +++ b/src/org/apollo/security/PlayerCredentials.java @@ -4,7 +4,7 @@ import org.apollo.util.NameUtil; /** * Holds the credentials for a player. - * + * * @author Graham */ public final class PlayerCredentials { @@ -41,7 +41,7 @@ public final class PlayerCredentials { /** * Creates a new {@link PlayerCredentials} object with the specified name, password and uid. - * + * * @param username The player's username. * @param password The player's password. * @param usernameHash The hash of the player's username. @@ -59,7 +59,7 @@ public final class PlayerCredentials { /** * Gets the player's username encoded as a long. - * + * * @return The username as encoded by {@link NameUtil#encodeBase37(String)}. */ public long getEncodedUsername() { @@ -68,7 +68,7 @@ public final class PlayerCredentials { /** * Sets the player's password - * + * * @param password The player's new password */ public void setPassword(String password) { @@ -77,7 +77,7 @@ public final class PlayerCredentials { /** * Gets the player's password. - * + * * @return The player's password. */ public String getPassword() { @@ -86,7 +86,7 @@ public final class PlayerCredentials { /** * Gets the computer's uid. - * + * * @return The computer's uid. */ public int getUid() { @@ -95,7 +95,7 @@ public final class PlayerCredentials { /** * Gets the player's username. - * + * * @return The player's username. */ public String getUsername() { @@ -104,7 +104,7 @@ public final class PlayerCredentials { /** * Gets the username hash. - * + * * @return The username hash. */ public int getUsernameHash() { @@ -113,7 +113,7 @@ public final class PlayerCredentials { /** * Gets the Player's connecting host address. - * + * * @return The Player's host address, represented as a String. */ public String getHostAddress() { diff --git a/src/org/apollo/tools/EquipmentConstants.java b/src/org/apollo/tools/EquipmentConstants.java index dad280e9..cdd2cf52 100644 --- a/src/org/apollo/tools/EquipmentConstants.java +++ b/src/org/apollo/tools/EquipmentConstants.java @@ -2,7 +2,7 @@ package org.apollo.tools; /** * Contains equipment name constants. - * + * * @author Graham * @author Palidino76 */ diff --git a/src/org/apollo/tools/EquipmentUpdater.java b/src/org/apollo/tools/EquipmentUpdater.java index d1624fcf..621eaf44 100644 --- a/src/org/apollo/tools/EquipmentUpdater.java +++ b/src/org/apollo/tools/EquipmentUpdater.java @@ -13,7 +13,7 @@ import com.google.common.base.Preconditions; /** * A tool for updating the equipment data. - * + * * @author Graham * @author Palidino76 */ @@ -21,7 +21,7 @@ public final class EquipmentUpdater { /** * Gets the attack requirement. - * + * * @param definition The item definition. * @return The required level. */ @@ -230,7 +230,7 @@ public final class EquipmentUpdater { /** * Gets the defence requirement. - * + * * @param definition The item definition. * @return The required level. */ @@ -680,7 +680,7 @@ public final class EquipmentUpdater { /** * Gets the magic requirement. - * + * * @param definition The item definition. * @return The required level. */ @@ -787,7 +787,7 @@ public final class EquipmentUpdater { /** * Gets the ranged requirement. - * + * * @param definition The item. * @return The required level. */ @@ -949,7 +949,7 @@ public final class EquipmentUpdater { /** * Gets the strength requirement. - * + * * @param def The item. * @return The required level. */ @@ -981,7 +981,7 @@ public final class EquipmentUpdater { /** * Gets the weapon type. - * + * * @param definition The item. * @return The weapon type, or {@code -1} if it is not a weapon. */ @@ -1050,7 +1050,7 @@ public final class EquipmentUpdater { /** * Checks if the item is a full body item. - * + * * @param definition The item. * @return {@code true} if so, {@code false} otherwise. */ @@ -1069,7 +1069,7 @@ public final class EquipmentUpdater { /** * Checks if the item is a full hat item. - * + * * @param definition The item. * @return {@code true} if so, {@code false} otherwise. */ @@ -1088,7 +1088,7 @@ public final class EquipmentUpdater { /** * Checks if the item is a full mask item. - * + * * @param definition The item. * @return {@code true} if so, {@code false} otherwise. */ @@ -1107,7 +1107,7 @@ public final class EquipmentUpdater { /** * Checks if the item is two handed. - * + * * @param definition The item. * @return {@code true} if so, {@code false} otherwise. */ @@ -1161,7 +1161,7 @@ public final class EquipmentUpdater { /** * The entry point of the application. - * + * * @param args The command line arguments. * @throws Exception If an error occurs. */ diff --git a/src/org/apollo/tools/RsaKeyGenerator.java b/src/org/apollo/tools/RsaKeyGenerator.java index 403ccf82..d66157e7 100644 --- a/src/org/apollo/tools/RsaKeyGenerator.java +++ b/src/org/apollo/tools/RsaKeyGenerator.java @@ -19,7 +19,7 @@ public final class RsaKeyGenerator { /** * The entry point of the RsaKeyGenerator. - * + * * @param args The application arguments. */ public static void main(String[] args) { @@ -31,12 +31,11 @@ public final class RsaKeyGenerator { do { p = BigInteger.probablePrime(BIT_COUNT / 2, random); q = BigInteger.probablePrime(BIT_COUNT / 2, random); - phi = (p.subtract(BigInteger.ONE)).multiply(q.subtract(BigInteger.ONE)); + phi = p.subtract(BigInteger.ONE).multiply(q.subtract(BigInteger.ONE)); modulus = p.multiply(q); privateKey = publicKey.modInverse(phi); - } while (modulus.bitLength() != BIT_COUNT || privateKey.bitLength() != BIT_COUNT - || !phi.gcd(publicKey).equals(BigInteger.ONE)); + } while (modulus.bitLength() != BIT_COUNT || privateKey.bitLength() != BIT_COUNT || !phi.gcd(publicKey).equals(BigInteger.ONE)); System.out.println("modulus: " + modulus); System.out.println("public key: " + publicKey); diff --git a/src/org/apollo/update/ChannelRequest.java b/src/org/apollo/update/ChannelRequest.java index 0656c445..446b3f9a 100644 --- a/src/org/apollo/update/ChannelRequest.java +++ b/src/org/apollo/update/ChannelRequest.java @@ -4,7 +4,7 @@ import io.netty.channel.Channel; /** * A specialised request which contains a channel as well as the request object itself. - * + * * @author Graham * @param The type of request. */ @@ -22,7 +22,7 @@ public class ChannelRequest { /** * Creates a new channel request. - * + * * @param channel The channel. * @param request The request. */ @@ -33,7 +33,7 @@ public class ChannelRequest { /** * Gets the channel. - * + * * @return The channel. */ public Channel getChannel() { @@ -42,7 +42,7 @@ public class ChannelRequest { /** * Gets the request. - * + * * @return The request. */ public T getRequest() { diff --git a/src/org/apollo/update/HttpRequestWorker.java b/src/org/apollo/update/HttpRequestWorker.java index b57f41b1..21e6a246 100644 --- a/src/org/apollo/update/HttpRequestWorker.java +++ b/src/org/apollo/update/HttpRequestWorker.java @@ -27,7 +27,7 @@ import com.google.common.base.Charsets; /** * A worker which services HTTP requests. - * + * * @author Graham */ public final class HttpRequestWorker extends RequestWorker { @@ -49,7 +49,7 @@ public final class HttpRequestWorker extends RequestWorker { /** * Creates the JAGGRAB request worker. - * + * * @param dispatcher The dispatcher. * @param fs The file system. */ diff --git a/src/org/apollo/update/OnDemandRequestWorker.java b/src/org/apollo/update/OnDemandRequestWorker.java index a0dfc6e4..32a33c7f 100644 --- a/src/org/apollo/update/OnDemandRequestWorker.java +++ b/src/org/apollo/update/OnDemandRequestWorker.java @@ -13,7 +13,7 @@ import org.apollo.net.codec.update.OnDemandResponse; /** * A worker which services 'on-demand' requests. - * + * * @author Graham */ public final class OnDemandRequestWorker extends RequestWorker { @@ -25,7 +25,7 @@ public final class OnDemandRequestWorker extends RequestWorker The type of request. * @param

    The type of provider. @@ -30,7 +30,7 @@ public abstract class RequestWorker implements Runnable { /** * Creates the request worker with the specified file system. - * + * * @param dispatcher The update dispatcher. * @param provider The resource provider. */ @@ -41,7 +41,7 @@ public abstract class RequestWorker implements Runnable { /** * Gets the next request. - * + * * @param dispatcher The dispatcher. * @return The next request. * @throws InterruptedException If the thread is interrupted. @@ -77,7 +77,7 @@ public abstract class RequestWorker implements Runnable { /** * Services a request. - * + * * @param provider The resource provider. * @param channel The channel. * @param request The request to service. diff --git a/src/org/apollo/update/UpdateConstants.java b/src/org/apollo/update/UpdateConstants.java index b8b4c37f..8e9dffb1 100644 --- a/src/org/apollo/update/UpdateConstants.java +++ b/src/org/apollo/update/UpdateConstants.java @@ -2,7 +2,7 @@ package org.apollo.update; /** * Holds update-related constants. - * + * * @author Graham */ public final class UpdateConstants { diff --git a/src/org/apollo/update/UpdateDispatcher.java b/src/org/apollo/update/UpdateDispatcher.java index d46dfa7f..2baf4ee5 100644 --- a/src/org/apollo/update/UpdateDispatcher.java +++ b/src/org/apollo/update/UpdateDispatcher.java @@ -12,7 +12,7 @@ import org.apollo.net.codec.update.OnDemandRequest; /** * Dispatches update requests to worker threads. - * + * * @author Graham */ public final class UpdateDispatcher { @@ -39,7 +39,7 @@ public final class UpdateDispatcher { /** * Dispatches a HTTP request. - * + * * @param channel The channel. * @param request The request. */ @@ -52,7 +52,7 @@ public final class UpdateDispatcher { /** * Dispatches a JAGGRAB request. - * + * * @param channel The channel. * @param request The request. */ @@ -65,7 +65,7 @@ public final class UpdateDispatcher { /** * Dispatches an 'on-demand' request. - * + * * @param channel The channel. * @param request The request. */ @@ -78,7 +78,7 @@ public final class UpdateDispatcher { /** * Gets the next HTTP request from the queue, blocking if none are available. - * + * * @return The HTTP request. * @throws InterruptedException If the thread is interrupted. */ @@ -88,7 +88,7 @@ public final class UpdateDispatcher { /** * Gets the next JAGGRAB request from the queue, blocking if none are available. - * + * * @return The JAGGRAB request. * @throws InterruptedException If the thread is interrupted. */ @@ -98,7 +98,7 @@ public final class UpdateDispatcher { /** * Gets the next 'on-demand' request from the queue, blocking if none are available. - * + * * @return The 'on-demand' request. * @throws InterruptedException If the thread is interrupted. */ diff --git a/src/org/apollo/update/UpdateService.java b/src/org/apollo/update/UpdateService.java index 4957db11..bd67ae47 100644 --- a/src/org/apollo/update/UpdateService.java +++ b/src/org/apollo/update/UpdateService.java @@ -16,7 +16,7 @@ import org.apollo.game.model.World; /** * A class which services file requests. - * + * * @author Graham */ public final class UpdateService extends Service { @@ -53,7 +53,7 @@ public final class UpdateService extends Service { /** * Creates the UpdateService. - * + * * @param world The {@link World} the update service is for. */ public UpdateService(World world) { @@ -64,7 +64,7 @@ public final class UpdateService extends Service { /** * Gets the update dispatcher. - * + * * @return The update dispatcher. */ public UpdateDispatcher getDispatcher() { diff --git a/src/org/apollo/update/resource/CombinedResourceProvider.java b/src/org/apollo/update/resource/CombinedResourceProvider.java index 1395c55f..a90bb606 100644 --- a/src/org/apollo/update/resource/CombinedResourceProvider.java +++ b/src/org/apollo/update/resource/CombinedResourceProvider.java @@ -6,7 +6,7 @@ import java.util.Optional; /** * A resource provider composed of multiple resource providers. - * + * * @author Graham */ public final class CombinedResourceProvider implements ResourceProvider { @@ -18,7 +18,7 @@ public final class CombinedResourceProvider implements ResourceProvider { /** * Creates the combined resource providers. - * + * * @param providers The providers this provider delegates to. */ public CombinedResourceProvider(ResourceProvider... providers) { diff --git a/src/org/apollo/update/resource/HypertextResourceProvider.java b/src/org/apollo/update/resource/HypertextResourceProvider.java index 7dda56e9..d9622364 100644 --- a/src/org/apollo/update/resource/HypertextResourceProvider.java +++ b/src/org/apollo/update/resource/HypertextResourceProvider.java @@ -11,7 +11,7 @@ import java.util.Optional; /** * A {@link ResourceProvider} which provides additional hypertext resources. - * + * * @author Graham */ public final class HypertextResourceProvider implements ResourceProvider { @@ -23,7 +23,7 @@ public final class HypertextResourceProvider implements ResourceProvider { /** * Creates a new hypertext resource provider with the specified base directory. - * + * * @param base The base directory. */ public HypertextResourceProvider(Path base) { diff --git a/src/org/apollo/update/resource/ResourceProvider.java b/src/org/apollo/update/resource/ResourceProvider.java index dcb1e254..ecbb3ffd 100644 --- a/src/org/apollo/update/resource/ResourceProvider.java +++ b/src/org/apollo/update/resource/ResourceProvider.java @@ -6,14 +6,14 @@ import java.util.Optional; /** * A class which provides resources. - * + * * @author Graham */ public interface ResourceProvider { /** * Checks that this provider can fulfil a request to the specified resource. - * + * * @param path The path to the resource, e.g. {@code /crc}. * @return {@code true} if the provider can fulfil a request to the resource, {@code false} otherwise. * @throws IOException If an I/O error occurs. @@ -22,7 +22,7 @@ public interface ResourceProvider { /** * Gets the resource data, as a {@link ByteBuffer}, wrapped in an {@link Optional}. - * + * * @param path The path to the resource. * @return A {@code ByteBuffer} representation of a resource if it exists otherwise {@link Optional#empty()} is * returned. diff --git a/src/org/apollo/update/resource/VirtualResourceProvider.java b/src/org/apollo/update/resource/VirtualResourceProvider.java index 354d8927..b479850e 100644 --- a/src/org/apollo/update/resource/VirtualResourceProvider.java +++ b/src/org/apollo/update/resource/VirtualResourceProvider.java @@ -12,7 +12,7 @@ import org.apollo.fs.IndexedFileSystem; /** * A {@link ResourceProvider} which maps virtual resources (such as {@code /media}) to files in an * {@link IndexedFileSystem}. - * + * * @author Graham */ public final class VirtualResourceProvider implements ResourceProvider { diff --git a/src/org/apollo/util/BufferUtil.java b/src/org/apollo/util/BufferUtil.java index 4b4d4361..95892c72 100644 --- a/src/org/apollo/util/BufferUtil.java +++ b/src/org/apollo/util/BufferUtil.java @@ -8,14 +8,14 @@ import org.apollo.net.NetworkConstants; /** * A utility class which contains {@link ByteBuffer}-related utility methods. - * + * * @author Graham */ public final class BufferUtil { /** * Reads a 'smart' (either a {@code byte} or {@code short} depending on the value) from the specified buffer. - * + * * @param buffer The buffer. * @return The 'smart'. */ @@ -28,7 +28,7 @@ public final class BufferUtil { /** * Reads a string from the specified {@link ByteBuffer}. - * + * * @param buffer The buffer. * @return The string. */ @@ -43,7 +43,7 @@ public final class BufferUtil { /** * Reads a string from the specified {@link ByteBuf}. - * + * * @param buffer The buffer. * @return The string. */ diff --git a/src/org/apollo/util/CollectionUtil.java b/src/org/apollo/util/CollectionUtil.java index 9c1d17dc..39f1431e 100644 --- a/src/org/apollo/util/CollectionUtil.java +++ b/src/org/apollo/util/CollectionUtil.java @@ -8,7 +8,7 @@ import com.google.common.base.Preconditions; /** * A utility class containing helper methods for various {@link Collection} objects. - * + * * @author Ryley */ public final class CollectionUtil { @@ -16,7 +16,7 @@ public final class CollectionUtil { /** * Polls every element within the specified {@link Queue} and performs the specified {@link Consumer} event for each * element. - * + * * @param queue The Queue to poll each element for, may not be {@code null}. * @param consumer The Consumer event to execute for each polled element, may not be {@code null}. */ diff --git a/src/org/apollo/util/CompressionUtil.java b/src/org/apollo/util/CompressionUtil.java index 1ee5e909..e64a67f7 100644 --- a/src/org/apollo/util/CompressionUtil.java +++ b/src/org/apollo/util/CompressionUtil.java @@ -15,14 +15,14 @@ import org.apache.commons.compress.compressors.bzip2.BZip2CompressorOutputStream /** * A utility class for performing compression/decompression. - * + * * @author Graham */ public final class CompressionUtil { /** * Bzip2s the specified array, removing the header. - * + * * @param uncompressed The uncompressed array. * @return The compressed array. * @throws IOException If there is an error compressing the array. @@ -42,7 +42,7 @@ public final class CompressionUtil { /** * Gzips the specified array. - * + * * @param uncompressed The uncompressed array. * @return The compressed array. * @throws IOException If there is an error compressing the array. @@ -58,7 +58,7 @@ public final class CompressionUtil { /** * Debzip2s the compressed array and places the result into the decompressed array. - * + * * @param compressed The compressed array, without the header. * @param decompressed The decompressed array. * @throws IOException If there is an error decompressing the array. @@ -78,7 +78,7 @@ public final class CompressionUtil { /** * Degzips the compressed array and places the results into the decompressed array. - * + * * @param compressed The compressed array. * @param decompressed The decompressed array. * @throws IOException If an I/O error occurs. @@ -91,7 +91,7 @@ public final class CompressionUtil { /** * Degzips the compressed {@link ByteBuffer} and returns the result as a byte array. - * + * * @param compressed The compressed buffer. * @return The decompressed array. * @throws IOException If there is an error decompressing the buffer. diff --git a/src/org/apollo/util/EnumerationUtil.java b/src/org/apollo/util/EnumerationUtil.java index eed4b348..6c75b51c 100644 --- a/src/org/apollo/util/EnumerationUtil.java +++ b/src/org/apollo/util/EnumerationUtil.java @@ -6,14 +6,14 @@ import java.util.Iterator; /** * A utility class for wrapping old {@link Enumeration} objects inside an {@link Iterator} to allow for greater * compatibility. - * + * * @author Graham */ public final class EnumerationUtil { /** * Returns an {@link Iterator} which wraps around the specified {@link Enumeration}. - * + * * @param enumeration The {@link Enumeration}. * @return An {@link Iterator}. */ diff --git a/src/org/apollo/util/LanguageUtil.java b/src/org/apollo/util/LanguageUtil.java index 83c3dcb8..666cd935 100644 --- a/src/org/apollo/util/LanguageUtil.java +++ b/src/org/apollo/util/LanguageUtil.java @@ -2,7 +2,7 @@ package org.apollo.util; /** * Contains language-related utility methods. - * + * * @author Graham * @author Major */ @@ -10,7 +10,7 @@ public final class LanguageUtil { /** * Returns whether or not the each letter in the specified String is upper case (i.e. digits etc are ignored). - * + * * @param string The string. * @return {@code true} if no letters in the specified String are lower case, otherwise {@code false}. */ @@ -26,7 +26,7 @@ public final class LanguageUtil { /** * Gets the indefinite article of the specified String. - * + * * @param string The String. * @return The indefinite article. */ diff --git a/src/org/apollo/util/MobRepository.java b/src/org/apollo/util/MobRepository.java index f8df976f..bfd59657 100644 --- a/src/org/apollo/util/MobRepository.java +++ b/src/org/apollo/util/MobRepository.java @@ -8,7 +8,7 @@ import com.google.common.base.Preconditions; /** * A {@link MobRepository} is a repository of {@link Mob}s that are currently active in the game world. - * + * * @author Graham * @author Ryley * @param The type of Mob. @@ -17,7 +17,7 @@ public final class MobRepository implements Iterable { /** * The {@link Iterator} implementation for the MobRepository. - * + * * @author Graham * @author Ryley */ @@ -40,7 +40,7 @@ public final class MobRepository implements Iterable { /** * Constructs a new {@link MobRepositoryIterator} with the specified MobRepository. - * + * * @param repository The repository of Mob's this Iterator iterates over. */ private MobRepositoryIterator(MobRepository repository) { @@ -86,7 +86,7 @@ public final class MobRepository implements Iterable { /** * Creates a new Mob repository with the specified capacity. - * + * * @param capacity The maximum number of Mobs that can be present in the repository. */ public MobRepository(int capacity) { @@ -95,7 +95,7 @@ public final class MobRepository implements Iterable { /** * Adds a Mob to the repository. - * + * * @param mob The Mob to add. * @return {@code true} if the Mob was added, {@code false} if the size has reached the capacity of this repository. */ @@ -121,7 +121,7 @@ public final class MobRepository implements Iterable { /** * Gets the capacity of this repository. - * + * * @return The maximum size of this repository. */ public int capacity() { @@ -150,7 +150,7 @@ public final class MobRepository implements Iterable { /** * Removes a Mob from the repository. - * + * * @param mob The Mob to remove. * @return {@code true} if the Mob was removed, {@code false} if not. */ @@ -161,7 +161,7 @@ public final class MobRepository implements Iterable { /** * Removes a Mob from the repository by the specified index. - * + * * @param index The index of the Mob to remove. * @return {@code true} if the Mob at the specified index was removed otherwise {@code false}. */ @@ -180,7 +180,7 @@ public final class MobRepository implements Iterable { /** * Gets the size of this repository. - * + * * @return The number of Mobs in this repository. */ public int size() { diff --git a/src/org/apollo/util/NameUtil.java b/src/org/apollo/util/NameUtil.java index e7f1f0d4..8056a0ed 100644 --- a/src/org/apollo/util/NameUtil.java +++ b/src/org/apollo/util/NameUtil.java @@ -4,7 +4,7 @@ import com.google.common.base.Preconditions; /** * A class which contains name-related utility methods. - * + * * @author Graham */ public final class NameUtil { @@ -19,7 +19,7 @@ public final class NameUtil { /** * Converts a long to a player name. - * + * * @param l The long. * @return The player name. */ @@ -36,7 +36,7 @@ public final class NameUtil { /** * Converts a player name to a long. - * + * * @param name The player name. * @return The long. */ diff --git a/src/org/apollo/util/Point.java b/src/org/apollo/util/Point.java index 3938d054..f4810b43 100644 --- a/src/org/apollo/util/Point.java +++ b/src/org/apollo/util/Point.java @@ -2,7 +2,7 @@ package org.apollo.util; /** * Represents a point on a 2-dimensional Cartesian plane. - * + * * @author Major */ public final class Point { @@ -19,7 +19,7 @@ public final class Point { /** * Creates a new point with the specified coordinates. - * + * * @param x The x coordinate. * @param y The y coordinate. */ @@ -30,7 +30,7 @@ public final class Point { /** * Gets the x coordinate of this point. - * + * * @return The x coordinate. */ public int getX() { @@ -39,7 +39,7 @@ public final class Point { /** * Gets the y coordinate of this point. - * + * * @return The y coordinate. */ public int getY() { diff --git a/src/org/apollo/util/StatefulFrameDecoder.java b/src/org/apollo/util/StatefulFrameDecoder.java index 2e3df6d4..8d3aeda8 100644 --- a/src/org/apollo/util/StatefulFrameDecoder.java +++ b/src/org/apollo/util/StatefulFrameDecoder.java @@ -10,14 +10,14 @@ import java.util.Objects; /** * A stateful implementation of a {@link ByteToMessageDecoder} which may be extended and used by other classes. The * current state is tracked by this class and is a user-specified enumeration. - * + * * The state may be changed by calling the {@link StatefulFrameDecoder#setState} method. - * + * * The current state is supplied as a parameter in the {@link StatefulFrameDecoder#decode} and * {@link StatefulFrameDecoder#decodeLast} methods. - * + * * This class is not thread safe: it is recommended that the state is only set in the decode methods overridden. - * + * * @author Graham * @param The state enumeration. */ @@ -30,7 +30,7 @@ public abstract class StatefulFrameDecoder> extends ByteToMess /** * Creates the stateful frame decoder with the specified initial state. - * + * * @param state The initial state. * @throws NullPointerException If the state is {@code null}. */ @@ -40,7 +40,7 @@ public abstract class StatefulFrameDecoder> extends ByteToMess /** * Sets a new state. - * + * * @param state The new state. * @throws NullPointerException If the state is {@code null}. */ @@ -55,7 +55,7 @@ public abstract class StatefulFrameDecoder> extends ByteToMess /** * Decodes the received packets into a frame. - * + * * @param ctx The current context of this handler. * @param in The cumulative buffer, which may contain zero or more bytes. * @param out The {@link List} of objects to pass forward through the pipeline. diff --git a/src/org/apollo/util/StreamUtil.java b/src/org/apollo/util/StreamUtil.java index d32bff43..685e9bce 100644 --- a/src/org/apollo/util/StreamUtil.java +++ b/src/org/apollo/util/StreamUtil.java @@ -6,14 +6,14 @@ import java.io.OutputStream; /** * A class which contains {@link InputStream}- and {@link OutputStream}-related utility methods. - * + * * @author Graham */ public final class StreamUtil { /** * Reads a string from the specified input stream. - * + * * @param is The input stream. * @return The string. * @throws IOException If an I/O error occurs. @@ -29,7 +29,7 @@ public final class StreamUtil { /** * Writes a string to the specified output stream. - * + * * @param os The output stream. * @param str The string. * @throws IOException If an I/O error occurs. diff --git a/src/org/apollo/util/plugin/DependencyException.java b/src/org/apollo/util/plugin/DependencyException.java index 8528356b..2b3a6afa 100644 --- a/src/org/apollo/util/plugin/DependencyException.java +++ b/src/org/apollo/util/plugin/DependencyException.java @@ -2,7 +2,7 @@ package org.apollo.util.plugin; /** * An {@link Exception} thrown when a dependency cannot be resolved, or when there is a circular dependency. - * + * * @author Graham */ public final class DependencyException extends Exception { @@ -14,7 +14,7 @@ public final class DependencyException extends Exception { /** * Creates the dependency exception. - * + * * @param message The message describing what happened. */ public DependencyException(String message) { diff --git a/src/org/apollo/util/plugin/PluginContext.java b/src/org/apollo/util/plugin/PluginContext.java index 7ec9096b..535528f9 100644 --- a/src/org/apollo/util/plugin/PluginContext.java +++ b/src/org/apollo/util/plugin/PluginContext.java @@ -10,7 +10,7 @@ import org.apollo.game.message.MessageHandlerChainSet; /** * The {@link PluginContext} contains methods a plugin can use to interface with the server, for example, by adding * {@link MessageHandler}s to {@link MessageHandlerChain}s. - * + * * @author Graham * @author Major */ @@ -23,7 +23,7 @@ public final class PluginContext { /** * Creates the PluginContext. - * + * * @param context The {@link ServerContext}. */ public PluginContext(ServerContext context) { @@ -32,7 +32,7 @@ public final class PluginContext { /** * Adds a {@link MessageHandler} to the {@link MessageHandlerChainSet}. - * + * * @param message The message. * @param handler The handler. */ diff --git a/src/org/apollo/util/plugin/PluginEnvironment.java b/src/org/apollo/util/plugin/PluginEnvironment.java index 695ca733..32f797f8 100644 --- a/src/org/apollo/util/plugin/PluginEnvironment.java +++ b/src/org/apollo/util/plugin/PluginEnvironment.java @@ -4,14 +4,14 @@ import java.io.InputStream; /** * Represents some sort of environment that plugins could be executed in, e.g. {@code javax.script} or Jython. - * + * * @author Graham */ public interface PluginEnvironment { /** * Parses the input stream. - * + * * @param is The input stream. * @param name The name of the file. */ @@ -19,7 +19,7 @@ public interface PluginEnvironment { /** * Sets the context for this environment. - * + * * @param context The context. */ public void setContext(PluginContext context); diff --git a/src/org/apollo/util/plugin/PluginManager.java b/src/org/apollo/util/plugin/PluginManager.java index 5175a5fb..7d4acaa7 100644 --- a/src/org/apollo/util/plugin/PluginManager.java +++ b/src/org/apollo/util/plugin/PluginManager.java @@ -21,7 +21,7 @@ import org.xml.sax.SAXException; /** * A class which manages plugins. - * + * * @author Graham */ public final class PluginManager { @@ -29,7 +29,7 @@ public final class PluginManager { /** * A set of all author names. */ - private SortedSet authors = new TreeSet<>(); + private final SortedSet authors = new TreeSet<>(); /** * The plugin context. @@ -43,7 +43,7 @@ public final class PluginManager { /** * Creates the PluginManager. - * + * * @param world The {@link World} the PluginManager is for. * @param context The PluginContext. */ @@ -55,7 +55,7 @@ public final class PluginManager { /** * Creates a plugin map from a collection. - * + * * @param plugins The plugin collection. * @return The plugin map. */ @@ -66,7 +66,7 @@ public final class PluginManager { /** * Finds plugins and loads their meta data. - * + * * @return A collection of plugin meta data objects. * @throws IOException If an I/O error occurs. * @throws SAXException If a SAX error occurs. @@ -77,9 +77,9 @@ public final class PluginManager { /** * Finds plugins and loads their meta data. - * + * * @param dir The directory to search - * + * * @return A collection of plugin meta data objects. * @throws IOException If an I/O error occurs. * @throws SAXException If a SAX error occurs. @@ -108,7 +108,7 @@ public final class PluginManager { /** * Creates an unmodifiable {@link Set} containing the authors. - * + * * @return The set. */ public Set getAuthors() { @@ -137,7 +137,7 @@ public final class PluginManager { /** * Starts the plugin system by finding and loading all the plugins. - * + * * @throws SAXException If a SAX error occurs. * @throws IOException If an I/O error occurs. * @throws DependencyException If a dependency could not be resolved. @@ -156,7 +156,7 @@ public final class PluginManager { /** * Starts a specific plugin. - * + * * @param env The environment. * @param plugin The plugin. * @param plugins The plugin map. @@ -164,8 +164,7 @@ public final class PluginManager { * @throws DependencyException If a dependency error occurs. * @throws IOException If an I/O error occurs. */ - private void start(PluginEnvironment env, PluginMetaData plugin, Map plugins, - Set started) throws DependencyException, IOException { + private void start(PluginEnvironment env, PluginMetaData plugin, Map plugins, Set started) throws DependencyException, IOException { // TODO check for cyclic dependencies! this way just won't cut it, we need an exception if (started.contains(plugin)) { return; diff --git a/src/org/apollo/util/plugin/PluginMetaData.java b/src/org/apollo/util/plugin/PluginMetaData.java index 24f9899f..11031f33 100644 --- a/src/org/apollo/util/plugin/PluginMetaData.java +++ b/src/org/apollo/util/plugin/PluginMetaData.java @@ -4,7 +4,7 @@ import java.io.File; /** * Contains attributes which describe a plugin. - * + * * @author Graham */ public final class PluginMetaData { @@ -51,7 +51,7 @@ public final class PluginMetaData { /** * Creates the plugin meta data. - * + * * @param id The plugin's id. * @param base The plugin's base folder. * @param name The plugin's name. @@ -74,7 +74,7 @@ public final class PluginMetaData { /** * Gets the plugin's authors. - * + * * @return The plugin's authors. */ public String[] getAuthors() { @@ -83,7 +83,7 @@ public final class PluginMetaData { /** * Gets the plugin's dependencies. - * + * * @return The plugin's dependencies. */ public String[] getDependencies() { @@ -92,7 +92,7 @@ public final class PluginMetaData { /** * Gets the plugin's description. - * + * * @return The plugin's description. */ public String getDescription() { @@ -101,7 +101,7 @@ public final class PluginMetaData { /** * Gets the plugin's id. - * + * * @return The plugin's id. */ public String getId() { @@ -110,7 +110,7 @@ public final class PluginMetaData { /** * Gets the plugin's name. - * + * * @return The plugin's name. */ public String getName() { @@ -119,7 +119,7 @@ public final class PluginMetaData { /** * Gets the plugin's scripts. - * + * * @return The plugin's scripts. */ public String[] getScripts() { @@ -128,7 +128,7 @@ public final class PluginMetaData { /** * Gets the plugin's version. - * + * * @return The plugin's version. */ public double getVersion() { @@ -137,7 +137,7 @@ public final class PluginMetaData { /** * Gets the plugin's base folder. - * + * * @return The plugin's base folder (where plugin.xml is) */ public File getBase() { diff --git a/src/org/apollo/util/plugin/RubyPluginEnvironment.java b/src/org/apollo/util/plugin/RubyPluginEnvironment.java index 59133ee6..215d0223 100644 --- a/src/org/apollo/util/plugin/RubyPluginEnvironment.java +++ b/src/org/apollo/util/plugin/RubyPluginEnvironment.java @@ -10,7 +10,7 @@ import org.jruby.embed.ScriptingContainer; /** * A {@link PluginEnvironment} which uses Ruby. - * + * * @author Graham */ public final class RubyPluginEnvironment implements PluginEnvironment { @@ -27,7 +27,7 @@ public final class RubyPluginEnvironment implements PluginEnvironment { /** * Creates and bootstraps the Ruby plugin environment. - * + * * @param world The {@link World} this RubyPluginEnvironment is for. * @throws IOException If an I/O error occurs during bootstrapping. */ @@ -48,7 +48,7 @@ public final class RubyPluginEnvironment implements PluginEnvironment { /** * Parses the bootstrapper. - * + * * @throws IOException If an I/O error occurs. */ private void parseBootstrapper() throws IOException { diff --git a/src/org/apollo/util/xml/XmlNode.java b/src/org/apollo/util/xml/XmlNode.java index 670961c1..cadddcfa 100644 --- a/src/org/apollo/util/xml/XmlNode.java +++ b/src/org/apollo/util/xml/XmlNode.java @@ -13,7 +13,7 @@ import java.util.Set; /** * A class which represents a single node in the DOM tree, maintaining information about its children, attributes, value * and name. - * + * * @author Graham */ public final class XmlNode implements Iterable { @@ -40,7 +40,7 @@ public final class XmlNode implements Iterable { /** * Creates a new {@link XmlNode} with the specified name. - * + * * @param name The name of this node. */ public XmlNode(String name) { @@ -49,7 +49,7 @@ public final class XmlNode implements Iterable { /** * Adds a child {@link XmlNode}. - * + * * @param child The child to add. */ public void addChild(XmlNode child) { @@ -58,7 +58,7 @@ public final class XmlNode implements Iterable { /** * Checks if an attribute with the specified name exists. - * + * * @param name The attribute's name. * @return {@code true} if an attribute with that name exists, {@code false} otherwise. */ @@ -68,7 +68,7 @@ public final class XmlNode implements Iterable { /** * Gets an attribute by it's name. - * + * * @param name The name of the attribute. * @return The attribute's value, or {@code null} if it doesn't exist. */ @@ -78,7 +78,7 @@ public final class XmlNode implements Iterable { /** * Gets the attribute count. - * + * * @return The number of attributes. */ public int getAttributeCount() { @@ -87,7 +87,7 @@ public final class XmlNode implements Iterable { /** * Gets a {@link Set} of attribute names. - * + * * @return The set of names. */ public Set getAttributeNames() { @@ -96,7 +96,7 @@ public final class XmlNode implements Iterable { /** * Gets a {@link Set} of attribute map entries. - * + * * @return The set of entries. */ public Set> getAttributes() { @@ -105,7 +105,7 @@ public final class XmlNode implements Iterable { /** * Gets the first child with the specified name. - * + * * @param name The name of the child. * @return The {@link XmlNode} if a child was found with a matching name, {@code null} otherwise. */ @@ -120,7 +120,7 @@ public final class XmlNode implements Iterable { /** * Gets the child count. - * + * * @return The number of child {@link XmlNode}s. */ public int getChildCount() { @@ -129,7 +129,7 @@ public final class XmlNode implements Iterable { /** * Gets a {@link Collection} of child {@link XmlNode}s. - * + * * @return The collection. */ public Collection getChildren() { @@ -138,7 +138,7 @@ public final class XmlNode implements Iterable { /** * Gets the name of this node. - * + * * @return The name of this node. */ public String getName() { @@ -147,7 +147,7 @@ public final class XmlNode implements Iterable { /** * Gets the value of this node. - * + * * @return The value of this node, or {@code null} if it has no value. */ public String getValue() { @@ -165,7 +165,7 @@ public final class XmlNode implements Iterable { /** * Checks if this node has a value. - * + * * @return {@code true} if so, {@code false} if not. */ public boolean hasValue() { @@ -193,7 +193,7 @@ public final class XmlNode implements Iterable { /** * Removes an attribute. - * + * * @param name The name of the attribute. */ public void removeAttribute(String name) { @@ -202,7 +202,7 @@ public final class XmlNode implements Iterable { /** * Removes a child {@link XmlNode}. - * + * * @param child The child to remove. */ public void removeChild(XmlNode child) { @@ -218,7 +218,7 @@ public final class XmlNode implements Iterable { /** * Adds an attribute. It will overwrite an existing attribute if it exists. - * + * * @param name The name of the attribute. * @param value The value of the attribute. */ @@ -228,7 +228,7 @@ public final class XmlNode implements Iterable { /** * Sets the name of this node. - * + * * @param name The name of this node. */ public void setName(String name) { @@ -237,7 +237,7 @@ public final class XmlNode implements Iterable { /** * Sets the value of this node. - * + * * @param value The value of this node. */ public void setValue(String value) { diff --git a/src/org/apollo/util/xml/XmlParser.java b/src/org/apollo/util/xml/XmlParser.java index ad236c56..3ed8e850 100644 --- a/src/org/apollo/util/xml/XmlParser.java +++ b/src/org/apollo/util/xml/XmlParser.java @@ -14,14 +14,14 @@ import org.xml.sax.helpers.XMLReaderFactory; /** * A simple XML parser that uses the internal {@link org.xml.sax} API to create a tree of {@link XmlNode} objects. - * + * * @author Graham */ public final class XmlParser { /** * A class which handles SAX events. - * + * * @author Graham */ private final class XmlHandler extends DefaultHandler { @@ -74,7 +74,7 @@ public final class XmlParser { /** * The stack of nodes, used when traversing the document and going through child nodes. */ - private Stack nodeStack = new Stack<>(); + private final Stack nodeStack = new Stack<>(); /** * The current root node. @@ -88,7 +88,7 @@ public final class XmlParser { /** * Creates the XML parser. - * + * * @throws SAXException If a SAX error occurs. */ public XmlParser() throws SAXException { @@ -109,7 +109,7 @@ public final class XmlParser { /** * Parses XML data from the {@link InputSource}. - * + * * @param source The {@link InputSource}. * @return The root {@link XmlNode}. * @throws IOException If an I/O error occurs. @@ -126,7 +126,7 @@ public final class XmlParser { /** * Parses XML data from the given {@link InputStream}. - * + * * @param is The {@link InputStream}. * @return The root {@link XmlNode}. * @throws IOException If an I/O error occurs. @@ -140,7 +140,7 @@ public final class XmlParser { /** * Parses XML data from the given {@link Reader}. - * + * * @param reader The {@link Reader}. * @return The root {@link XmlNode}. * @throws IOException If an I/O error occurs. From b323a7625ba8e9bbb21bbb2f0a748c6d03cc1908 Mon Sep 17 00:00:00 2001 From: atomicint Date: Thu, 9 Apr 2015 17:17:32 -0400 Subject: [PATCH 06/18] Remove irrelevant documentation from MopPositionUpdateEvent --- .../apollo/game/model/event/impl/MobPositionUpdateEvent.java | 3 --- 1 file changed, 3 deletions(-) diff --git a/src/org/apollo/game/model/event/impl/MobPositionUpdateEvent.java b/src/org/apollo/game/model/event/impl/MobPositionUpdateEvent.java index 791a23e2..2e17704c 100644 --- a/src/org/apollo/game/model/event/impl/MobPositionUpdateEvent.java +++ b/src/org/apollo/game/model/event/impl/MobPositionUpdateEvent.java @@ -6,9 +6,6 @@ import org.apollo.game.model.event.Event; /** * An {@link Event} created when a Mob's Position is being updated. - *

    - * This Event intentionally ignores the result of execution - it should not be possible for a plugin to prevent this - * Event from happening, only to listen for it. * * @author Major */ From 84373635a1f414069777f77a531b7343cfa358a0 Mon Sep 17 00:00:00 2001 From: Steve Date: Fri, 10 Apr 2015 07:00:36 -0400 Subject: [PATCH 07/18] Fix the re-addition of StaticObjects to the game world. --- src/org/apollo/game/model/World.java | 21 +- src/org/apollo/game/model/area/Region.java | 514 +++++++++++---------- 2 files changed, 273 insertions(+), 262 deletions(-) diff --git a/src/org/apollo/game/model/World.java b/src/org/apollo/game/model/World.java index e74d0fbc..ba0a0881 100644 --- a/src/org/apollo/game/model/World.java +++ b/src/org/apollo/game/model/World.java @@ -1,13 +1,6 @@ package org.apollo.game.model; -import java.io.BufferedInputStream; -import java.io.FileInputStream; -import java.io.InputStream; -import java.util.Arrays; -import java.util.HashMap; -import java.util.Map; -import java.util.logging.Logger; - +import com.google.common.base.Preconditions; import org.apollo.Service; import org.apollo.fs.IndexedFileSystem; import org.apollo.fs.decoder.GameObjectDecoder; @@ -37,7 +30,13 @@ import org.apollo.util.MobRepository; import org.apollo.util.NameUtil; import org.apollo.util.plugin.PluginManager; -import com.google.common.base.Preconditions; +import java.io.BufferedInputStream; +import java.io.FileInputStream; +import java.io.InputStream; +import java.util.Arrays; +import java.util.HashMap; +import java.util.Map; +import java.util.logging.Logger; /** * The world class is a singleton which contains objects like the {@link MobRepository} for players and NPCs. It should @@ -385,12 +384,12 @@ public final class World { } /** - * Adds entities to regions in the {@link RegionRepository}. + * Adds entities to regions in the {@link RegionRepository}. By default, we do not notify listeners. * * @param entities The entities. */ private void placeEntities(Entity... entities) { - Arrays.stream(entities).forEach(entity -> regions.fromPosition(entity.getPosition()).addEntity(entity)); + Arrays.stream(entities).forEach(entity -> regions.fromPosition(entity.getPosition()).addEntity(entity, false)); } } \ No newline at end of file diff --git a/src/org/apollo/game/model/area/Region.java b/src/org/apollo/game/model/area/Region.java index e5caff4b..838e560e 100644 --- a/src/org/apollo/game/model/area/Region.java +++ b/src/org/apollo/game/model/area/Region.java @@ -1,15 +1,9 @@ package org.apollo.game.model.area; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Collections; -import java.util.HashMap; -import java.util.HashSet; -import java.util.List; -import java.util.Map; -import java.util.Set; -import java.util.stream.Collectors; - +import com.google.common.base.MoreObjects; +import com.google.common.base.Preconditions; +import com.google.common.collect.ImmutableList; +import com.google.common.collect.ImmutableSet; import org.apollo.game.message.impl.RegionUpdateMessage; import org.apollo.game.model.Direction; import org.apollo.game.model.Position; @@ -19,292 +13,310 @@ import org.apollo.game.model.entity.Entity; import org.apollo.game.model.entity.Entity.EntityType; import org.apollo.game.model.entity.obj.GameObject; -import com.google.common.base.MoreObjects; -import com.google.common.base.Preconditions; -import com.google.common.collect.ImmutableList; -import com.google.common.collect.ImmutableSet; +import java.util.*; +import java.util.stream.Collectors; /** * An 8x8 area of the map. - * + * * @author Major */ public final class Region { - /** - * A {@link RegionListener} for {@link UpdateOperation}s. - * - * @author Major - */ - private static final class UpdateRegionListener implements RegionListener { + /** + * A {@link RegionListener} for {@link UpdateOperation}s. + * + * @author Major + */ + private static final class UpdateRegionListener implements RegionListener { - @Override - public void execute(Region region, Entity entity, EntityUpdateType update) { - EntityType type = entity.getEntityType(); - if (type != EntityType.PLAYER && type != EntityType.NPC && (type != EntityType.STATIC_OBJECT || update == EntityUpdateType.REMOVE)) { - region.record(entity, update); - } - } + @Override + public void execute(Region region, Entity entity, EntityUpdateType update) { + EntityType type = entity.getEntityType(); + if (type != EntityType.PLAYER && type != EntityType.NPC) { + region.record(entity, update); + } + } - } + } - /** - * The width and length of a Region, in tiles. - */ - public static final int SIZE = 8; + /** + * The width and length of a Region, in tiles. + */ + public static final int SIZE = 8; - static final long start = System.currentTimeMillis(); + static final long start = System.currentTimeMillis(); - /** - * The default size of newly-created sets, to reduce memory usage. - */ - private static final int DEFAULT_SET_SIZE = 2; + /** + * The default size of newly-created sets, to reduce memory usage. + */ + private static final int DEFAULT_SET_SIZE = 2; - /** - * The RegionCoordinates of this Region. - */ - private final RegionCoordinates coordinates; + /** + * The RegionCoordinates of this Region. + */ + private final RegionCoordinates coordinates; - /** - * The Map of Positions to Entities in that Position. - */ - private final Map> entities = new HashMap<>(); + /** + * The Map of Positions to Entities in that Position. + */ + private final Map> entities = new HashMap<>(); - /** - * A List of RegionListeners registered to this Region. - */ - private final List listeners = new ArrayList<>(); + /** + * A List of RegionListeners registered to this Region. + */ + private final List listeners = new ArrayList<>(); - /** - * The CollisionMatrix. - */ - private final CollisionMatrix[] matrices = CollisionMatrix.createMatrices(Position.HEIGHT_LEVELS, SIZE, SIZE); + /** + * The CollisionMatrix. + */ + private final CollisionMatrix[] matrices = CollisionMatrix.createMatrices(Position.HEIGHT_LEVELS, SIZE, SIZE); - /** - * The Set containing RegionUpdateMessages which can be sent to add every non-Mob Entity in this Region. - */ - private final List> snapshots = new ArrayList<>(Position.HEIGHT_LEVELS); + /** + * The Set containing RegionUpdateMessages which can be sent to add every non-Mob Entity in this Region. + */ + private final List> snapshots = new ArrayList<>(Position.HEIGHT_LEVELS); - /** - * The Set containing UpdateOperations. - */ - private final List> updates = new ArrayList<>(Position.HEIGHT_LEVELS); + /** + * The Set containing UpdateOperations. + */ + private final List> updates = new ArrayList<>(Position.HEIGHT_LEVELS); - /** - * Creates a new Region. - * - * @param x The x coordinate of the Region. - * @param y The y coordinate of the Region. - */ - public Region(int x, int y) { - this(new RegionCoordinates(x, y)); - } + /** + * Creates a new Region. + * + * @param x The x coordinate of the Region. + * @param y The y coordinate of the Region. + */ + public Region(int x, int y) { + this(new RegionCoordinates(x, y)); + } - /** - * Creates a new Region with the specified {@link RegionCoordinates}. - * - * @param coordinates The coordinates. - */ - public Region(RegionCoordinates coordinates) { - this.coordinates = coordinates; - listeners.add(new UpdateRegionListener()); + /** + * Creates a new Region with the specified {@link RegionCoordinates}. + * + * @param coordinates The coordinates. + */ + public Region(RegionCoordinates coordinates) { + this.coordinates = coordinates; + listeners.add(new UpdateRegionListener()); - for (int height = 0; height < Position.HEIGHT_LEVELS; height++) { - snapshots.add(new ArrayList<>()); - updates.add(new ArrayList<>(DEFAULT_SET_SIZE)); - } - } + for (int height = 0; height < Position.HEIGHT_LEVELS; height++) { + snapshots.add(new ArrayList<>()); + updates.add(new ArrayList<>(DEFAULT_SET_SIZE)); + } + } - /** - * Adds a {@link Entity} from to Region. Note that this does not spawn the Entity, or do any other action other than - * register it to this Region. - * - * @param entity The Entity. - * @throws IllegalArgumentException If the Entity does not belong in this Region. - */ - public void addEntity(Entity entity) { - Position position = entity.getPosition(); - checkPosition(position); + /** + * Adds a {@link Entity} to the Region. Note that this does not spawn the Entity, or do any other action other than + * register it to this Region. + * + * @param entity The Entity. + * @param notify A flag indicating whether the {@link RegionListener}s for this Region should be notified. + * @throws IllegalArgumentException If the Entity does not belong in this Region. + */ + public void addEntity(Entity entity, boolean notify) { + Position position = entity.getPosition(); + checkPosition(position); - Set local = entities.computeIfAbsent(position, key -> new HashSet<>(DEFAULT_SET_SIZE)); - local.add(entity); + Set local = entities.computeIfAbsent(position, key -> new HashSet<>(DEFAULT_SET_SIZE)); + local.add(entity); - if ((System.currentTimeMillis() - start) / 1000 > 10 && (entity instanceof GameObject)) { - System.out.println("Adding entity " + entity + " to " + entity.getPosition()); - } + if ((System.currentTimeMillis() - start) / 1000 > 10 && (entity instanceof GameObject)) { + System.out.println("Adding entity " + entity + " to " + entity.getPosition()); + } - notifyListeners(entity, EntityUpdateType.ADD); - } + if (notify) { + notifyListeners(entity, EntityUpdateType.ADD); + } + } - /** - * Checks if this Region contains the specified Entity. - *

    - * This method operates in constant time. - * - * @param entity The Entity. - * @return {@code true} if this Region contains the Entity, otherwise {@code false}. - */ - public boolean contains(Entity entity) { - Position position = entity.getPosition(); - Set local = entities.get(position); + /** + * Adds a {@link Entity} to the Region. Note that this does not spawn the Entity, or do any other action other than + * register it to this Region. + *

    + * By default, this method notifies RegionListeners for this region of the addition. + * + * @param entity The Entity. + * @throws IllegalArgumentException If the Entity does not belong in this Region. + */ + public void addEntity(Entity entity) { + addEntity(entity, true); + } - return local != null && local.contains(entity); - } + /** + * Checks if this Region contains the specified Entity. + *

    + * This method operates in constant time. + * + * @param entity The Entity. + * @return {@code true} if this Region contains the Entity, otherwise {@code false}. + */ - /** - * Gets this Region's {@link RegionCoordinates}. - * - * @return The Region coordinates. - */ - public RegionCoordinates getCoordinates() { - return coordinates; - } + public boolean contains(Entity entity) { + Position position = entity.getPosition(); + Set local = entities.get(position); - /** - * Gets a shallow copy of the {@link Set} of {@link Entity} objects at the specified {@link Position}. The returned - * type will be immutable. - * - * @param position The position containing the entities. - * @return The list. - */ - public Set getEntities(Position position) { - Set set = entities.get(position); - return (set == null) ? ImmutableSet.of() : ImmutableSet.copyOf(set); - } + return local != null && local.contains(entity); + } - /** - * Gets a shallow copy of the {@link Set} of {@link Entity}s with the specified {@link EntityType}(s). The returned - * type will be immutable. Type will be inferred from the call, so ensure that the Entity type and the reference - * correspond, or this method will fail at runtime. - * - * @param position The {@link Position} containing the entities. - * @param types The {@link EntityType}s. - * @return The set of entities. - */ - public Set getEntities(Position position, EntityType... types) { - Set local = entities.get(position); - if (local == null) { - return ImmutableSet.of(); - } + /** + * Gets this Region's {@link RegionCoordinates}. + * + * @return The Region coordinates. + */ + public RegionCoordinates getCoordinates() { + return coordinates; + } - Set set = new HashSet<>(Arrays.asList(types)); - @SuppressWarnings("unchecked") - Set filtered = (Set) local.stream().filter(entity -> set.contains(entity.getEntityType())).collect(Collectors.toSet()); - return ImmutableSet.copyOf(filtered); - } + /** + * Gets a shallow copy of the {@link Set} of {@link Entity} objects at the specified {@link Position}. The returned + * type will be immutable. + * + * @param position The position containing the entities. + * @return The list. + */ + public Set getEntities(Position position) { + Set set = entities.get(position); + return (set == null) ? ImmutableSet.of() : ImmutableSet.copyOf(set); + } - /** - * Gets the {@link CollisionMatrix} at the specified height level. - * - * @param height The height level. - * @return The CollisionMatrix. - */ - public CollisionMatrix getMatrix(int height) { - Preconditions.checkElementIndex(height, matrices.length, "Matrix height level must be [0, " + matrices.length + ")."); - return matrices[height]; - } + /** + * Gets a shallow copy of the {@link Set} of {@link Entity}s with the specified {@link EntityType}(s). The returned + * type will be immutable. Type will be inferred from the call, so ensure that the Entity type and the reference + * correspond, or this method will fail at runtime. + * + * @param position The {@link Position} containing the entities. + * @param types The {@link EntityType}s. + * @return The set of entities. + */ + public Set getEntities(Position position, EntityType... types) { + Set local = entities.get(position); + if (local == null) { + return ImmutableSet.of(); + } - /** - * Gets a {@link Set} containing {@link RegionUpdateMessage}s that add every {@link Entity} in this Region. - * - * @param height The height level to get the Set of RegionUpdateMessages for. - * @return The Set of RegionUpdateMessages. - */ - public List getSnapshot(int height) { - List copy = new ArrayList<>(snapshots.get(height)); - Collections.sort(copy); - return ImmutableList.copyOf(copy); - } + Set set = new HashSet<>(Arrays.asList(types)); + @SuppressWarnings("unchecked") + Set filtered = (Set) local.stream().filter(entity -> set.contains(entity.getEntityType())).collect(Collectors.toSet()); + return ImmutableSet.copyOf(filtered); + } - /** - * Gets the updates that have occurred in the last tick in this Region, as a {@link Set} of - * {@link RegionUpdateMessage}s. - * - * @param height The height level to get the Set of RegionUpdateMessages for. - * @return The Set of RegionUpdateMessages. - */ - public List getUpdates(int height) { - List original = this.updates.get(height); - List updates = new ArrayList<>(original); - original.clear(); + /** + * Gets the {@link CollisionMatrix} at the specified height level. + * + * @param height The height level. + * @return The CollisionMatrix. + */ + public CollisionMatrix getMatrix(int height) { + Preconditions.checkElementIndex(height, matrices.length, "Matrix height level must be [0, " + matrices.length + ")."); + return matrices[height]; + } - Collections.sort(updates); - return ImmutableList.copyOf(updates); - } + /** + * Gets a {@link Set} containing {@link RegionUpdateMessage}s that add every {@link Entity} in this Region. + * + * @param height The height level to get the Set of RegionUpdateMessages for. + * @return The Set of RegionUpdateMessages. + */ + public List getSnapshot(int height) { + List copy = new ArrayList<>(snapshots.get(height)); + Collections.sort(copy); + return ImmutableList.copyOf(copy); + } - /** - * Notifies the {@link RegionListener}s registered to this Region that an update has occurred. - * - * @param entity The {@link Entity} that was updated. - * @param type The {@link EntityUpdateType} that occurred. - */ - public void notifyListeners(Entity entity, EntityUpdateType type) { - listeners.forEach(listener -> listener.execute(this, entity, type)); - } + /** + * Gets the updates that have occurred in the last tick in this Region, as a {@link Set} of + * {@link RegionUpdateMessage}s. + * + * @param height The height level to get the Set of RegionUpdateMessages for. + * @return The Set of RegionUpdateMessages. + */ + public List getUpdates(int height) { + List original = this.updates.get(height); + List updates = new ArrayList<>(original); + original.clear(); - /** - * Removes a {@link Entity} from this Region. - * - * @param entity The Entity. - * @throws IllegalArgumentException If the Entity does not belong in this Region, or if it was never added. - */ - public void removeEntity(Entity entity) { - Position position = entity.getPosition(); - checkPosition(position); + Collections.sort(updates); + return ImmutableList.copyOf(updates); + } - Set local = entities.get(position); + /** + * Notifies the {@link RegionListener}s registered to this Region that an update has occurred. + * + * @param entity The {@link Entity} that was updated. + * @param type The {@link EntityUpdateType} that occurred. + */ + public void notifyListeners(Entity entity, EntityUpdateType type) { + listeners.forEach(listener -> listener.execute(this, entity, type)); + } - if (local == null || !local.remove(entity)) { - throw new IllegalArgumentException("Entity belongs in this Region (" + this + ") but does not exist."); - } + /** + * Removes a {@link Entity} from this Region. + * + * @param entity The Entity. + * @throws IllegalArgumentException If the Entity does not belong in this Region, or if it was never added. + */ + public void removeEntity(Entity entity) { + Position position = entity.getPosition(); + checkPosition(position); - notifyListeners(entity, EntityUpdateType.REMOVE); - } + Set local = entities.get(position); - @Override - public String toString() { - return MoreObjects.toStringHelper(this).add("coordinates", coordinates).toString(); - } + if (local == null || !local.remove(entity)) { + throw new IllegalArgumentException("Entity belongs in this Region (" + this + ") but does not exist."); + } - /** - * Returns whether or not an Entity of the specified {@link EntityType type} can traverse the tile at the specified - * coordinate pair. - * - * @param position The {@link Position} of the tile. - * @param entity The {@link EntityType}. - * @param direction The {@link Direction} the Entity is approaching from. - * @return {@code true} if the tile at the specified coordinate pair is traversable, {@code false} if not. - */ - public boolean traversable(Position position, EntityType entity, Direction direction) { - CollisionMatrix matrix = matrices[position.getHeight()]; - int x = position.getX(), y = position.getY(); + notifyListeners(entity, EntityUpdateType.REMOVE); + } - return !matrix.untraversable(x % SIZE, y % SIZE, entity, direction); - } + @Override + public String toString() { + return MoreObjects.toStringHelper(this).add("coordinates", coordinates).toString(); + } - /** - * Checks that the specified {@link Position} is included in this Region. - * - * @param position The position. - * @throws IllegalArgumentException If the specified position is not included in this Region. - */ - private void checkPosition(Position position) { - Preconditions.checkArgument(coordinates.equals(RegionCoordinates.fromPosition(position)), "Position is not included in this Region."); - } + /** + * Returns whether or not an Entity of the specified {@link EntityType type} can traverse the tile at the specified + * coordinate pair. + * + * @param position The {@link Position} of the tile. + * @param entity The {@link EntityType}. + * @param direction The {@link Direction} the Entity is approaching from. + * @return {@code true} if the tile at the specified coordinate pair is traversable, {@code false} if not. + */ + public boolean traversable(Position position, EntityType entity, Direction direction) { + CollisionMatrix matrix = matrices[position.getHeight()]; + int x = position.getX(), y = position.getY(); - /** - * Records the specified {@link Entity} as being updated this pulse. - * - * @param entity The Entity. - * @param type The {@link EntityUpdateType}. - * @throws UnsupportedOperationException If the specified Entity cannot be operated on in this manner. - */ - private void record(Entity entity, EntityUpdateType type) { - RegionUpdateMessage message = entity.toUpdateOperation(this, type).toMessage(); - int height = entity.getPosition().getHeight(); + return !matrix.untraversable(x % SIZE, y % SIZE, entity, direction); + } - updates.get(height).add(message); - snapshots.get(height).add(message); - } + /** + * Checks that the specified {@link Position} is included in this Region. + * + * @param position The position. + * @throws IllegalArgumentException If the specified position is not included in this Region. + */ + private void checkPosition(Position position) { + Preconditions.checkArgument(coordinates.equals(RegionCoordinates.fromPosition(position)), "Position is not included in this Region."); + } + + /** + * Records the specified {@link Entity} as being updated this pulse. + * + * @param entity The Entity. + * @param type The {@link EntityUpdateType}. + * @throws UnsupportedOperationException If the specified Entity cannot be operated on in this manner. + */ + private void record(Entity entity, EntityUpdateType type) { + RegionUpdateMessage message = entity.toUpdateOperation(this, type).toMessage(); + int height = entity.getPosition().getHeight(); + + updates.get(height).add(message); + + if (entity.getEntityType() != EntityType.STATIC_OBJECT || type == EntityUpdateType.REMOVE) { + snapshots.get(height).add(message); + } + } } \ No newline at end of file From 48b6dc7122b45d50af2e99ed55488d4fc584ea99 Mon Sep 17 00:00:00 2001 From: Steve Date: Fri, 10 Apr 2015 08:01:08 -0400 Subject: [PATCH 08/18] Changed 'region snapshots' from a list to a map, allowing for the removal of previous update operations. (They were stacking before this commit, leading to problems for players just entering the region) It appears that object updating is now functional. :) --- src/org/apollo/game/model/area/Region.java | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/org/apollo/game/model/area/Region.java b/src/org/apollo/game/model/area/Region.java index 838e560e..6912778a 100644 --- a/src/org/apollo/game/model/area/Region.java +++ b/src/org/apollo/game/model/area/Region.java @@ -75,7 +75,7 @@ public final class Region { /** * The Set containing RegionUpdateMessages which can be sent to add every non-Mob Entity in this Region. */ - private final List> snapshots = new ArrayList<>(Position.HEIGHT_LEVELS); + private final List> snapshots = new ArrayList<>(Position.HEIGHT_LEVELS); /** * The Set containing UpdateOperations. @@ -102,7 +102,7 @@ public final class Region { listeners.add(new UpdateRegionListener()); for (int height = 0; height < Position.HEIGHT_LEVELS; height++) { - snapshots.add(new ArrayList<>()); + snapshots.add(new HashMap<>()); updates.add(new ArrayList<>(DEFAULT_SET_SIZE)); } } @@ -220,7 +220,7 @@ public final class Region { * @return The Set of RegionUpdateMessages. */ public List getSnapshot(int height) { - List copy = new ArrayList<>(snapshots.get(height)); + List copy = new ArrayList<>(snapshots.get(height).values()); Collections.sort(copy); return ImmutableList.copyOf(copy); } @@ -313,9 +313,10 @@ public final class Region { int height = entity.getPosition().getHeight(); updates.get(height).add(message); + snapshots.get(height).remove(entity); if (entity.getEntityType() != EntityType.STATIC_OBJECT || type == EntityUpdateType.REMOVE) { - snapshots.get(height).add(message); + snapshots.get(height).put(entity, message); } } From a658e1e8c7306472d0373aeef0048fdbd601cb4a Mon Sep 17 00:00:00 2001 From: Steve Date: Fri, 10 Apr 2015 08:16:58 -0400 Subject: [PATCH 09/18] Slight change in logic, we only need to snapshot static objects during a REMOVE update, and any other entities during an ADD update. --- src/org/apollo/game/model/area/Region.java | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/org/apollo/game/model/area/Region.java b/src/org/apollo/game/model/area/Region.java index 6912778a..47391e70 100644 --- a/src/org/apollo/game/model/area/Region.java +++ b/src/org/apollo/game/model/area/Region.java @@ -315,7 +315,8 @@ public final class Region { updates.get(height).add(message); snapshots.get(height).remove(entity); - if (entity.getEntityType() != EntityType.STATIC_OBJECT || type == EntityUpdateType.REMOVE) { + if ((entity.getEntityType() == EntityType.STATIC_OBJECT && type == EntityUpdateType.REMOVE) || + (entity.getEntityType() != EntityType.STATIC_OBJECT && type == EntityUpdateType.ADD)) { snapshots.get(height).put(entity, message); } } From 7a2d933a5ffa349fb5d7e3707a318dd33a7254b2 Mon Sep 17 00:00:00 2001 From: atomicint Date: Fri, 10 Apr 2015 15:37:02 -0400 Subject: [PATCH 10/18] Rebase the isaac random algorithm implementation. --- .../burtleburtle/bob/rand/IsaacRandom.java | 308 +++++++++--------- 1 file changed, 145 insertions(+), 163 deletions(-) diff --git a/src/net/burtleburtle/bob/rand/IsaacRandom.java b/src/net/burtleburtle/bob/rand/IsaacRandom.java index 80e3b9f9..4349df9c 100644 --- a/src/net/burtleburtle/bob/rand/IsaacRandom.java +++ b/src/net/burtleburtle/bob/rand/IsaacRandom.java @@ -31,58 +31,49 @@ public final class IsaacRandom { private static final int GOLDEN_RATIO = 0x9e3779b9; /** - * The log of the size of the result and memory arrays. + * The log of the size of the result and state arrays. */ - private static final int LOG_SIZE = 8; + private static final int LOG_SIZE = Long.BYTES; /** - * The size of the result and memory arrays. + * The size of the result and states arrays. */ private static final int SIZE = 1 << LOG_SIZE; /** - * A mask for pseudorandom lookup. + * A mask for pseudo-random lookup. */ private static int MASK = SIZE - 1 << 2; /** - * The accumulator. + * The results given to the user. */ - private int a; - - /** - * The last result. - */ - private int b; - - /** - * The counter. - */ - private int c; - - /** - * The count through the results in the results array. - */ - private int count; + private final int[] results = new int[SIZE]; /** * The internal state. */ - private final int[] mem; + private final int[] state = new int[SIZE]; /** - * The results given to the user. + * The count through the results in the results array. */ - private final int[] rsl; + private int count = SIZE; /** - * Creates the random number generator without an initial seed. + * The accumulator. */ - public IsaacRandom() { - mem = new int[SIZE]; - rsl = new int[SIZE]; - init(false); - } + private int accumulator; + + /** + * The last result. + */ + private int last; + + /** + * The counter. + */ + private int counter; /** * Creates the random number generator with the specified seed. @@ -90,20 +81,75 @@ public final class IsaacRandom { * @param seed The seed. */ public IsaacRandom(int[] seed) { - mem = new int[SIZE]; - rsl = new int[SIZE]; - for (int i = 0; i < seed.length; ++i) { - rsl[i] = seed[i]; - } - init(true); + int length = Math.min(seed.length, results.length); + System.arraycopy(seed, 0, results, 0, length); + init(); } /** - * Initialises this random number generator. - * - * @param hasSeed Set to {@code true} if a seed was passed to the constructor. + * Generates 256 results. */ - private void init(boolean hasSeed) { + private void isaac() { + int i, j, x, y; + + last += ++counter; + for (i = 0, j = SIZE / 2; i < SIZE / 2;) { + x = state[i]; + accumulator ^= accumulator << 13; + accumulator += state[j++]; + state[i] = y = state[(x & MASK) >> 2] + accumulator + last; + results[i++] = last = state[(y >> LOG_SIZE & MASK) >> 2] + x; + + x = state[i]; + accumulator ^= accumulator >>> 6; + accumulator += state[j++]; + state[i] = y = state[(x & MASK) >> 2] + accumulator + last; + results[i++] = last = state[(y >> LOG_SIZE & MASK) >> 2] + x; + + x = state[i]; + accumulator ^= accumulator << 2; + accumulator += state[j++]; + state[i] = y = state[(x & MASK) >> 2] + accumulator + last; + results[i++] = last = state[(y >> LOG_SIZE & MASK) >> 2] + x; + + x = state[i]; + accumulator ^= accumulator >>> 16; + accumulator += state[j++]; + state[i] = y = state[(x & MASK) >> 2] + accumulator + last; + results[i++] = last = state[(y >> LOG_SIZE & MASK) >> 2] + x; + } + + for (j = 0; j < SIZE / 2;) { + x = state[i]; + accumulator ^= accumulator << 13; + accumulator += state[j++]; + state[i] = y = state[(x & MASK) >> 2] + accumulator + last; + results[i++] = last = state[(y >> LOG_SIZE & MASK) >> 2] + x; + + x = state[i]; + accumulator ^= accumulator >>> 6; + accumulator += state[j++]; + state[i] = y = state[(x & MASK) >> 2] + accumulator + last; + results[i++] = last = state[(y >> LOG_SIZE & MASK) >> 2] + x; + + x = state[i]; + accumulator ^= accumulator << 2; + accumulator += state[j++]; + state[i] = y = state[(x & MASK) >> 2] + accumulator + last; + results[i++] = last = state[(y >> LOG_SIZE & MASK) >> 2] + x; + + x = state[i]; + accumulator ^= accumulator >>> 16; + accumulator += state[j++]; + state[i] = y = state[(x & MASK) >> 2] + accumulator + last; + results[i++] = last = state[(y >> LOG_SIZE & MASK) >> 2] + x; + } + } + + /** + * Initializes this random number generator. + */ + private void init() { int i; int a, b, c, d, e, f, g, h; a = b = c = d = e = f = g = h = GOLDEN_RATIO; @@ -136,16 +182,15 @@ public final class IsaacRandom { } for (i = 0; i < SIZE; i += 8) { /* fill in mem[] with messy stuff */ - if (hasSeed) { - a += rsl[i]; - b += rsl[i + 1]; - c += rsl[i + 2]; - d += rsl[i + 3]; - e += rsl[i + 4]; - f += rsl[i + 5]; - g += rsl[i + 6]; - h += rsl[i + 7]; - } + a += results[i]; + b += results[i + 1]; + c += results[i + 2]; + d += results[i + 3]; + e += results[i + 4]; + f += results[i + 5]; + g += results[i + 6]; + h += results[i + 7]; + a ^= b << 11; d += a; b += c; @@ -170,123 +215,60 @@ public final class IsaacRandom { h ^= a >>> 9; c += h; a += b; - mem[i] = a; - mem[i + 1] = b; - mem[i + 2] = c; - mem[i + 3] = d; - mem[i + 4] = e; - mem[i + 5] = f; - mem[i + 6] = g; - mem[i + 7] = h; + state[i] = a; + state[i + 1] = b; + state[i + 2] = c; + state[i + 3] = d; + state[i + 4] = e; + state[i + 5] = f; + state[i + 6] = g; + state[i + 7] = h; } - if (hasSeed) { /* second pass makes all of seed affect all of mem */ - for (i = 0; i < SIZE; i += 8) { - a += mem[i]; - b += mem[i + 1]; - c += mem[i + 2]; - d += mem[i + 3]; - e += mem[i + 4]; - f += mem[i + 5]; - g += mem[i + 6]; - h += mem[i + 7]; - a ^= b << 11; - d += a; - b += c; - b ^= c >>> 2; - e += b; - c += d; - c ^= d << 8; - f += c; - d += e; - d ^= e >>> 16; - g += d; - e += f; - e ^= f << 10; - h += e; - f += g; - f ^= g >>> 4; - a += f; - g += h; - g ^= h << 8; - b += g; - h += a; - h ^= a >>> 9; - c += h; - a += b; - mem[i] = a; - mem[i + 1] = b; - mem[i + 2] = c; - mem[i + 3] = d; - mem[i + 4] = e; - mem[i + 5] = f; - mem[i + 6] = g; - mem[i + 7] = h; - } + for (i = 0; i < SIZE; i += 8) { + a += state[i]; + b += state[i + 1]; + c += state[i + 2]; + d += state[i + 3]; + e += state[i + 4]; + f += state[i + 5]; + g += state[i + 6]; + h += state[i + 7]; + a ^= b << 11; + d += a; + b += c; + b ^= c >>> 2; + e += b; + c += d; + c ^= d << 8; + f += c; + d += e; + d ^= e >>> 16; + g += d; + e += f; + e ^= f << 10; + h += e; + f += g; + f ^= g >>> 4; + a += f; + g += h; + g ^= h << 8; + b += g; + h += a; + h ^= a >>> 9; + c += h; + a += b; + state[i] = a; + state[i + 1] = b; + state[i + 2] = c; + state[i + 3] = d; + state[i + 4] = e; + state[i + 5] = f; + state[i + 6] = g; + state[i + 7] = h; } isaac(); - count = SIZE; - } - - /** - * Generates 256 results. - */ - private void isaac() { - int i, j, x, y; - - b += ++c; - for (i = 0, j = SIZE / 2; i < SIZE / 2;) { - x = mem[i]; - a ^= a << 13; - a += mem[j++]; - mem[i] = y = mem[(x & MASK) >> 2] + a + b; - rsl[i++] = b = mem[(y >> LOG_SIZE & MASK) >> 2] + x; - - x = mem[i]; - a ^= a >>> 6; - a += mem[j++]; - mem[i] = y = mem[(x & MASK) >> 2] + a + b; - rsl[i++] = b = mem[(y >> LOG_SIZE & MASK) >> 2] + x; - - x = mem[i]; - a ^= a << 2; - a += mem[j++]; - mem[i] = y = mem[(x & MASK) >> 2] + a + b; - rsl[i++] = b = mem[(y >> LOG_SIZE & MASK) >> 2] + x; - - x = mem[i]; - a ^= a >>> 16; - a += mem[j++]; - mem[i] = y = mem[(x & MASK) >> 2] + a + b; - rsl[i++] = b = mem[(y >> LOG_SIZE & MASK) >> 2] + x; - } - - for (j = 0; j < SIZE / 2;) { - x = mem[i]; - a ^= a << 13; - a += mem[j++]; - mem[i] = y = mem[(x & MASK) >> 2] + a + b; - rsl[i++] = b = mem[(y >> LOG_SIZE & MASK) >> 2] + x; - - x = mem[i]; - a ^= a >>> 6; - a += mem[j++]; - mem[i] = y = mem[(x & MASK) >> 2] + a + b; - rsl[i++] = b = mem[(y >> LOG_SIZE & MASK) >> 2] + x; - - x = mem[i]; - a ^= a << 2; - a += mem[j++]; - mem[i] = y = mem[(x & MASK) >> 2] + a + b; - rsl[i++] = b = mem[(y >> LOG_SIZE & MASK) >> 2] + x; - - x = mem[i]; - a ^= a >>> 16; - a += mem[j++]; - mem[i] = y = mem[(x & MASK) >> 2] + a + b; - rsl[i++] = b = mem[(y >> LOG_SIZE & MASK) >> 2] + x; - } } /** @@ -299,7 +281,7 @@ public final class IsaacRandom { isaac(); count = SIZE - 1; } - return rsl[count]; + return results[count]; } } \ No newline at end of file From 7a12a27c76b949ac0baf5e7edc204923c372b174 Mon Sep 17 00:00:00 2001 From: atomicint Date: Mon, 13 Apr 2015 13:57:59 -0400 Subject: [PATCH 11/18] ThreadFactory utility --- src/org/apollo/game/GameService.java | 5 +- .../game/sync/ParallelClientSynchronizer.java | 10 +- src/org/apollo/util/ThreadUtil.java | 136 ++++++++++++++++++ 3 files changed, 141 insertions(+), 10 deletions(-) create mode 100644 src/org/apollo/util/ThreadUtil.java diff --git a/src/org/apollo/game/GameService.java b/src/org/apollo/game/GameService.java index 7424b81a..02fd3f73 100644 --- a/src/org/apollo/game/GameService.java +++ b/src/org/apollo/game/GameService.java @@ -20,12 +20,11 @@ import org.apollo.io.MessageHandlerChainSetParser; import org.apollo.login.LoginService; import org.apollo.net.session.GameSession; import org.apollo.util.MobRepository; +import org.apollo.util.ThreadUtil; import org.apollo.util.xml.XmlNode; import org.apollo.util.xml.XmlParser; import org.xml.sax.SAXException; -import com.google.common.util.concurrent.ThreadFactoryBuilder; - /** * The {@link GameService} class schedules and manages the execution of the {@link GamePulseHandler} class. * @@ -52,7 +51,7 @@ public final class GameService extends Service { /** * The scheduled executor service. */ - private final ScheduledExecutorService scheduledExecutor = Executors.newSingleThreadScheduledExecutor(new ThreadFactoryBuilder().setNameFormat("GameService").build()); + private final ScheduledExecutorService scheduledExecutor = Executors.newSingleThreadScheduledExecutor(ThreadUtil.build("GameService")); /** * The {@link ClientSynchronizer}. diff --git a/src/org/apollo/game/sync/ParallelClientSynchronizer.java b/src/org/apollo/game/sync/ParallelClientSynchronizer.java index 54b6b202..1fac73e1 100644 --- a/src/org/apollo/game/sync/ParallelClientSynchronizer.java +++ b/src/org/apollo/game/sync/ParallelClientSynchronizer.java @@ -6,7 +6,6 @@ import java.util.Map; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; import java.util.concurrent.Phaser; -import java.util.concurrent.ThreadFactory; import org.apollo.game.GameService; import org.apollo.game.message.impl.RegionUpdateMessage; @@ -22,8 +21,7 @@ import org.apollo.game.sync.task.PreNpcSynchronizationTask; import org.apollo.game.sync.task.PrePlayerSynchronizationTask; import org.apollo.game.sync.task.SynchronizationTask; import org.apollo.util.MobRepository; - -import com.google.common.util.concurrent.ThreadFactoryBuilder; +import org.apollo.util.ThreadUtil; /** * An implementation of {@link ClientSynchronizer} which runs in a thread pool. A {@link Phaser} is used to ensure that @@ -49,12 +47,10 @@ public final class ParallelClientSynchronizer extends ClientSynchronizer { /** * Creates the parallel client synchronizer backed by a thread pool with a number of threads equal to the number of - * processing cores available (this is found by the {@link Runtime#availableProcessors()} method. + * processing cores available (this is found by the {@link ThreadUtil#AVAILABLE_PROCESSORS} method. */ public ParallelClientSynchronizer() { - int processors = Runtime.getRuntime().availableProcessors(); - ThreadFactory factory = new ThreadFactoryBuilder().setNameFormat("ClientSynchronizer").build(); - executor = Executors.newFixedThreadPool(processors, factory); + executor = Executors.newFixedThreadPool(ThreadUtil.AVAILABLE_PROCESSORS, ThreadUtil.build("ClientSynchronizer")); } @Override diff --git a/src/org/apollo/util/ThreadUtil.java b/src/org/apollo/util/ThreadUtil.java new file mode 100644 index 00000000..d31df05f --- /dev/null +++ b/src/org/apollo/util/ThreadUtil.java @@ -0,0 +1,136 @@ +package org.apollo.util; + +import static com.google.common.base.Preconditions.checkArgument; + +import java.lang.Thread.UncaughtExceptionHandler; +import java.util.Objects; +import java.util.concurrent.ThreadFactory; +import java.util.logging.Level; +import java.util.logging.Logger; + +import com.google.common.util.concurrent.ThreadFactoryBuilder; + +/** + * A static utility class which provides ease of use functionality for {@link Thread}s + * + * @author Ryley Kimmel + */ +public final class ThreadUtil { + + /** + * Returns the amount of available processors available to the Java virtual machine. + */ + public static final int AVAILABLE_PROCESSORS = Runtime.getRuntime().availableProcessors(); + + /** + * A {@link Logger} used to debug messages to the console. + */ + private static final Logger LOGGER = Logger.getLogger(ThreadUtil.class.getSimpleName()); + + /** + * The default {@link UncaughtExceptionHandler} which raises an error from the logger with the exception and name of + * the specified thread the exception occurred in. + */ + private static final UncaughtExceptionHandler DEFAULT_EXCEPTION_HANDLER = (thread, exception) -> LOGGER.log(Level.SEVERE, "Exception occured in thread " + thread.getName(), exception); + + /** + * Builds a {@link ThreadFactory} using the specified {@code String} name-format, {@link ThreadPriority} and + * {@link UncaughtExceptionHandler}. + * + * @param name The name-format used when creating threads, may not be {@code null}. + * @param priority The priority used when creating threads, may not be {@code null}. + * @param handler The {@link UncaughtExceptionHandler} used when creating threads, may not be {@code null}. + * @return A new {@link ThreadFactory} from the specified parameters, never {@code null}. + */ + public static ThreadFactory build(String name, ThreadPriority priority, UncaughtExceptionHandler handler) { + Objects.requireNonNull(priority); + + ThreadFactoryBuilder bldr = new ThreadFactoryBuilder(); + bldr.setNameFormat(name); + bldr.setPriority(priority.getValue()); + bldr.setUncaughtExceptionHandler(handler); + return bldr.build(); + } + + /** + * Builds a {@link ThreadFactory} using the specified {@code String} name-format, {@link ThreadPriority} and the + * default {@link UncaughtExceptionHandler}. + * + * @param name The name-format used when creating threads, may not be {@code null}. + * @param priority The priority used when creating threads, may not be {@code null}. + * @return A new {@link ThreadFactory} from the specified parameters, never {@code null}. + * @see {@link #DEFAULT_EXCEPTION_HANDLER} + */ + public static ThreadFactory build(String name, ThreadPriority priority) { + return build(name, priority, DEFAULT_EXCEPTION_HANDLER); + } + + /** + * Builds a {@link ThreadFactory} using the specified {@code String} name-format, normal thread priority and the + * default {@link UncaughtExceptionHandler}. + * + * @param name The name-format used when creating threads, may not be {@code null}. + * @return A new {@link ThreadFactory} from the specified parameters, never {@code null}. + * @see {@link #DEFAULT_EXCEPTION_HANDLER} + * @see {@link ThreadPriority#NORMAL_PRIORITY} + */ + public static ThreadFactory build(String name) { + return build(name, ThreadPriority.NORMAL_PRIORITY, DEFAULT_EXCEPTION_HANDLER); + } + + /** + * An enumeration representing the priority of a {@link Thread}. + * + * @author Ryley Kimmel + */ + public enum ThreadPriority { + + /** + * Represents the minimum priority of a thread. + */ + MINIMUM_PRIORITY(1), + + /** + * Represents the normal priority of a thread. + */ + NORMAL_PRIORITY(5), + + /** + * Represents the maximum priority of a thread. + */ + MAXIMUM_PRIORITY(10); + + /** + * The value of this thread priority. + */ + private final int value; + + /** + * Constructs a new {@link ThreadPriority} with the specified value. + * + * @param value The value of this thread priority, must be within the bounds of {@link Thread#MIN_PRIORITY} and + * {@link Thread#MAX_PRIORITY}. + */ + private ThreadPriority(int value) { + // fail-fast for invalid priority values + checkArgument(value >= Thread.MIN_PRIORITY, "Thread priority (%s) must be >= %s", value, Thread.MIN_PRIORITY); + checkArgument(value <= Thread.MAX_PRIORITY, "Thread priority (%s) must be <= %s", value, Thread.MAX_PRIORITY); + + this.value = value; + } + + /** + * Returns the value of this thread priority. + */ + public final int getValue() { + return value; + } + } + + /** + * Prevents the default-public constructor to discourage instantiation of this class. + */ + private ThreadUtil() { + } + +} \ No newline at end of file From aba1dffa0ece25523dd5d758397baad2eced9545 Mon Sep 17 00:00:00 2001 From: atomicint Date: Mon, 13 Apr 2015 13:59:44 -0400 Subject: [PATCH 12/18] Verify CRCs on login, --- src/org/apollo/Server.java | 8 +-- src/org/apollo/ServerContext.java | 18 ++++++- src/org/apollo/login/LoginService.java | 53 ++++++++++++++++---- src/org/apollo/net/ApolloHandler.java | 2 +- src/org/apollo/net/session/LoginSession.java | 6 ++- src/org/apollo/net/session/Session.java | 3 +- 6 files changed, 70 insertions(+), 20 deletions(-) diff --git a/src/org/apollo/Server.java b/src/org/apollo/Server.java index 57cda878..9b898ae6 100644 --- a/src/org/apollo/Server.java +++ b/src/org/apollo/Server.java @@ -122,8 +122,9 @@ public final class Server { public void init(String releaseClassName) throws Exception { Class clazz = Class.forName(releaseClassName); Release release = (Release) clazz.newInstance(); + int releaseNo = release.getReleaseNumber(); - logger.info("Initialized release #" + release.getReleaseNumber() + "."); + logger.info("Initialized release #" + releaseNo + "."); serviceBootstrap.group(loopGroup); httpBootstrap.group(loopGroup); @@ -131,7 +132,8 @@ public final class Server { World world = new World(); ServiceManager serviceManager = new ServiceManager(world); - ServerContext context = new ServerContext(release, serviceManager); + IndexedFileSystem fs = new IndexedFileSystem(Paths.get("data/fs", Integer.toString(releaseNo)), true); + ServerContext context = new ServerContext(release, serviceManager, fs); ApolloHandler handler = new ApolloHandler(context); ChannelInitializer serviceInitializer = new ServiceChannelInitializer(handler); @@ -149,8 +151,6 @@ public final class Server { PluginManager manager = new PluginManager(world, new PluginContext(context)); serviceManager.startAll(); - int releaseNo = release.getReleaseNumber(); - IndexedFileSystem fs = new IndexedFileSystem(Paths.get("data/fs", Integer.toString(releaseNo)), true); world.init(releaseNo, fs, manager); } diff --git a/src/org/apollo/ServerContext.java b/src/org/apollo/ServerContext.java index ebfe295f..54248044 100644 --- a/src/org/apollo/ServerContext.java +++ b/src/org/apollo/ServerContext.java @@ -1,5 +1,6 @@ package org.apollo; +import org.apollo.fs.IndexedFileSystem; import org.apollo.net.release.Release; /** @@ -21,16 +22,22 @@ public final class ServerContext { */ private final ServiceManager serviceManager; + /** + * The IndexedFileSystem. + */ + private final IndexedFileSystem fileSystem; + /** * Creates a new server context. * * @param release The current release. * @param serviceManager The service manager. */ - ServerContext(Release release, ServiceManager serviceManager) { + ServerContext(Release release, ServiceManager serviceManager, IndexedFileSystem fileSystem) { this.release = release; this.serviceManager = serviceManager; this.serviceManager.setContext(this); + this.fileSystem = fileSystem; } /** @@ -42,6 +49,15 @@ public final class ServerContext { return release; } + /** + * Gets the IndexeFileSystem + * + * @return The IndexedFileSystem. + */ + public IndexedFileSystem getFileSystem() { + return fileSystem; + } + /** * Gets a service. This method is shorthand for {@code getServiceManager().getService(...)}. * diff --git a/src/org/apollo/login/LoginService.java b/src/org/apollo/login/LoginService.java index 206f43e9..81721a05 100644 --- a/src/org/apollo/login/LoginService.java +++ b/src/org/apollo/login/LoginService.java @@ -3,6 +3,8 @@ package org.apollo.login; import java.io.FileInputStream; import java.io.IOException; import java.io.InputStream; +import java.nio.ByteBuffer; +import java.util.Arrays; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; @@ -16,12 +18,11 @@ import org.apollo.net.codec.login.LoginRequest; import org.apollo.net.release.Release; import org.apollo.net.session.GameSession; import org.apollo.net.session.LoginSession; +import org.apollo.util.ThreadUtil; import org.apollo.util.xml.XmlNode; import org.apollo.util.xml.XmlParser; import org.xml.sax.SAXException; -import com.google.common.util.concurrent.ThreadFactoryBuilder; - /** * The {@link LoginService} manages {@link LoginRequest}s. * @@ -33,7 +34,7 @@ public final class LoginService extends Service { /** * The {@link ExecutorService} to which workers are submitted. */ - private final ExecutorService executor = Executors.newCachedThreadPool(new ThreadFactoryBuilder().setNameFormat("LoginService").build()); + private final ExecutorService executor = Executors.newCachedThreadPool(ThreadUtil.build("LoginService")); /** * The current {@link PlayerSerializer}. @@ -79,9 +80,6 @@ public final class LoginService extends Service { this.serializer = (PlayerSerializer) clazz.getConstructor(World.class).newInstance(world); } - /** - * Starts the login service. - */ @Override public void start() { @@ -92,15 +90,48 @@ public final class LoginService extends Service { * * @param session The session submitting this request. * @param request The login request. + * @throws IOException If some I/O exception occurs. */ - public void submitLoadRequest(LoginSession session, LoginRequest request) { + public void submitLoadRequest(LoginSession session, LoginRequest request) throws IOException { + int response = LoginConstants.STATUS_OK; + + if (requiresUpdate(session, request)) { + response = LoginConstants.STATUS_GAME_UPDATED; + } + + if (response == LoginConstants.STATUS_OK) { + executor.submit(new PlayerLoaderWorker(serializer, session, request)); + } else { + session.handlePlayerLoaderResponse(request, new PlayerLoaderResponse(response)); + } + } + + /** + * Checks if an update is required whenever a {@link Player} submits a login request. + * + * @param session The login session. + * @param request The login request. + * @return {@code true} if an update is required, otherwise return {@code false}. + * @throws IOException If some I/O exception occurs. + */ + private boolean requiresUpdate(LoginSession session, LoginRequest request) throws IOException { Release release = session.getRelease(); if (release.getReleaseNumber() != request.getReleaseNumber()) { - // TODO check archive 0 CRCs - session.handlePlayerLoaderResponse(request, new PlayerLoaderResponse(LoginConstants.STATUS_GAME_UPDATED)); - } else { - executor.submit(new PlayerLoaderWorker(serializer, session, request)); + return true; } + + ByteBuffer buffer = getContext().getFileSystem().getCrcTable(); + + int[] clientCrcs = request.getArchiveCrcs(); + int[] serverCrcs = new int[clientCrcs.length]; + + Arrays.setAll(serverCrcs, crc -> buffer.getInt()); + + if (Arrays.equals(clientCrcs, serverCrcs)) { + return false; + } + + return true; } /** diff --git a/src/org/apollo/net/ApolloHandler.java b/src/org/apollo/net/ApolloHandler.java index 312f2076..f78d86a6 100644 --- a/src/org/apollo/net/ApolloHandler.java +++ b/src/org/apollo/net/ApolloHandler.java @@ -66,7 +66,7 @@ public final class ApolloHandler extends ChannelInboundHandlerAdapter { } @Override - public void channelRead(ChannelHandlerContext ctx, Object message) { + public void channelRead(ChannelHandlerContext ctx, Object message) throws Exception { try { Attribute attribute = ctx.attr(NetworkConstants.SESSION_KEY); Session session = attribute.get(); diff --git a/src/org/apollo/net/session/LoginSession.java b/src/org/apollo/net/session/LoginSession.java index 55ef7f9f..9a137fc0 100644 --- a/src/org/apollo/net/session/LoginSession.java +++ b/src/org/apollo/net/session/LoginSession.java @@ -5,6 +5,7 @@ import io.netty.channel.ChannelFuture; import io.netty.channel.ChannelFutureListener; import io.netty.channel.ChannelHandlerContext; +import java.io.IOException; import java.util.Optional; import org.apollo.ServerContext; @@ -72,8 +73,9 @@ public final class LoginSession extends Session { * Handles a login request. * * @param request The login request. + * @throws IOException If some I/O exception occurs. */ - private void handleLoginRequest(LoginRequest request) { + private void handleLoginRequest(LoginRequest request) throws IOException { LoginService loginService = serverContext.getService(LoginService.class); loginService.submitLoadRequest(this, request); } @@ -135,7 +137,7 @@ public final class LoginSession extends Session { } @Override - public void messageReceived(Object message) { + public void messageReceived(Object message) throws Exception { if (message.getClass() == LoginRequest.class) { handleLoginRequest((LoginRequest) message); } diff --git a/src/org/apollo/net/session/Session.java b/src/org/apollo/net/session/Session.java index 118078a3..8ae49027 100644 --- a/src/org/apollo/net/session/Session.java +++ b/src/org/apollo/net/session/Session.java @@ -42,7 +42,8 @@ public abstract class Session { * Processes a message received from the channel. * * @param message The message. + * @throws Exception If some error occurs. */ - public abstract void messageReceived(Object message); + public abstract void messageReceived(Object message) throws Exception; } \ No newline at end of file From a80086e726131cee74de5e8fbddb1e28f070a67b Mon Sep 17 00:00:00 2001 From: atomicint Date: Mon, 13 Apr 2015 14:28:29 -0400 Subject: [PATCH 13/18] Assign the SESSION_KEY to the connecting channel rather than the channel handler context --- src/org/apollo/net/ApolloHandler.java | 9 +++-- src/org/apollo/net/session/LoginSession.java | 41 ++++++-------------- 2 files changed, 17 insertions(+), 33 deletions(-) diff --git a/src/org/apollo/net/ApolloHandler.java b/src/org/apollo/net/ApolloHandler.java index f78d86a6..214860b1 100644 --- a/src/org/apollo/net/ApolloHandler.java +++ b/src/org/apollo/net/ApolloHandler.java @@ -68,11 +68,12 @@ public final class ApolloHandler extends ChannelInboundHandlerAdapter { @Override public void channelRead(ChannelHandlerContext ctx, Object message) throws Exception { try { - Attribute attribute = ctx.attr(NetworkConstants.SESSION_KEY); + Channel channel = ctx.channel(); + Attribute attribute = channel.attr(NetworkConstants.SESSION_KEY); Session session = attribute.get(); if (message instanceof HttpRequest || message instanceof JagGrabRequest) { - session = new UpdateSession(ctx.channel(), serverContext); + session = new UpdateSession(channel, serverContext); } if (session != null) { @@ -86,11 +87,11 @@ public final class ApolloHandler extends ChannelInboundHandlerAdapter { switch (handshakeMessage.getServiceId()) { case HandshakeConstants.SERVICE_GAME: - attribute.set(new LoginSession(ctx, serverContext)); + attribute.set(new LoginSession(channel, serverContext)); break; case HandshakeConstants.SERVICE_UPDATE: - attribute.set(new UpdateSession(ctx.channel(), serverContext)); + attribute.set(new UpdateSession(channel, serverContext)); break; } } diff --git a/src/org/apollo/net/session/LoginSession.java b/src/org/apollo/net/session/LoginSession.java index 9a137fc0..1d92adf8 100644 --- a/src/org/apollo/net/session/LoginSession.java +++ b/src/org/apollo/net/session/LoginSession.java @@ -3,7 +3,6 @@ package org.apollo.net.session; import io.netty.channel.Channel; import io.netty.channel.ChannelFuture; import io.netty.channel.ChannelFutureListener; -import io.netty.channel.ChannelHandlerContext; import java.io.IOException; import java.util.Optional; @@ -14,7 +13,6 @@ import org.apollo.game.model.World.RegistrationStatus; import org.apollo.game.model.entity.Player; import org.apollo.io.player.PlayerLoaderResponse; import org.apollo.login.LoginService; -import org.apollo.net.ApolloHandler; import org.apollo.net.NetworkConstants; import org.apollo.net.codec.game.GameMessageDecoder; import org.apollo.net.codec.game.GameMessageEncoder; @@ -33,26 +31,20 @@ import org.apollo.security.IsaacRandomPair; */ public final class LoginSession extends Session { - /** - * The context of the {@link ApolloHandler}. - */ - private final ChannelHandlerContext channelContext; - /** * The server context. */ - private final ServerContext serverContext; + private final ServerContext context; /** * Creates a login session for the specified channel. * - * @param ctx The context of the {@link ApolloHandler}. - * @param serverContext The server context. + * @param channel The channel. + * @param context The server context. */ - public LoginSession(ChannelHandlerContext ctx, ServerContext serverContext) { - super(ctx.channel()); - channelContext = ctx; - this.serverContext = serverContext; + public LoginSession(Channel channel, ServerContext context) { + super(channel); + this.context = context; } @Override @@ -60,15 +52,6 @@ public final class LoginSession extends Session { } - /** - * Gets the release. - * - * @return The release. - */ - public Release getRelease() { - return serverContext.getRelease(); - } - /** * Handles a login request. * @@ -76,7 +59,7 @@ public final class LoginSession extends Session { * @throws IOException If some I/O exception occurs. */ private void handleLoginRequest(LoginRequest request) throws IOException { - LoginService loginService = serverContext.getService(LoginService.class); + LoginService loginService = context.getService(LoginService.class); loginService.submitLoadRequest(this, request); } @@ -87,7 +70,7 @@ public final class LoginSession extends Session { * @param response The response. */ public void handlePlayerLoaderResponse(LoginRequest request, PlayerLoaderResponse response) { - GameService service = serverContext.getService(GameService.class); + GameService service = context.getService(GameService.class); Channel channel = getChannel(); Optional optional = response.getPlayer(); @@ -98,7 +81,7 @@ public final class LoginSession extends Session { Player player = optional.get(); rights = player.getPrivilegeLevel().toInteger(); - GameSession session = new GameSession(channel, serverContext, player); + GameSession session = new GameSession(channel, context, player); RegistrationStatus registration = service.registerPlayer(player, session); if (registration != RegistrationStatus.OK) { @@ -115,18 +98,18 @@ public final class LoginSession extends Session { if (optional.isPresent()) { IsaacRandomPair randomPair = request.getRandomPair(); - Release release = serverContext.getRelease(); + Release release = context.getRelease(); channel.pipeline().addFirst("messageEncoder", new GameMessageEncoder(release)); channel.pipeline().addBefore("messageEncoder", "gameEncoder", new GamePacketEncoder(randomPair.getEncodingRandom())); - channel.pipeline().addBefore("handler", "gameDecoder", new GamePacketDecoder(randomPair.getDecodingRandom(), serverContext.getRelease())); + channel.pipeline().addBefore("handler", "gameDecoder", new GamePacketDecoder(randomPair.getDecodingRandom(), context.getRelease())); channel.pipeline().addAfter("gameDecoder", "messageDecoder", new GameMessageDecoder(release)); channel.pipeline().remove("loginDecoder"); channel.pipeline().remove("loginEncoder"); - channelContext.attr(NetworkConstants.SESSION_KEY).set(optional.get().getSession()); + channel.attr(NetworkConstants.SESSION_KEY).set(optional.get().getSession()); } else { future.addListener(ChannelFutureListener.CLOSE); } From 3b7b0bdba2e781c0b67c8a34209d71f539892712 Mon Sep 17 00:00:00 2001 From: atomicint Date: Mon, 13 Apr 2015 14:28:51 -0400 Subject: [PATCH 14/18] Old-style poll, looks nicer, exceptions in lambda look funky. --- src/org/apollo/net/session/GameSession.java | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/org/apollo/net/session/GameSession.java b/src/org/apollo/net/session/GameSession.java index e90e3678..1880f83a 100644 --- a/src/org/apollo/net/session/GameSession.java +++ b/src/org/apollo/net/session/GameSession.java @@ -16,7 +16,6 @@ import org.apollo.game.message.Message; import org.apollo.game.message.MessageHandlerChainSet; import org.apollo.game.message.impl.LogoutMessage; import org.apollo.game.model.entity.Player; -import org.apollo.util.CollectionUtil; /** * A game session. @@ -84,13 +83,14 @@ public final class GameSession extends Session { * @param chainSet The {@link MessageHandlerChainSet} */ public void handlePendingMessages(MessageHandlerChainSet chainSet) { - CollectionUtil.pollAll(messageQueue, message -> { + Message message; + while ((message = messageQueue.poll()) != null) { try { chainSet.notify(player, message); } catch (Exception reason) { logger.log(Level.SEVERE, "Uncaught exception thrown while handling message: " + message, reason); } - }); + } } /** From 8d9c0d57a38cc04abfee22cbe5b5dccdf3407465 Mon Sep 17 00:00:00 2001 From: atomicint Date: Mon, 13 Apr 2015 14:29:30 -0400 Subject: [PATCH 15/18] Use the context's Release rather than the LoginSessions, unnecessary propagation. --- src/org/apollo/login/LoginService.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/org/apollo/login/LoginService.java b/src/org/apollo/login/LoginService.java index 81721a05..8e19cde5 100644 --- a/src/org/apollo/login/LoginService.java +++ b/src/org/apollo/login/LoginService.java @@ -115,7 +115,7 @@ public final class LoginService extends Service { * @throws IOException If some I/O exception occurs. */ private boolean requiresUpdate(LoginSession session, LoginRequest request) throws IOException { - Release release = session.getRelease(); + Release release = getContext().getRelease(); if (release.getReleaseNumber() != request.getReleaseNumber()) { return true; } From 802d41306a4932f5ae69fb49a4eedee18d7639b8 Mon Sep 17 00:00:00 2001 From: atomicint Date: Mon, 13 Apr 2015 14:30:04 -0400 Subject: [PATCH 16/18] Do not allow null objects to be passed to the ServerContext, use Guava stopwatch --- src/org/apollo/Server.java | 21 ++++++++++++--------- src/org/apollo/ServerContext.java | 11 +++++++---- 2 files changed, 19 insertions(+), 13 deletions(-) diff --git a/src/org/apollo/Server.java b/src/org/apollo/Server.java index 9b898ae6..c9f90077 100644 --- a/src/org/apollo/Server.java +++ b/src/org/apollo/Server.java @@ -10,6 +10,7 @@ import io.netty.channel.socket.nio.NioServerSocketChannel; import java.net.InetSocketAddress; import java.net.SocketAddress; import java.nio.file.Paths; +import java.util.concurrent.TimeUnit; import java.util.logging.Level; import java.util.logging.Logger; @@ -25,6 +26,8 @@ import org.apollo.net.release.r317.Release317; import org.apollo.util.plugin.PluginContext; import org.apollo.util.plugin.PluginManager; +import com.google.common.base.Stopwatch; + /** * The core class of the Apollo server. * @@ -43,8 +46,9 @@ public final class Server { * @param args The command-line arguments passed to the application. */ public static void main(String[] args) { + Stopwatch stopwatch = Stopwatch.createStarted(); + try { - long start = System.currentTimeMillis(); Server server = new Server(); server.init(args.length == 1 ? args[0] : Release317.class.getName()); @@ -53,10 +57,11 @@ public final class Server { SocketAddress jaggrab = new InetSocketAddress(NetworkConstants.JAGGRAB_PORT); server.bind(service, http, jaggrab); - logger.fine("Starting apollo took " + (System.currentTimeMillis() - start) + " ms."); } catch (Throwable t) { logger.log(Level.SEVERE, "Error whilst starting server.", t); } + + logger.fine("Starting apollo took " + stopwatch.elapsed(TimeUnit.MILLISECONDS) + " ms."); } /** @@ -81,10 +86,8 @@ public final class Server { /** * Creates the Apollo server. - * - * @throws Exception If an error occurs whilst creating services. */ - public Server() throws Exception { + public Server() { logger.info("Starting Apollo..."); } @@ -98,14 +101,14 @@ public final class Server { public void bind(SocketAddress serviceAddress, SocketAddress httpAddress, SocketAddress jagGrabAddress) { try { logger.fine("Binding service listener to address: " + serviceAddress + "..."); - serviceBootstrap.bind(serviceAddress).syncUninterruptibly(); + serviceBootstrap.bind(serviceAddress).sync(); logger.fine("Binding HTTP listener to address: " + httpAddress + "..."); - httpBootstrap.bind(httpAddress).syncUninterruptibly(); + httpBootstrap.bind(httpAddress).sync(); logger.fine("Binding JAGGRAB listener to address: " + jagGrabAddress + "..."); - jagGrabBootstrap.bind(jagGrabAddress).syncUninterruptibly(); - } catch (Exception e) { + jagGrabBootstrap.bind(jagGrabAddress).sync(); + } catch (InterruptedException e) { logger.log(Level.SEVERE, "Binding to a port failed: ensure apollo isn't already running.", e); System.exit(1); } diff --git a/src/org/apollo/ServerContext.java b/src/org/apollo/ServerContext.java index 54248044..6d8162fe 100644 --- a/src/org/apollo/ServerContext.java +++ b/src/org/apollo/ServerContext.java @@ -1,5 +1,7 @@ package org.apollo; +import java.util.Objects; + import org.apollo.fs.IndexedFileSystem; import org.apollo.net.release.Release; @@ -32,12 +34,13 @@ public final class ServerContext { * * @param release The current release. * @param serviceManager The service manager. + * @param fileSystem The indexed file system. */ - ServerContext(Release release, ServiceManager serviceManager, IndexedFileSystem fileSystem) { - this.release = release; - this.serviceManager = serviceManager; + protected ServerContext(Release release, ServiceManager serviceManager, IndexedFileSystem fileSystem) { + this.release = Objects.requireNonNull(release); + this.serviceManager = Objects.requireNonNull(serviceManager); this.serviceManager.setContext(this); - this.fileSystem = fileSystem; + this.fileSystem = Objects.requireNonNull(fileSystem); } /** From 39c75133b9e6f755696cdfafe143a6957caf414b Mon Sep 17 00:00:00 2001 From: atomicint Date: Mon, 13 Apr 2015 16:03:45 -0400 Subject: [PATCH 17/18] Cache server CRCs --- src/org/apollo/fs/IndexedFileSystem.java | 22 ++++++++++++++++++++++ src/org/apollo/login/LoginService.java | 7 +------ 2 files changed, 23 insertions(+), 6 deletions(-) diff --git a/src/org/apollo/fs/IndexedFileSystem.java b/src/org/apollo/fs/IndexedFileSystem.java index 179bdbbd..5b6e5443 100644 --- a/src/org/apollo/fs/IndexedFileSystem.java +++ b/src/org/apollo/fs/IndexedFileSystem.java @@ -7,6 +7,7 @@ import java.io.RandomAccessFile; import java.nio.ByteBuffer; import java.nio.file.Files; import java.nio.file.Path; +import java.util.Arrays; import java.util.zip.CRC32; import com.google.common.base.Preconditions; @@ -24,6 +25,11 @@ public final class IndexedFileSystem implements Closeable { */ private ByteBuffer crcTable; + /** + * The {@link #crcTable} represented as an {@code int} array. + */ + private int[] crcs; + /** * The data file. */ @@ -143,6 +149,22 @@ public final class IndexedFileSystem implements Closeable { throw new IllegalStateException("Cannot get CRC table from a writable file system."); } + /** + * Gets the CRC table as an {@code int} array. + * + * @return The CRC table as an {@code int} array. + * @throws IOException If there is an error accessing files to create the table. + */ + public int[] getCrcs() throws IOException { + if (crcs != null) { + return crcs; + } + + ByteBuffer buffer = getCrcTable(); + Arrays.setAll(crcs, crc -> buffer.getInt()); + return crcs; + } + /** * Gets a file. * diff --git a/src/org/apollo/login/LoginService.java b/src/org/apollo/login/LoginService.java index 8e19cde5..b102ea28 100644 --- a/src/org/apollo/login/LoginService.java +++ b/src/org/apollo/login/LoginService.java @@ -3,7 +3,6 @@ package org.apollo.login; import java.io.FileInputStream; import java.io.IOException; import java.io.InputStream; -import java.nio.ByteBuffer; import java.util.Arrays; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; @@ -120,12 +119,8 @@ public final class LoginService extends Service { return true; } - ByteBuffer buffer = getContext().getFileSystem().getCrcTable(); - int[] clientCrcs = request.getArchiveCrcs(); - int[] serverCrcs = new int[clientCrcs.length]; - - Arrays.setAll(serverCrcs, crc -> buffer.getInt()); + int[] serverCrcs = getContext().getFileSystem().getCrcs(); if (Arrays.equals(clientCrcs, serverCrcs)) { return false; From ad6f377ff019f187cd6d979881f865ecd2461473 Mon Sep 17 00:00:00 2001 From: atomicint Date: Mon, 13 Apr 2015 16:11:34 -0400 Subject: [PATCH 18/18] Cache server CRCs --- src/org/apollo/fs/IndexedFileSystem.java | 23 +++++++++++++++++++++++ src/org/apollo/login/LoginService.java | 7 +------ 2 files changed, 24 insertions(+), 6 deletions(-) diff --git a/src/org/apollo/fs/IndexedFileSystem.java b/src/org/apollo/fs/IndexedFileSystem.java index 179bdbbd..bb98190e 100644 --- a/src/org/apollo/fs/IndexedFileSystem.java +++ b/src/org/apollo/fs/IndexedFileSystem.java @@ -7,6 +7,7 @@ import java.io.RandomAccessFile; import java.nio.ByteBuffer; import java.nio.file.Files; import java.nio.file.Path; +import java.util.Arrays; import java.util.zip.CRC32; import com.google.common.base.Preconditions; @@ -24,6 +25,11 @@ public final class IndexedFileSystem implements Closeable { */ private ByteBuffer crcTable; + /** + * The {@link #crcTable} represented as an {@code int} array. + */ + private int[] crcs; + /** * The data file. */ @@ -143,6 +149,23 @@ public final class IndexedFileSystem implements Closeable { throw new IllegalStateException("Cannot get CRC table from a writable file system."); } + /** + * Gets the CRC table as an {@code int} array. + * + * @return The CRC table as an {@code int} array. + * @throws IOException If there is an error accessing files to create the table. + */ + public int[] getCrcs() throws IOException { + if (crcs != null) { + return crcs; + } + + ByteBuffer buffer = getCrcTable(); + crcs = new int[(buffer.remaining() / Integer.BYTES) - 1]; + Arrays.setAll(crcs, crc -> buffer.getInt()); + return crcs; + } + /** * Gets a file. * diff --git a/src/org/apollo/login/LoginService.java b/src/org/apollo/login/LoginService.java index 8e19cde5..b102ea28 100644 --- a/src/org/apollo/login/LoginService.java +++ b/src/org/apollo/login/LoginService.java @@ -3,7 +3,6 @@ package org.apollo.login; import java.io.FileInputStream; import java.io.IOException; import java.io.InputStream; -import java.nio.ByteBuffer; import java.util.Arrays; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; @@ -120,12 +119,8 @@ public final class LoginService extends Service { return true; } - ByteBuffer buffer = getContext().getFileSystem().getCrcTable(); - int[] clientCrcs = request.getArchiveCrcs(); - int[] serverCrcs = new int[clientCrcs.length]; - - Arrays.setAll(serverCrcs, crc -> buffer.getInt()); + int[] serverCrcs = getContext().getFileSystem().getCrcs(); if (Arrays.equals(clientCrcs, serverCrcs)) { return false;