packets RespawnAMSInfoMessage and SquadWaypointEvent, the latter with tests; system of keeping track of deployed AMS vehicles and displaying their data to interested users added through the VehicleService path

This commit is contained in:
FateJH 2018-05-01 23:34:13 -04:00
parent 63cc183031
commit cc3e1dde86
9 changed files with 335 additions and 4 deletions

View file

@ -475,7 +475,7 @@ object GamePacketOpcode extends Enumeration {
case 0x81 => game.DestroyDisplayMessage.decode
case 0x82 => noDecoder(TriggerBotAction)
case 0x83 => noDecoder(SquadWaypointRequest)
case 0x84 => noDecoder(SquadWaypointEvent)
case 0x84 => game.SquadWaypointEvent.decode
case 0x85 => noDecoder(OffshoreVehicleMessage)
case 0x86 => game.ObjectDeployedMessage.decode
case 0x87 => noDecoder(ObjectDeployedCountMessage)
@ -568,7 +568,7 @@ object GamePacketOpcode extends Enumeration {
// OPCODES 0xd0-df
case 0xd0 => noDecoder(UnknownMessage208)
case 0xd1 => game.DisplayedAwardMessage.decode
case 0xd2 => noDecoder(RespawnAMSInfoMessage)
case 0xd2 => game.RespawnAMSInfoMessage.decode
case 0xd3 => noDecoder(ComponentDamageMessage)
case 0xd4 => noDecoder(GenericObjectActionAtPositionMessage)
case 0xd5 => game.PropertyOverrideMessage.decode

View file

@ -0,0 +1,75 @@
// Copyright (c) 2017 PSForever
package net.psforever.packet.game
import net.psforever.packet.{GamePacketOpcode, Marshallable, PacketHelpers, PlanetSideGamePacket}
import net.psforever.types.Vector3
import scodec.{Attempt, Codec, Err}
import scodec.codecs._
import shapeless.{::, HNil}
final case class RespawnInfo(unk1 : List[Vector3],
unk2 : List[Boolean])
final case class RespawnAMSInfoMessage(unk1 : PlanetSideGUID,
unk2 : Boolean,
unk3 : Option[RespawnInfo])
extends PlanetSideGamePacket {
type Packet = RespawnAMSInfoMessage
def opcode = GamePacketOpcode.RespawnAMSInfoMessage
def encode = RespawnAMSInfoMessage.encode(this)
}
object RespawnAMSInfoMessage extends Marshallable[RespawnAMSInfoMessage] {
def apply(u1 : PlanetSideGUID, u2 : Boolean) : RespawnAMSInfoMessage = {
RespawnAMSInfoMessage(u1, u2, None)
}
def apply(u1 : PlanetSideGUID, u2 : Boolean, u3 : RespawnInfo) : RespawnAMSInfoMessage = {
RespawnAMSInfoMessage(u1, u2, Some(u3))
}
private val info_codec : Codec[RespawnInfo] = (
uint(6) >>:~ { size => //max 63
("unk1" | PacketHelpers.listOfNSized(size, Vector3.codec_pos)) ::
("unk2" | PacketHelpers.listOfNSized(size, bool))
}).exmap[RespawnInfo] ({
case _ :: a :: b :: HNil =>
Attempt.Successful(RespawnInfo(a, b))
},
{
case RespawnInfo(a, b) =>
val alen = a.length
if(alen != b.length) {
Attempt.Failure(Err(s"respawn info lists must match in length - $alen vs ${b.length}"))
}
else if(alen > 63) {
Attempt.Failure(Err(s"respawn info lists too long - $alen > 63"))
}
else {
Attempt.Successful(alen :: a :: b :: HNil)
}
}
)
/*
technically, the order of reading should be 16u + 1u + 7u which is byte-aligned
the 7u, however, is divided into a subsequent 1u + 6u reading
if that second 1u is true, the 6u doesn't matter and doesn't need to be read when not necessary
*/
implicit val codec : Codec[RespawnAMSInfoMessage] = (
("unk1" | PlanetSideGUID.codec) ::
("unk2" | bool) ::
(bool >>:~ { test =>
conditional(!test, "unk3" | info_codec).hlist
})
).xmap[RespawnAMSInfoMessage] (
{
case u1 :: u2 :: _ :: u3 :: HNil =>
RespawnAMSInfoMessage(u1, u2, u3)
},
{
case RespawnAMSInfoMessage(u1, u2, u3) =>
u1 :: u2 :: u3.isDefined :: u3 :: HNil
}
)
}

View file

@ -0,0 +1,78 @@
// Copyright (c) 2017 PSForever
package net.psforever.packet.game
import net.psforever.packet.{GamePacketOpcode, Marshallable, PlanetSideGamePacket}
import net.psforever.types.Vector3
import scodec.{Attempt, Codec, Err}
import scodec.codecs._
import shapeless.{::, HNil}
final case class WaypointEvent(unk1 : Int,
pos : Vector3,
unk2 : Int)
final case class SquadWaypointEvent(unk1 : Int,
unk2 : Int,
unk3 : Long,
unk4 : Int,
unk5 : Option[Long],
unk6 : Option[WaypointEvent])
extends PlanetSideGamePacket {
type Packet = SquadWaypointEvent
def opcode = GamePacketOpcode.SquadWaypointEvent
def encode = SquadWaypointEvent.encode(this)
}
object SquadWaypointEvent extends Marshallable[SquadWaypointEvent] {
def apply(unk1 : Int, unk2 : Int, unk3 : Long, unk4 : Int, unk_a : Long) : SquadWaypointEvent =
SquadWaypointEvent(unk1, unk2, unk3, unk4, Some(unk_a), None)
def apply(unk1 : Int, unk2 : Int, unk3 : Long, unk4 : Int, unk_a : Int, pos : Vector3, unk_b : Int) : SquadWaypointEvent =
SquadWaypointEvent(unk1, unk2, unk3, unk4, None, Some(WaypointEvent(unk_a, pos, unk_b)))
def apply(unk1 : Int, unk2 : Int, unk3 : Long, unk4 : Int) : SquadWaypointEvent =
SquadWaypointEvent(unk1, unk2, unk3, unk4, None, None)
private val waypoint_codec : Codec[WaypointEvent] = (
("unk1" | uint16L) ::
("pos" | Vector3.codec_pos) ::
("unk2" | uint(3))
).as[WaypointEvent]
implicit val codec : Codec[SquadWaypointEvent] = (
("unk1" | uint2) >>:~ { unk1 =>
("unk2" | uint16L) ::
("unk3" | uint32L) ::
("unk4" | uint8L) ::
("unk5" | conditional(unk1 == 1, uint32L)) ::
("unk6" | conditional(unk1 == 0, waypoint_codec))
}
).exmap[SquadWaypointEvent] (
{
case 0 :: a :: b :: c :: None :: Some(d) :: HNil =>
Attempt.Successful(SquadWaypointEvent(0, a, b, c, None, Some(d)))
case 1 :: a :: b :: c :: Some(d) :: None :: HNil =>
Attempt.Successful(SquadWaypointEvent(1, a, b, c, Some(d), None))
case a :: b :: c :: d :: None :: None :: HNil =>
Attempt.Successful(SquadWaypointEvent(a, b, c, d, None, None))
case n :: _ :: _ :: _ :: _ :: _ :: HNil =>
Attempt.Failure(Err(s"unexpected format for unk1 - $n"))
},
{
case SquadWaypointEvent(0, a, b, c, None, Some(d)) =>
Attempt.Successful(0 :: a :: b :: c :: None :: Some(d) :: HNil)
case SquadWaypointEvent(1, a, b, c, Some(d), None) =>
Attempt.Successful(1 :: a :: b :: c :: Some(d) :: None :: HNil)
case SquadWaypointEvent(a, b, c, d, None, None) =>
Attempt.Successful(a :: b :: c :: d :: None :: None :: HNil)
case SquadWaypointEvent(n, _, _, _, _, _) =>
Attempt.Failure(Err(s"unexpected format for unk1 - $n"))
}
)
}

View file

@ -0,0 +1,99 @@
// Copyright (c) 2017 PSForever
package game
import org.specs2.mutable._
import net.psforever.packet._
import net.psforever.packet.game.{SquadWaypointEvent, WaypointEvent}
import net.psforever.types.Vector3
import scodec.bits._
class SquadWaypointEventTest extends Specification {
val string_1 = hex"84 82c025d9b6c04000"
val string_2 = hex"84 8280000000000100"
val string_3 = hex"84 00c03f1e5e808042803f3018f316800008"
val string_4 = hex"84 40c03f1e5e80804100000000" //fabricated example
"decode (1)" in {
PacketCoding.DecodePacket(string_1).require match {
case SquadWaypointEvent(unk1, unk2, unk3, unk4, unk5, unk6) =>
unk1 mustEqual 2
unk2 mustEqual 11
unk3 mustEqual 31155863L
unk4 mustEqual 0
unk5 mustEqual None
unk6 mustEqual None
case _ =>
ko
}
}
"decode (2)" in {
PacketCoding.DecodePacket(string_2).require match {
case SquadWaypointEvent(unk1, unk2, unk3, unk4, unk5, unk6) =>
unk1 mustEqual 2
unk2 mustEqual 10
unk3 mustEqual 0L
unk4 mustEqual 4
unk5 mustEqual None
unk6 mustEqual None
case _ =>
ko
}
}
"decode (3)" in {
PacketCoding.DecodePacket(string_3).require match {
case SquadWaypointEvent(unk1, unk2, unk3, unk4, unk5, unk6) =>
unk1 mustEqual 0
unk2 mustEqual 3
unk3 mustEqual 41581052L
unk4 mustEqual 1
unk5 mustEqual None
unk6 mustEqual Some(WaypointEvent(10, Vector3(3457.9688f, 5514.4688f, 0.0f), 1))
case _ =>
ko
}
}
"decode (4)" in {
PacketCoding.DecodePacket(string_4).require match {
case SquadWaypointEvent(unk1, unk2, unk3, unk4, unk5, unk6) =>
unk1 mustEqual 1
unk2 mustEqual 3
unk3 mustEqual 41581052L
unk4 mustEqual 1
unk5 mustEqual Some(4L)
unk6 mustEqual None
case _ =>
ko
}
}
"encode (1)" in {
val msg = SquadWaypointEvent(2, 11, 31155863L, 0)
val pkt = PacketCoding.EncodePacket(msg).require.toByteVector
pkt mustEqual string_1
}
"encode (2)" in {
val msg = SquadWaypointEvent(2, 10, 0L, 4)
val pkt = PacketCoding.EncodePacket(msg).require.toByteVector
pkt mustEqual string_2
}
"encode (3)" in {
val msg = SquadWaypointEvent(0, 3, 41581052L, 1, 10, Vector3(3457.9688f, 5514.4688f, 0.0f), 1)
val pkt = PacketCoding.EncodePacket(msg).require.toByteVector
pkt mustEqual string_3
}
"encode (4)" in {
val msg = SquadWaypointEvent(1, 3, 41581052L, 1, 4L)
val pkt = PacketCoding.EncodePacket(msg).require.toByteVector
pkt mustEqual string_4
}
}