From 7a752a3279a34739aaf998b61a0a31cd60b4953d Mon Sep 17 00:00:00 2001
From: FateJH <Jason_DiDonato@yahoo.com>
Date: Wed, 12 Oct 2016 19:39:00 -0400
Subject: [PATCH] wrote comments; re-named a parameter

---
 .../packet/game/FriendsRequest.scala          | 30 +++++++++++++++++--
 common/src/test/scala/GamePacketTest.scala    |  6 ++--
 2 files changed, 31 insertions(+), 5 deletions(-)

diff --git a/common/src/main/scala/net/psforever/packet/game/FriendsRequest.scala b/common/src/main/scala/net/psforever/packet/game/FriendsRequest.scala
index 64ee35cf..d0ded324 100644
--- a/common/src/main/scala/net/psforever/packet/game/FriendsRequest.scala
+++ b/common/src/main/scala/net/psforever/packet/game/FriendsRequest.scala
@@ -5,7 +5,33 @@ import net.psforever.packet.{GamePacketOpcode, Marshallable, PacketHelpers, Plan
 import scodec.Codec
 import scodec.codecs._
 
-final case class FriendsRequest(unk : Int,
+/**
+  * Manage the lists of other players whose names are retained by the given player.<br>
+  * <br>
+  * Players can be remembered by their names and added to a list of remembered names - the "friends list."
+  * They can also be dropped from the list.
+  * A list of "ignored" player names can also be retained.
+  * Ignored players will have their comments stifled in the given player's chat window.
+  * No name will be appended or removed from any list until the response to this packet is received.<br>
+  * <br>
+  * Actions that involve the "remove" functionality will locate the entered name in the local list before dispatching this packet.
+  * A complaint will be logged to the event window if the name is not found.<br>
+  * <br>
+  * Actions:<br>
+  * 0 - display friends list<br>
+  * 1 - add player to friends list<br>
+  * 2 - remove player from friends list<br>
+  * 4 - display ignored player list<br>
+  * 5 - add player to ignored player list<br>
+  * 6 - remove player from ignored player list<br>
+  * <br>
+  * Exploration:<br>
+  * Are action = 3 and action = 7 supposed to do anything?
+  * @param action the purpose of this packet
+  * @param friend the player name that was entered;
+  *               blank in certain situations
+  */
+final case class FriendsRequest(action : Int,
                                 friend : String)
   extends PlanetSideGamePacket {
   type Packet = FriendsRequest
@@ -15,7 +41,7 @@ final case class FriendsRequest(unk : Int,
 
 object FriendsRequest extends Marshallable[FriendsRequest] {
   implicit val codec : Codec[FriendsRequest] = (
-    ("unk" | uintL(3)) ::
+    ("action" | uintL(3)) ::
       ("friend" | PacketHelpers.encodedWideStringAligned(5))
     ).as[FriendsRequest]
 }
diff --git a/common/src/test/scala/GamePacketTest.scala b/common/src/test/scala/GamePacketTest.scala
index e5de267c..8e8fa814 100644
--- a/common/src/test/scala/GamePacketTest.scala
+++ b/common/src/test/scala/GamePacketTest.scala
@@ -831,12 +831,12 @@ class GamePacketTest extends Specification {
     }
 
     "FriendsRequest" should {
-      val string = hex"72 3 0a0 46004a0048004e004300"
+      val string = hex"72 3 0A0 46004A0048004E004300"
 
       "decode" in {
         PacketCoding.DecodePacket(string).require match {
-          case FriendsRequest(unk, friend) =>
-            unk mustEqual 1
+          case FriendsRequest(action, friend) =>
+            action mustEqual 1
             friend.length mustEqual 5
             friend mustEqual "FJHNC"
           case default =>