Merge pull request #218 from Mazo/feature/TerminalHacking

Terminal hacking

common/src/main/scala/net/psforever/objects/serverobject/hackable/Hackable.scala

@@ -0,0 +1,49 @@
+package net.psforever.objects.serverobject.hackable
+
+import net.psforever.objects.Player
+import net.psforever.packet.game.{PlanetSideGUID, TriggeredSound}
+import net.psforever.types.Vector3
+
+trait Hackable {
+  /** An entry that maintains a reference to the `Player`, and the player's GUID and location when the message was received. */
+  private var hackedBy : Option[(Player, PlanetSideGUID, Vector3)] = None
+
+  private var hackSound : TriggeredSound.Value = TriggeredSound.HackDoor
+
+  def HackedBy : Option[(Player, PlanetSideGUID, Vector3)] = hackedBy
+
+  def HackedBy_=(agent : Player) : Option[(Player, PlanetSideGUID, Vector3)] = HackedBy_=(Some(agent))
+
+  /**
+    * Set the hack state of this object by recording important information about the player that caused it.
+    * Set the hack state if there is no current hack state.
+    * Override the hack state with a new hack state if the new user has different faction affiliation.
+    * @param agent a `Player`, or no player
+    * @return the player hack entry
+    */
+  def HackedBy_=(agent : Option[Player]) : Option[(Player, PlanetSideGUID, Vector3)] = {
+    hackedBy match {
+      case None =>
+        //set the hack state if there is no current hack state
+        if(agent.isDefined) {
+          hackedBy = Some(agent.get, agent.get.GUID, agent.get.Position)
+        }
+      case Some(_) =>
+        //clear the hack state
+        if(agent.isEmpty) {
+          hackedBy = None
+        }
+        //override the hack state with a new hack state if the new user has different faction affiliation
+        else if(agent.get.Faction != hackedBy.get._1.Faction) {
+          hackedBy = Some(agent.get, agent.get.GUID, agent.get.Position)
+        }
+    }
+    HackedBy
+  }
+
+  def HackSound : TriggeredSound.Value = hackSound
+  def HackSound_=(sound : TriggeredSound.Value) : TriggeredSound.Value = {
+    hackSound = sound
+    hackSound
+  }
+}

common/src/main/scala/net/psforever/objects/serverobject/locks/IFFLock.scala

@@ -1,10 +1,9 @@
 // Copyright (c) 2017 PSForever
 package net.psforever.objects.serverobject.locks
 
-import net.psforever.objects.Player
+import net.psforever.objects.serverobject.hackable.Hackable
 import net.psforever.objects.serverobject.structures.Amenity
-import net.psforever.packet.game.PlanetSideGUID
-import net.psforever.types.Vector3
+import net.psforever.packet.game.TriggeredSound
 
 /**
   * A structure-owned server object that is a "door lock."<br>
@@ -15,44 +14,9 @@ import net.psforever.types.Vector3
   * The `IFFLock` is ideally associated with a server map object - a `Door` - to which it acts as a gatekeeper.
   * @param idef the `ObjectDefinition` that constructs this object and maintains some of its immutable fields
   */
