From 26f674b8695d06afcc26e0d8a32c0f9dca5a0472 Mon Sep 17 00:00:00 2001 From: FateJH Date: Sat, 22 Apr 2017 16:15:41 -0400 Subject: [PATCH 1/4] initial work on DeployObjectMessage --- .../psforever/packet/GamePacketOpcode.scala | 2 +- .../packet/game/DeployObjectMessage.scala | 39 +++++++++++++++++++ 2 files changed, 40 insertions(+), 1 deletion(-) create mode 100644 common/src/main/scala/net/psforever/packet/game/DeployObjectMessage.scala diff --git a/common/src/main/scala/net/psforever/packet/GamePacketOpcode.scala b/common/src/main/scala/net/psforever/packet/GamePacketOpcode.scala index e6af1697..af3b4a90 100644 --- a/common/src/main/scala/net/psforever/packet/GamePacketOpcode.scala +++ b/common/src/main/scala/net/psforever/packet/GamePacketOpcode.scala @@ -428,7 +428,7 @@ object GamePacketOpcode extends Enumeration { case 0x5a => noDecoder(DelayedPathMountMsg) case 0x5b => noDecoder(OrbitalShuttleTimeMsg) case 0x5c => noDecoder(AIDamage) - case 0x5d => noDecoder(DeployObjectMessage) + case 0x5d => game.DeployObjectMessage.decode case 0x5e => noDecoder(FavoritesRequest) case 0x5f => noDecoder(FavoritesResponse) diff --git a/common/src/main/scala/net/psforever/packet/game/DeployObjectMessage.scala b/common/src/main/scala/net/psforever/packet/game/DeployObjectMessage.scala new file mode 100644 index 00000000..e18b2442 --- /dev/null +++ b/common/src/main/scala/net/psforever/packet/game/DeployObjectMessage.scala @@ -0,0 +1,39 @@ +// Copyright (c) 2017 PSForever +package net.psforever.packet.game + +import net.psforever.packet.{GamePacketOpcode, Marshallable, PacketHelpers, PlanetSideGamePacket} +import scodec.Codec +import scodec.codecs._ +import shapeless.{::, HNil} + +final case class DeployObjectMessage(guid : PlanetSideGUID, + str : String, + unk1 : Long, + unk2 : Long, + unk3 : Long) + extends PlanetSideGamePacket { + type Packet = DeployObjectMessage + def opcode = GamePacketOpcode.ObjectDeployedMessage + def encode = DeployObjectMessage.encode(this) +} + +object DeployObjectMessage extends Marshallable[DeployObjectMessage] { + implicit val codec : Codec[DeployObjectMessage] = ( + ("object_guid" | PlanetSideGUID.codec) :: + ("str" | PacketHelpers.encodedString) :: + ("unk1" | uint32L) :: + ("unk2" | uint32L) :: + ("unk3" | uint32L) + ).xmap[DeployObjectMessage] ( + { + case guid :: str :: u1 :: u2 :: u3 :: HNil => + DeployObjectMessage(guid, str, u1, u2, u3) + }, + { + case DeployObjectMessage(guid, str, u1, u2, u3) => + //truncate string length to 100 characters; raise no warnings + val limitedStr : String = if(str.length() > 100) { str.substring(0,100) } else { str } + guid :: limitedStr :: u1 :: u2 :: u3 :: HNil + } + ) +} From 71334868f26c8a958e8161176aa6e96336bfac9f Mon Sep 17 00:00:00 2001 From: FateJH Date: Sat, 22 Apr 2017 19:00:25 -0400 Subject: [PATCH 2/4] clarified field names, comments, and added tests --- .../psforever/packet/GamePacketOpcode.scala | 4 +- .../packet/game/DeployObjectMessage.scala | 39 ----------- .../packet/game/ObjectDeployedMessage.scala | 69 +++++++++++++++++++ .../game/ObjectDeployedMessageTest.scala | 32 +++++++++ 4 files changed, 103 insertions(+), 41 deletions(-) delete mode 100644 common/src/main/scala/net/psforever/packet/game/DeployObjectMessage.scala create mode 100644 common/src/main/scala/net/psforever/packet/game/ObjectDeployedMessage.scala create mode 100644 common/src/test/scala/game/ObjectDeployedMessageTest.scala diff --git a/common/src/main/scala/net/psforever/packet/GamePacketOpcode.scala b/common/src/main/scala/net/psforever/packet/GamePacketOpcode.scala index af3b4a90..23673126 100644 --- a/common/src/main/scala/net/psforever/packet/GamePacketOpcode.scala +++ b/common/src/main/scala/net/psforever/packet/GamePacketOpcode.scala @@ -428,7 +428,7 @@ object GamePacketOpcode extends Enumeration { case 0x5a => noDecoder(DelayedPathMountMsg) case 0x5b => noDecoder(OrbitalShuttleTimeMsg) case 0x5c => noDecoder(AIDamage) - case 0x5d => game.DeployObjectMessage.decode + case 0x5d => noDecoder(DeployObjectMessage) case 0x5e => noDecoder(FavoritesRequest) case 0x5f => noDecoder(FavoritesResponse) @@ -477,7 +477,7 @@ object GamePacketOpcode extends Enumeration { case 0x83 => noDecoder(SquadWaypointRequest) case 0x84 => noDecoder(SquadWaypointEvent) case 0x85 => noDecoder(OffshoreVehicleMessage) - case 0x86 => noDecoder(ObjectDeployedMessage) + case 0x86 => game.ObjectDeployedMessage.decode case 0x87 => noDecoder(ObjectDeployedCountMessage) // 0x88 case 0x88 => game.WeaponDelayFireMessage.decode diff --git a/common/src/main/scala/net/psforever/packet/game/DeployObjectMessage.scala b/common/src/main/scala/net/psforever/packet/game/DeployObjectMessage.scala deleted file mode 100644 index e18b2442..00000000 --- a/common/src/main/scala/net/psforever/packet/game/DeployObjectMessage.scala +++ /dev/null @@ -1,39 +0,0 @@ -// Copyright (c) 2017 PSForever -package net.psforever.packet.game - -import net.psforever.packet.{GamePacketOpcode, Marshallable, PacketHelpers, PlanetSideGamePacket} -import scodec.Codec -import scodec.codecs._ -import shapeless.{::, HNil} - -final case class DeployObjectMessage(guid : PlanetSideGUID, - str : String, - unk1 : Long, - unk2 : Long, - unk3 : Long) - extends PlanetSideGamePacket { - type Packet = DeployObjectMessage - def opcode = GamePacketOpcode.ObjectDeployedMessage - def encode = DeployObjectMessage.encode(this) -} - -object DeployObjectMessage extends Marshallable[DeployObjectMessage] { - implicit val codec : Codec[DeployObjectMessage] = ( - ("object_guid" | PlanetSideGUID.codec) :: - ("str" | PacketHelpers.encodedString) :: - ("unk1" | uint32L) :: - ("unk2" | uint32L) :: - ("unk3" | uint32L) - ).xmap[DeployObjectMessage] ( - { - case guid :: str :: u1 :: u2 :: u3 :: HNil => - DeployObjectMessage(guid, str, u1, u2, u3) - }, - { - case DeployObjectMessage(guid, str, u1, u2, u3) => - //truncate string length to 100 characters; raise no warnings - val limitedStr : String = if(str.length() > 100) { str.substring(0,100) } else { str } - guid :: limitedStr :: u1 :: u2 :: u3 :: HNil - } - ) -} diff --git a/common/src/main/scala/net/psforever/packet/game/ObjectDeployedMessage.scala b/common/src/main/scala/net/psforever/packet/game/ObjectDeployedMessage.scala new file mode 100644 index 00000000..007fb1ce --- /dev/null +++ b/common/src/main/scala/net/psforever/packet/game/ObjectDeployedMessage.scala @@ -0,0 +1,69 @@ +// Copyright (c) 2017 PSForever +package net.psforever.packet.game + +import net.psforever.packet.{GamePacketOpcode, Marshallable, PacketHelpers, PlanetSideGamePacket} +import scodec.Codec +import scodec.codecs._ +import shapeless.{::, HNil} + +/** + * Dispatched by the server when placing deployables to generate a message in the events chat.
+ *
+ * This packet does not actually modify anything in regards to deployables. + * It merely generates the message:
+ * `"You have placed x of a possible y thing."`
+ * ... where `x` is the current count of objects of this type that have been deployed; + * `y` is the (reported) maximum amount of objects of this type that can be deployed; + * and, `thing` is the label for objects of this type. + * This text is not directly placed into the message's field but, rather, is a token for language-appropriate descriptive text.
+ * "boomer," for example, is replaced by "Heavy Explosive Mines" in the message for English language. + * @param guid na + * @param desc descriptive text of what kind of object is being deployed; + * matches the `String` description of the object class + * @param unk na + * @param count the current number of this type of object deployed + * @param max the maximum number of this type of object that can be deployed + * @see `ObjectClass` + */ +final case class ObjectDeployedMessage(guid : PlanetSideGUID, + desc : String, + unk : Long, + count : Long, + max : Long) + extends PlanetSideGamePacket { + type Packet = ObjectDeployedMessage + def opcode = GamePacketOpcode.ObjectDeployedMessage + def encode = ObjectDeployedMessage.encode(this) +} + +object ObjectDeployedMessage extends Marshallable[ObjectDeployedMessage] { + /** + * Overloaded constructor for when the guid is not required. + * @param desc descriptive text of what kind of object is being deployed + * @param unk na + * @param count the number of this type of object deployed + * @param max the maximum number of this type of object that can be deployed + * @return an `ObjectDeployedMessage` object + */ + def apply(desc : String, unk : Long, count : Long, max : Long) : ObjectDeployedMessage = + new ObjectDeployedMessage(PlanetSideGUID(0), desc, unk, count, max) + + implicit val codec : Codec[ObjectDeployedMessage] = ( + ("object_guid" | PlanetSideGUID.codec) :: + ("desc" | PacketHelpers.encodedString) :: + ("unk" | uint32L) :: + ("count" | uint32L) :: + ("max" | uint32L) + ).xmap[ObjectDeployedMessage] ( + { + case guid :: str :: unk :: cnt ::mx :: HNil => + ObjectDeployedMessage(guid, str, unk, cnt, mx) + }, + { + case ObjectDeployedMessage(guid, str, unk, cnt, mx) => + //truncate string length to 100 characters; raise no warnings + val limitedStr : String = if(str.length() > 100) { str.substring(0,100) } else { str } + guid :: limitedStr :: unk :: cnt :: mx :: HNil + } + ) +} diff --git a/common/src/test/scala/game/ObjectDeployedMessageTest.scala b/common/src/test/scala/game/ObjectDeployedMessageTest.scala new file mode 100644 index 00000000..1910ceea --- /dev/null +++ b/common/src/test/scala/game/ObjectDeployedMessageTest.scala @@ -0,0 +1,32 @@ +// Copyright (c) 2017 PSForever +package game + +import org.specs2.mutable._ +import net.psforever.packet._ +import net.psforever.packet.game._ +import net.psforever.types.Vector3 +import scodec.bits._ + +class ObjectDeployedMessageTest extends Specification { + val string_boomer = hex"86 000086626F6F6D6572040000000100000019000000" + + "decode" in { + PacketCoding.DecodePacket(string_boomer).require match { + case ObjectDeployedMessage(guid : PlanetSideGUID, desc : String, unk : Long, count : Long, max : Long) => + guid mustEqual PlanetSideGUID(0) + desc mustEqual "boomer" + unk mustEqual 4 + count mustEqual 1 + max mustEqual 25 + case _ => + ko + } + } + + "encode" in { + val msg = ObjectDeployedMessage("boomer", 4, 1, 25) + val pkt = PacketCoding.EncodePacket(msg).require.toByteVector + + pkt mustEqual string_boomer + } +} From 261cea9269eeba8e08c246a5ae33845d442e1043 Mon Sep 17 00:00:00 2001 From: FateJH Date: Sat, 22 Apr 2017 20:15:51 -0400 Subject: [PATCH 3/4] noted defaultable values in comments --- .../net/psforever/packet/game/ObjectDeployedMessage.scala | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/common/src/main/scala/net/psforever/packet/game/ObjectDeployedMessage.scala b/common/src/main/scala/net/psforever/packet/game/ObjectDeployedMessage.scala index 007fb1ce..91542671 100644 --- a/common/src/main/scala/net/psforever/packet/game/ObjectDeployedMessage.scala +++ b/common/src/main/scala/net/psforever/packet/game/ObjectDeployedMessage.scala @@ -17,10 +17,12 @@ import shapeless.{::, HNil} * and, `thing` is the label for objects of this type. * This text is not directly placed into the message's field but, rather, is a token for language-appropriate descriptive text.
* "boomer," for example, is replaced by "Heavy Explosive Mines" in the message for English language. - * @param guid na + * @param guid na; + * usually 0? * @param desc descriptive text of what kind of object is being deployed; * matches the `String` description of the object class - * @param unk na + * @param unk na; + * usually 4 * @param count the current number of this type of object deployed * @param max the maximum number of this type of object that can be deployed * @see `ObjectClass` From 25864c87c1dd3b4792036c25e226733772796fcb Mon Sep 17 00:00:00 2001 From: FateJH Date: Sun, 23 Apr 2017 02:09:24 -0400 Subject: [PATCH 4/4] clarifying the unknwon fields and adding an enumeration for one of them --- .../packet/game/ObjectDeployedMessage.scala | 54 ++++++++++++------- .../game/ObjectDeployedMessageTest.scala | 9 ++-- 2 files changed, 40 insertions(+), 23 deletions(-) diff --git a/common/src/main/scala/net/psforever/packet/game/ObjectDeployedMessage.scala b/common/src/main/scala/net/psforever/packet/game/ObjectDeployedMessage.scala index 91542671..9b6e237a 100644 --- a/common/src/main/scala/net/psforever/packet/game/ObjectDeployedMessage.scala +++ b/common/src/main/scala/net/psforever/packet/game/ObjectDeployedMessage.scala @@ -7,29 +7,47 @@ import scodec.codecs._ import shapeless.{::, HNil} /** - * Dispatched by the server when placing deployables to generate a message in the events chat.
+ * An `Enumeration` for the forms of the event chat message produced by this packet. + */ +object DeploymentOutcome extends Enumeration(1) { + type Type = Value + + val Failure = Value(2) + //3 produces a Success message, but 4 is common + val Success = Value(4) + + val codec = PacketHelpers.createLongEnumerationCodec(this, uint32L) +} + +/** + * Dispatched by the server to generate a message in the events chat when placing deployables.
*
* This packet does not actually modify anything in regards to deployables. - * It merely generates the message:
- * `"You have placed x of a possible y thing."`
+ * The most common form of the generated message is:
+ * `"You have placed x of a possible y thing s."`
* ... where `x` is the current count of objects of this type that have been deployed; * `y` is the (reported) maximum amount of objects of this type that can be deployed; - * and, `thing` is the label for objects of this type. - * This text is not directly placed into the message's field but, rather, is a token for language-appropriate descriptive text.
- * "boomer," for example, is replaced by "Heavy Explosive Mines" in the message for English language. - * @param guid na; + * and, `thing` is the token for objects of this type. + * If the `thing` is a valid string token, it will be replaced by language-appropriate descriptive text in the message. + * Otherwise, that text is placed directly into the message, with an obvious space between the text and the "s". + * "boomer," for example, is replaced by "Boomer Heavy Explosives" in the message for English language. + * "bullet_9mm_AP," however, is just "bullet_9mm_AP s."
+ *
+ * When the `action` is `Success`, the message in the chat will be shown as above. + * When the `action` is `Failure`, the message will be:
+ * `"thing failed to deploy and was destroyed."`
+ * ... where, again, `thing` is a valid string token. + * @param unk na; * usually 0? * @param desc descriptive text of what kind of object is being deployed; - * matches the `String` description of the object class - * @param unk na; - * usually 4 + * string token of the object, at best + * @param action the form the message will take * @param count the current number of this type of object deployed * @param max the maximum number of this type of object that can be deployed - * @see `ObjectClass` */ -final case class ObjectDeployedMessage(guid : PlanetSideGUID, +final case class ObjectDeployedMessage(unk : Int, desc : String, - unk : Long, + action : DeploymentOutcome.Value, count : Long, max : Long) extends PlanetSideGamePacket { @@ -42,18 +60,18 @@ object ObjectDeployedMessage extends Marshallable[ObjectDeployedMessage] { /** * Overloaded constructor for when the guid is not required. * @param desc descriptive text of what kind of object is being deployed - * @param unk na + * @param action na * @param count the number of this type of object deployed * @param max the maximum number of this type of object that can be deployed * @return an `ObjectDeployedMessage` object */ - def apply(desc : String, unk : Long, count : Long, max : Long) : ObjectDeployedMessage = - new ObjectDeployedMessage(PlanetSideGUID(0), desc, unk, count, max) + def apply(desc : String, action : DeploymentOutcome.Value, count : Long, max : Long) : ObjectDeployedMessage = + new ObjectDeployedMessage(0, desc, action, count, max) implicit val codec : Codec[ObjectDeployedMessage] = ( - ("object_guid" | PlanetSideGUID.codec) :: + ("unk" | uint16L) :: ("desc" | PacketHelpers.encodedString) :: - ("unk" | uint32L) :: + ("action" | DeploymentOutcome.codec) :: ("count" | uint32L) :: ("max" | uint32L) ).xmap[ObjectDeployedMessage] ( diff --git a/common/src/test/scala/game/ObjectDeployedMessageTest.scala b/common/src/test/scala/game/ObjectDeployedMessageTest.scala index 1910ceea..88c9c0b7 100644 --- a/common/src/test/scala/game/ObjectDeployedMessageTest.scala +++ b/common/src/test/scala/game/ObjectDeployedMessageTest.scala @@ -4,7 +4,6 @@ package game import org.specs2.mutable._ import net.psforever.packet._ import net.psforever.packet.game._ -import net.psforever.types.Vector3 import scodec.bits._ class ObjectDeployedMessageTest extends Specification { @@ -12,10 +11,10 @@ class ObjectDeployedMessageTest extends Specification { "decode" in { PacketCoding.DecodePacket(string_boomer).require match { - case ObjectDeployedMessage(guid : PlanetSideGUID, desc : String, unk : Long, count : Long, max : Long) => - guid mustEqual PlanetSideGUID(0) + case ObjectDeployedMessage(unk : Int, desc : String, act : DeploymentOutcome.Value, count : Long, max : Long) => + unk mustEqual 0 desc mustEqual "boomer" - unk mustEqual 4 + act mustEqual DeploymentOutcome.Success count mustEqual 1 max mustEqual 25 case _ => @@ -24,7 +23,7 @@ class ObjectDeployedMessageTest extends Specification { } "encode" in { - val msg = ObjectDeployedMessage("boomer", 4, 1, 25) + val msg = ObjectDeployedMessage("boomer", DeploymentOutcome.Success, 1, 25) val pkt = PacketCoding.EncodePacket(msg).require.toByteVector pkt mustEqual string_boomer