From 3805133c7cd2ec401acdad36f89c1dfa7c3c32f5 Mon Sep 17 00:00:00 2001
From: FateJH <Jason_DiDonato@yahoo.com>
Date: Wed, 18 Jan 2017 22:20:03 -0500
Subject: [PATCH] updating comments

---
 .../psforever/packet/game/MountVehicleMsg.scala  | 16 +++++++++-------
 common/src/test/scala/GamePacketTest.scala       |  4 ++--
 2 files changed, 11 insertions(+), 9 deletions(-)

diff --git a/common/src/main/scala/net/psforever/packet/game/MountVehicleMsg.scala b/common/src/main/scala/net/psforever/packet/game/MountVehicleMsg.scala
index fc31776f1..5a398b415 100644
--- a/common/src/main/scala/net/psforever/packet/game/MountVehicleMsg.scala
+++ b/common/src/main/scala/net/psforever/packet/game/MountVehicleMsg.scala
@@ -6,20 +6,22 @@ import scodec.Codec
 import scodec.codecs._
 
 /**
-  * Alert that the player wishes to board a vehicle into a specific seat.<br>
+  * Alert that the player wishes to board a vehicle at a specific entry point.<br>
   * <br>
-  * The client will only dispatch this packet when it feels confident that the player can get into the specific seat on a vehicle.
+  * The client will only dispatch this packet when it feels confident that the player can get into a vehicle.
   * It makes its own check whether or not to display that "enter vehicle here" icon on the ground.
-  * Even without that condition, the player is not allowed to do anything until the server responds in affirmation.<br>
+  * This is called an "entry point."
+  * Entry points and seat numbers are not required as one-to-one;
+  * multiple entry points can lead to the same seat, such as the driver seat of an ANT.<br>
   * <br>
-  * Base turrets and implant terminals count as "vehicles" for the purpose of mounting.
+  * The player is not allowed to board anything until the server responds in affirmation.
   * @param player_guid the player
   * @param vehicle_guid the vehicle
-  * @param seat the vehicle-specific seat index
+  * @param entry_point the entry index that maps to a seat index, specific to the selected vehicle
   */
 final case class MountVehicleMsg(player_guid : PlanetSideGUID,
                                  vehicle_guid : PlanetSideGUID,
-                                 seat : Int)
+                                 entry_point : Int)
   extends PlanetSideGamePacket {
   type Packet = MountVehicleMsg
   def opcode = GamePacketOpcode.MountVehicleMsg
@@ -30,6 +32,6 @@ object MountVehicleMsg extends Marshallable[MountVehicleMsg] {
   implicit val codec : Codec[MountVehicleMsg] = (
     ("player_guid" | PlanetSideGUID.codec) ::
       ("vehicle_guid" | PlanetSideGUID.codec) ::
-      ("seat" | uint8L)
+      ("entry_point" | uint8L)
     ).as[MountVehicleMsg]
 }
diff --git a/common/src/test/scala/GamePacketTest.scala b/common/src/test/scala/GamePacketTest.scala
index 0df2af6ee..6f715c95a 100644
--- a/common/src/test/scala/GamePacketTest.scala
+++ b/common/src/test/scala/GamePacketTest.scala
@@ -346,10 +346,10 @@ class GamePacketTest extends Specification {
 
       "decode" in {
         PacketCoding.DecodePacket(string).require match {
-          case MountVehicleMsg(player_guid, vehicle_guid, seat) =>
+          case MountVehicleMsg(player_guid, vehicle_guid, entry) =>
             player_guid mustEqual PlanetSideGUID(1249)
             vehicle_guid mustEqual PlanetSideGUID(1127)
-            seat mustEqual 6
+            entry mustEqual 6
           case default =>
             ko
         }