Update documentation

This commit is contained in:
Mazo 2018-06-02 14:09:42 +01:00
parent 5347b78e7c
commit 27d8f91cec
5 changed files with 17 additions and 7 deletions

View file

@ -10,11 +10,11 @@ import net.psforever.types.BailType
* Dispatched by the client when the player wishes to get out of a vehicle.
* @param player_guid the player
* @param bailType The dismount action e.g. normal dismount, kicked by owner, bailed
* @param unk2 na
* @param wasKickedByDriver Seems to be true if a passenger was manually kicked by the vehicle owner
*/
final case class DismountVehicleMsg(player_guid : PlanetSideGUID,
bailType : BailType.Value,
wasKickedByDriver : Boolean) // Seems to be true if a passenger was manually kicked by the vehicle owner
wasKickedByDriver : Boolean)
extends PlanetSideGamePacket {
type Packet = DismountVehicleMsg
def opcode = GamePacketOpcode.DismountVehicleMsg

View file

@ -12,6 +12,10 @@ import shapeless.{::, HNil}
* (Write more some other time.)
* @param object_guid the target object
* @param code the action code
* 96, 97, 98, 99 - Makes the vehicle bounce slightly. Have seen this in packet captures after taking a vehicle through a warpgate
* 200, 201, 202, 203 - For aircraft - client shows "THe bailing mechanism failed! To fix the mechanism, land and repair the vehicle!"
* 224 - Sets vehicle or player to be black ops
* 228 - Reverts player from black ops
*/
final case class GenericObjectActionMessage(object_guid : PlanetSideGUID,
code : Int)

View file

@ -129,6 +129,7 @@ import scodec.codecs._
* `21 - Asserts first time event eligibility / makes owner if no owner is assigned`<br>
* `22 - Toggles gunner and passenger mount points (1 = hides, 0 = reveals; this also locks their permissions)`<br>
* `68 - ???`<br>
* `79 - ???`<br>
* `80 - Damage vehicle (unknown value)`<br>
* `81 - ???`<br>
* `113 - ???`

View file

@ -33,14 +33,19 @@ import scodec.codecs._
* @param lock_accelerator driver has no control over vehicle acceleration
* @param lock_wheel driver has no control over vehicle turning
* @param reverse move in reverse
* 0 = forward
* 1 = reverse
* @param unk4 na;
* something to do with vehicle bailable speed
* @param lock_vthrust pilot has no control over vertical thrust;
* asserts a constant positive vertical thrust;
* the only valid setting appears to be 1
* @param lock_strafe pilot has no control over strafing thrust;
* the only valid setting appears to be 1
* @param forward_speed "something like speed"
* 0 = not locked
* 1 = no strafing
* 2 = strafe left automatically
* 3 = strafe right automatically
* @param movement_speed "something like speed"
* @param unk8 na;
* set `lock_wheel` to `true` to expose this value
*/
@ -50,7 +55,7 @@ final case class ServerVehicleOverrideMsg(lock_accelerator : Boolean,
unk4 : Boolean,
lock_vthrust : Int,
lock_strafe : Int,
forward_speed : Int,
movement_speed : Int,
unk8 : Option[Long]
) extends PlanetSideGamePacket {
type Packet = ServerVehicleOverrideMsg
@ -66,7 +71,7 @@ object ServerVehicleOverrideMsg extends Marshallable[ServerVehicleOverrideMsg] {
("unk4" | bool) ::
("lock_vthrust" | uint2L) ::
("lock_strafe" | uint2L) ::
("forward_speed" | uintL(9)) ::
("movement_speed" | uintL(9)) ::
conditional(test, "unk8" | uint32L)
})
).as[ServerVehicleOverrideMsg]

View file

@ -21,7 +21,7 @@ import scodec.codecs._
* 15 for straight;
* 0 for hard right;
* 30 for hard left
* @param unk5 na
* @param unk5 na - Possibly a flag to indicate the vehicle is attached to something else e.g. is in a galaxy/lodestar cargo bay
* @param unk6 na
* @see `PlacementData`
*/