PSForever/PSF-BotServer
1
0
Fork 0
mirror of https://github.com/2revoemag/PSF-BotServer.git synced 2026-07-13 15:34:42 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add doc to ConnectToWorldMessage about hostname

Browse source
This commit is contained in:
Chord 2016-05-17 20:40:17 -04:00
parent d27bd7988c
commit 6b02d2faab
1 changed files with 8 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

10
common/src/main/scala/net/psforever/packet/game/ConnectToWorldMessage.scala
View file

@ -5,7 +5,13 @@ import net.psforever.packet.{GamePacketOpcode, Marshallable, PacketHelpers, Plan
import scodec.Codec import scodec.Codec
import scodec.codecs._ import scodec.codecs._
final case class ConnectToWorldMessage(server : String, serverIp : String, port : Int) /**
* Is sent in response to the PlanetSide client in order to give server information on the world server.
* @param server The name of the server to connect to
* @param serverAddress The IP or hostname of the server to connect to
* @param port The 16-bit port number to connect on
*/
final case class ConnectToWorldMessage(server : String, serverAddress : String, port : Int)
extends PlanetSideGamePacket { extends PlanetSideGamePacket {
type Packet = ConnectToWorldMessage type Packet = ConnectToWorldMessage
def opcode = GamePacketOpcode.ConnectToWorldMessage def opcode = GamePacketOpcode.ConnectToWorldMessage
@ -15,7 +21,7 @@ final case class ConnectToWorldMessage(server : String, serverIp : String, port
object ConnectToWorldMessage extends Marshallable[ConnectToWorldMessage] { object ConnectToWorldMessage extends Marshallable[ConnectToWorldMessage] {
implicit val codec : Codec[ConnectToWorldMessage] = ( implicit val codec : Codec[ConnectToWorldMessage] = (
("server_name" | PacketHelpers.encodedString) :: ("server_name" | PacketHelpers.encodedString) ::
("server_ip" | PacketHelpers.encodedString) :: ("server_address" | PacketHelpers.encodedString) ::
("server_port" | uint16L) ("server_port" | uint16L)
).as[ConnectToWorldMessage] ).as[ConnectToWorldMessage]
} }