PSForever/PSF-BotServer
1
0
Fork 0
mirror of https://github.com/2revoemag/PSF-BotServer.git synced 2026-02-12 19:31:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

updated comments to BroadcastWarpgateUpdate to reflect new information

Browse source
This commit is contained in:
FateJH 2017-02-09 22:43:52 -05:00
parent 3c98954a50
commit bea1a0aad2
2 changed files with 17 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

36
common/src/main/scala/net/psforever/packet/game/BroadcastWarpgateUpdateMessage.scala
View file

@ -6,29 +6,27 @@ import scodec.Codec
import scodec.codecs._
/**
* Promotes a Broadcast Warpgate.
*
* Change the map name of a warpgate into "Broadcast Warpgate."
* Promotes a warpgate's "broadcast" functionality.<br>
* <br>
* Change the map name of a warpgate into "Broadcast" when the proper state is set.
* If a proper warpgate is not designated, nothing happens.
* The input state is a byte starting at `00` where the first valid "on" state is `20`.
* Subsequent "on" states are '40' values apart - '20', '60', 'A0', and 'E0'.
* 'C0' is an uncommon value.
* All other numbers (seem to) default to the normal map designation for the warpgate.
*
* Exploration: is this packet merely cosmetic or does it change the functionality of a warpgate too?
* Exploration: are there any differences between the states besides "on" and "off"?
*
* If not set, the map name of the warpgate will default to whatever is normally written on the map.
* The map designation of geowarps is not affected by this packet.<br>
* <br>
* Exploration:<br>
* I believe these `Boolean` values actually indicate some measure of warpgate operation.
* Geowarps, for example, though their appearance does not change, recieve this packet.
* Moreover, they can operate as a receiving-end broadcast gate.
* @param continent_guid identifies the zone (continent)
* @param building_guid identifies the warpgate (see `BuildingInfoUpdateMessage`)
* @param state1 na
* @param state2 na
* @param is_broadcast if true, the gate replaces its destination text with "Broadcast;"
* the owner faction may shortcut between disconnected gates along the intercontinental lattice
* @param unk1 na
* @param unk2 na
* @param is_broadcast if true, the gate replaces its destination text with "Broadcast"
*/
final case class BroadcastWarpgateUpdateMessage(continent_guid : PlanetSideGUID,
building_guid : PlanetSideGUID,
state1 : Boolean,
state2 : Boolean,
unk1 : Boolean,
unk2 : Boolean,
is_broadcast : Boolean)
extends PlanetSideGamePacket {
type Packet = BroadcastWarpgateUpdateMessage
@ -40,8 +38,8 @@ object BroadcastWarpgateUpdateMessage extends Marshallable[BroadcastWarpgateUpda
implicit val codec : Codec[BroadcastWarpgateUpdateMessage] = (
("continent_guid" | PlanetSideGUID.codec) ::
("building_guid" | PlanetSideGUID.codec) ::
("state1" | bool) ::
("state2" | bool) ::
("unk1" | bool) ::
("unk2" | bool) ::
("is_broadcast" | bool)
).as[BroadcastWarpgateUpdateMessage]
}