-class IFFLock(private val idef : IFFLockDefinition) extends Amenity {
-  /**
-    * An entry that maintains a reference to the `Player`, and the player's GUID and location when the message was received.
-    */
-  private var hackedBy : Option[(Player, PlanetSideGUID, Vector3)] = None
-
-  def HackedBy : Option[(Player, PlanetSideGUID, Vector3)] = hackedBy
-
-  def HackedBy_=(agent : Player) : Option[(Player, PlanetSideGUID, Vector3)] = HackedBy_=(Some(agent))
-
-  /**
-    * Set the hack state of this object by recording important information about the player that caused it.
-    * Set the hack state if there is no current hack state.
-    * Override the hack state with a new hack state if the new user has different faction affiliation.
-    * @param agent a `Player`, or no player
-    * @return the player hack entry
-    */
-  def HackedBy_=(agent : Option[Player]) : Option[(Player, PlanetSideGUID, Vector3)] = {
-    hackedBy match {
-      case None =>
-        //set the hack state if there is no current hack state
-        if(agent.isDefined) {
-          hackedBy = Some(agent.get, agent.get.GUID, agent.get.Position)
-        }
-      case Some(_) =>
-        //clear the hack state
-        if(agent.isEmpty) {
-          hackedBy = None
-        }
-        //override the hack state with a new hack state if the new user has different faction affiliation
-        else if(agent.get.Faction != hackedBy.get._1.Faction) {
-          hackedBy = Some(agent.get, agent.get.GUID, agent.get.Position)
-        }
-    }
-    HackedBy
-  }
-
+class IFFLock(private val idef : IFFLockDefinition) extends Amenity with Hackable {
   def Definition : IFFLockDefinition = idef
+  HackSound = TriggeredSound.HackDoor
 }
 
 object IFFLock {

common/src/main/scala/net/psforever/objects/serverobject/locks/IFFLockControl.scala

@@ -16,7 +16,7 @@ class IFFLockControl(lock : IFFLock) extends Actor with FactionAffinityBehavior.
   def receive : Receive = checkBehavior.orElse {
     case CommonMessages.Hack(player) =>
       lock.HackedBy = player
-
+      sender ! true
     case CommonMessages.ClearHack() =>
       lock.HackedBy = None
 

common/src/main/scala/net/psforever/objects/serverobject/mblocker/Locker.scala

@@ -3,10 +3,13 @@ package net.psforever.objects.serverobject.mblocker
 
 import akka.actor.{ActorContext, Props}
 import net.psforever.objects.GlobalDefinitions
+import net.psforever.objects.serverobject.hackable.Hackable
 import net.psforever.objects.serverobject.structures.Amenity
+import net.psforever.packet.game.TriggeredSound
 
-class Locker extends Amenity {
+class Locker extends Amenity with Hackable {
   def Definition : LockerDefinition = GlobalDefinitions.mb_locker
+  HackSound = TriggeredSound.HackTerminal
 }
 
 object Locker {

common/src/main/scala/net/psforever/objects/serverobject/mblocker/LockerControl.scala

@@ -2,6 +2,7 @@
 package net.psforever.objects.serverobject.mblocker
 
 import akka.actor.Actor
+import net.psforever.objects.serverobject.CommonMessages
 import net.psforever.objects.serverobject.affinity.{FactionAffinity, FactionAffinityBehavior}
 
 /**
@@ -12,6 +13,11 @@ class LockerControl(locker : Locker) extends Actor with FactionAffinityBehavior.
   def FactionObject : FactionAffinity = locker
 
   def receive : Receive = checkBehavior.orElse {
+    case CommonMessages.Hack(player) =>
+      locker.HackedBy = player
+      sender ! true
+    case CommonMessages.ClearHack() =>
+      locker.HackedBy = None
     case _ => ;
   }
 }

common/src/main/scala/net/psforever/objects/serverobject/terminals/ProximityTerminalControl.scala

@@ -2,6 +2,7 @@
 package net.psforever.objects.serverobject.terminals
 
 import akka.actor.Actor
+import net.psforever.objects.serverobject.CommonMessages
 import net.psforever.objects.serverobject.affinity.{FactionAffinity, FactionAffinityBehavior}
 
 /**
@@ -18,6 +19,11 @@ class ProximityTerminalControl(term : Terminal with ProximityUnit) extends Actor
   def receive : Receive = checkBehavior
     .orElse(proximityBehavior)
     .orElse {
+      case CommonMessages.Hack(player) =>
+        term.HackedBy = player
+        sender ! true
+      case CommonMessages.ClearHack() =>
+        term.HackedBy = None
       case _ => ;
     }
 

common/src/main/scala/net/psforever/objects/serverobject/terminals/Terminal.scala

@@ -3,48 +3,17 @@ package net.psforever.objects.serverobject.terminals
 
 import net.psforever.objects.Player
 import net.psforever.objects.definition.VehicleDefinition
+import net.psforever.objects.serverobject.hackable.Hackable
 import net.psforever.objects.serverobject.structures.Amenity
-import net.psforever.packet.game.{ItemTransactionMessage, PlanetSideGUID}
-import net.psforever.types.{TransactionType, Vector3}
+import net.psforever.packet.game.{ItemTransactionMessage, TriggeredSound}
+import net.psforever.types.TransactionType
 
 /**
   * A structure-owned server object that is a "terminal" that can be accessed for amenities and services.
   * @param tdef the `ObjectDefinition` that constructs this object and maintains some of its immutable fields
   */
-class Terminal(tdef : TerminalDefinition) extends Amenity {
-  /** An entry that maintains a reference to the `Player`, and the player's GUID and location when the message was received. */
-  private var hackedBy : Option[(Player, PlanetSideGUID, Vector3)] = None
-
-  def HackedBy : Option[(Player, PlanetSideGUID, Vector3)] = hackedBy
-
-  def HackedBy_=(agent : Player) : Option[(Player, PlanetSideGUID, Vector3)] = HackedBy_=(Some(agent))
-
-  /**
-    * Set the hack state of this object by recording important information about the player that caused it.
-    * Set the hack state if there is no current hack state.
-    * Override the hack state with a new hack state if the new user has different faction affiliation.
-    * @param agent a `Player`, or no player
-    * @return the player hack entry
-    */
-  def HackedBy_=(agent : Option[Player]) : Option[(Player, PlanetSideGUID, Vector3)] = {
-    hackedBy match {
-      case None =>
-        //set the hack state if there is no current hack state
-        if(agent.isDefined) {
-          hackedBy = Some(agent.get, agent.get.GUID, agent.get.Position)
-        }
-      case Some(_) =>
-        //clear the hack state
-        if(agent.isEmpty) {
-          hackedBy = None
-        }
-        //override the hack state with a new hack state if the new user has different faction affiliation
-        else if(agent.get.Faction != hackedBy.get._1.Faction) {
-          hackedBy = Some(agent.get, agent.get.GUID, agent.get.Position)
-        }
-    }
-    HackedBy
-  }
+class Terminal(tdef : TerminalDefinition) extends Amenity with Hackable {
+  HackSound = TriggeredSound.HackTerminal
 
   //the following fields and related methods are neither finalized nor integrated; GOTO Request
   private var health : Int = 100 //TODO not real health value

common/src/main/scala/net/psforever/objects/serverobject/terminals/TerminalControl.scala

@@ -2,6 +2,7 @@
 package net.psforever.objects.serverobject.terminals
 
 import akka.actor.Actor
+import net.psforever.objects.serverobject.CommonMessages
 import net.psforever.objects.serverobject.affinity.{FactionAffinity, FactionAffinityBehavior}
 
 /**
@@ -15,6 +16,12 @@ class TerminalControl(term : Terminal) extends Actor with FactionAffinityBehavio
     case Terminal.Request(player, msg) =>
       sender ! Terminal.TerminalMessage(player, msg, term.Request(player, msg))
 
+    case CommonMessages.Hack(player) =>
+      term.HackedBy = player
+      sender ! true
+    case CommonMessages.ClearHack() =>
+      term.HackedBy = None
+
     case _ => ;
   }
 

common/src/main/scala/net/psforever/packet/game/PlanetsideAttributeMessage.scala

@@ -118,6 +118,7 @@ import scodec.codecs._
   * `77 - Cavern Facility Captures. Value is the number of captures`<br>
   * `78 - Cavern Kills. Value is the number of kills`<br>
   * `106 - Custom Head`<br>
+  * `116 - Apply colour to REK beam and REK icon above players (0 = yellow, 1 = red, 2 = purple, 3 = blue)`<br>
   * Client to Server : <br>
   * `106 - Custom Head`<br>
   * <br>

common/src/main/scala/net/psforever/packet/game/TriggerSoundMessage.scala

@@ -16,8 +16,8 @@ object TriggeredSound extends Enumeration {
 
   val
   SpawnInTube,
-  Unknown1,
-  Hack,
+  HackTerminal,
+  HackVehicle,
   HackDoor,
   Unknown4,
   LockedOut,

common/src/main/scala/net/psforever/packet/game/UseItemMessage.scala

@@ -9,7 +9,7 @@ import scodec.codecs._
 /**
   * (Where the child object was before it was moved is not specified or important.)<br>
   * @param avatar_guid  the player.
-  * @param unk1         dont know how call that. It's the "item" ID when use a rek to hack or a medkit to heal.
+  * @param item_used_guid  The "item" GUID used e.g. a rek to hack or a medkit to heal.
   * @param object_guid  can be : Door, Terminal, Avatar (medkit).
   * @param unk2         ???
   * @param unk3         ??? true when use a rek (false when door, medkit or open equip term)
@@ -21,7 +21,7 @@ import scodec.codecs._
   * @param itemType     object ID from game_objects.adb (ex 612 is an equipment terminal, for medkit we have 121 (avatar))
   */
 final case class UseItemMessage(avatar_guid : PlanetSideGUID,
-                                unk1 : Int,
+                                item_used_guid : Int,
                                 object_guid : PlanetSideGUID,
                                 unk2 : Long,
                                 unk3 : Boolean,
@@ -40,7 +40,7 @@ final case class UseItemMessage(avatar_guid : PlanetSideGUID,
 object UseItemMessage extends Marshallable[UseItemMessage] {
   implicit val codec : Codec[UseItemMessage] = (
     ("avatar_guid" | PlanetSideGUID.codec) ::
-      ("unk1" | uint16L) ::
+      ("item_used_guid" | uint16L) ::
       ("object_guid" | PlanetSideGUID.codec) ::
       ("unk2" | uint32L) ::
       ("unk3" | bool) ::