Documentation update / enum additions

This commit is contained in:
Mazo 2021-01-26 23:02:43 +00:00
parent 0a342c3173
commit 805847793f
5 changed files with 49 additions and 6 deletions

View file

@ -19,8 +19,11 @@ import scodec.codecs._
* 07 - warning: missile lock<br>
* 08 - warning: Wasp missile lock<br>
* 09 - warning: T-REK lock<br>
* 11 - Drop special item e.g. LLU<br>
* 12 - sound: base captured fanfare<br>
* 14 - prompt: new character basic training<br>
* 15 - MAX Deploy<br>
* 16 - MAX Undeploy<br>
* 22 - message: awarded a cavern capture (updates cavern capture status)<br>
* 23 - award a cavern kill<br>
* 24 - message: you have been imprinted (updates imprinted status; does it?)<br>
@ -53,7 +56,21 @@ final case class GenericActionMessage(action: Int) extends PlanetSideGamePacket
}
object GenericActionMessage extends Marshallable[GenericActionMessage] {
def apply(action: GenericActionEnum.GenericActionEnum): GenericActionMessage = {
GenericActionMessage(action.id)
}
implicit val codec: Codec[GenericActionMessage] = (
"action" | uint(6)
).as[GenericActionMessage]
}
object GenericActionEnum extends Enumeration {
type GenericActionEnum = Value
/** Drop special item e.g. LLU */
val DropSpecialItem = Value(11)
/** Plays the base capture fanfare sound */
val BaseCaptureFanfare = Value(12)
}

View file

@ -21,6 +21,7 @@ import shapeless.{::, HNil}
* 11 - Deploy capital base shield pole with animation and broadcasts "The capitol force dome at X has been activated"
* 12 - Stow capital base shield pole with animation and broadcasts "The capitol force dome at X has been deactivated"
* 13 - Deploy capital base shield pole (instantly, unless still in the middle of the stow animation)
* 14 - Changes capture console to say "Facility hacked by the <Faction> LLU has been spawned." when looked at
* 15 - Displays "This facility's generator is under attack!"
* 16 - Displays "Generator has Overloaded! Evacuate Generator Room Immediately!"
* 17 - Displays "This facility's generator is back on line"
@ -41,6 +42,7 @@ import shapeless.{::, HNil}
* 53 - Put down an FDU
* 56 - Sets vehicle or player to be black ops
* 57 - Reverts player from black ops
* @see GenericObjectActionEnum
*/
final case class GenericObjectActionMessage(object_guid: PlanetSideGUID, code: Int) extends PlanetSideGamePacket {
type Packet = GenericObjectActionMessage
@ -49,6 +51,10 @@ final case class GenericObjectActionMessage(object_guid: PlanetSideGUID, code: I
}
object GenericObjectActionMessage extends Marshallable[GenericObjectActionMessage] {
def apply(object_guid: PlanetSideGUID, code: GenericObjectActionEnum.GenericObjectActionEnum): GenericObjectActionMessage = {
GenericObjectActionMessage(object_guid, code.id)
}
implicit val codec: Codec[GenericObjectActionMessage] = (
("object_guid" | PlanetSideGUID.codec) ::
("code" | uint(bits = 6)) ::
@ -64,3 +70,12 @@ object GenericObjectActionMessage extends Marshallable[GenericObjectActionMessag
}
)
}
object GenericObjectActionEnum extends Enumeration {
type GenericObjectActionEnum = Value
/** <b>Effect:</b> Capture console displays "Facility hacked by the <Faction> LLU has been spawned." when looked at<br>
* <b>Target</b>: CaptureTerminal
*/
val FlagSpawned = Value(14)
}

View file

@ -33,6 +33,7 @@ import scodec.codecs._
* `0x84` - 4 - knife holster<br>
* `0x86` - 6 - grid (1,1)<br>
* `0x00FA` - 250 - is a special dest/extra code that "attaches the item to the player's cursor"
* `0x00FC` - 252 - special item slot e.g. LLU (Possibly also cavern modules)
* @param parent_guid the parent object
* @param child_guid the child object
* @param slot a codified location within the parent object's inventory;

View file

@ -144,8 +144,8 @@ import scodec.codecs._
* `43 - Info on avatar name : 0 = Nothing, 1 = "(LD)" message`<br>
* `45 - NTU charge bar 0-10, 5 = 50% full. Seems to apply to both ANT and NTU Silo (possibly siphons?)`<br>
* `46 - Sends "Generator damage is at a critical level!" message`
* `47 - Sets base NTU level to CRITICAL. MUST use base MapId not base GUID`<br>
* `48 - Set to 1 to send base power loss message & turns on red warning lights throughout base. MUST use base MapId not base GUID`?<br>
* `47 - Sets base NTU level to CRITICAL.`<br>
* `48 - Set to 1 to send base power loss message & turns on red warning lights throughout base.<br>
* `49 - Vehicle texture effects state? (>0 turns on ANT panel glow or ntu silo panel glow + orbs) (bit?)`<br>
* `52 - Vehicle particle effects? (>0 turns on orbs going towards ANT. Doesn't affect silo) (bit?)`<br>
* `53 - LFS. Value is 1 to flag LFS`<br>
@ -161,7 +161,7 @@ import scodec.codecs._
* `55 - "Someone is attempting to Heal you". Value is 1`<br>
* `56 - "Someone is attempting to Repair you". Value is 1`<br>
* `64 - ????? related to using router telepads`
* `67 - Enables base shields (from cavern module/lock). MUST use base MapId not GUID`<br>
* `67 - Enables base shields (from cavern module/lock)`<br>
* `73 - "You are locked into the Core Beam. Charging your Module now.". Value is 1 to active`<br>
* `77 - Cavern Facility Captures. Value is the number of captures`<br>
* `78 - Cavern Kills. Value is the number of kills`<br>

View file

@ -248,14 +248,24 @@ object ChatMessageType extends Enum[ChatMessageType] {
case object CMT_REMOVE_VANUMODULE extends ChatMessageType // /moduleremove OR /modulerm
case object CMT_DEBUG_MASSIVE extends ChatMessageType // /debugmassive
case object CMT_WARP_TO_NEXT_BILLBOARD extends ChatMessageType // ???
case object UNK_222 extends ChatMessageType // ??? "CTF Flag stolen"
case object UNK_223 extends ChatMessageType // ??? "CTF Flag lost"
case object UNK_222 extends ChatMessageType // "CTF Flag stolen"
// Plays a trumpet-like sound and displays the message: "<Base Type> <Base Name> has spawned a LLU"
// "It must be taken to <Base Type> <Base Name>'s Control Console within 15 minutes or the hack will fail!"
// Example string: @CTF_FlagSpawned^@cryo_facility~^@Hanish~^@comm_station_dsp~^@Akkan~^15~
case object UNK_223 extends ChatMessageType // "CTF Flag lost"
// Handles both LLU lost and LLU resecured
// Example string: @CTF_Failed_SourceResecured^@TerranRepublic~^@Hanish~
// Output: "The Terran Republic resecured Hanish!" "The LLU was lost!"
// Example string: @CTF_Failed_FlagLost^@TerranRepublic~^@Hanish~
// Output: "The Terran Republic lost Hanish's LLU" "Hack canceled!"
case object UNK_224 extends ChatMessageType // ??? "Vehicle Dismount"
case object UNK_225 extends ChatMessageType // ??? empty
case object UNK_226 extends ChatMessageType // ??? empty
case object UNK_227 extends ChatMessageType // ??? empty
case object UNK_228 extends ChatMessageType // ??? empty
case object UNK_229 extends ChatMessageType // ??? empty
case object UNK_229 extends ChatMessageType // See UNK_222 - seems to do the same except without trumpet-like sound
// Is used for flag pickup @CTF_FlagPickedUp^OzTurtle~^@NewConglomerate~^@Qumu~
// Or flag warning @CTF_Warning_Carrier^VanuHemlock~^@VanuSovereigncy~^@Mani~^@Dagur~^10~
case object UNK_230 extends ChatMessageType // ??? "Vehicle Mount"
case object UNK_231 extends ChatMessageType // ??? empty
case object UNK_232 extends ChatMessageType // ??? empty