Client–Server_Initialization

Client–Server Initialization

**HC SVNT DRACONES** This article outlines engine-level behavior. The following information is best suited for engine modders rather than game developers.

Client–Server initialization occurs in two or one Lua states depending on whether or not initialization takes place in a dedicated server context or in a listen server context, respectively.

Connecting to Dedicated Servers

In Vertex Adventure, the engine connects to the Prime Universe in the main menu.

game.client.gui.mainmenu

if ( not engine.isConnectedToServer() ) then
	if ( _DEBUG ) then
		engine.connect( "localhost" )
	else
		-- TODO: Update this to use a universe browser.
		engine.connect( "newton.andrewmcwatters.com" )
	end
else
	engine.disconnect()
end

Connecting to Listen Servers

Since Grid was written for Vertex Adventure, an MMORPG, and no server browser exists yet, connecting to a listen server is typically only done for debugging purposes by using the region console command.

engine.shared.region

concommand( "region", "Loads the specified region",
	function( _, _, _, _, argT )
		-- ...

		engine.connectToListenServer()
	end
)

Establishing a Connection

After making a call to either engine.connect() or engine.connectToListenServer(), Grid loads engine.client.network which then allows network.connect() or network.connectToListenServer() to be called.

Depending on which method is called, the engine will either use lua-enet to connect to the server or emulate the network procedures in-memory.

Stack Trace with console output

1. Connect to server in:

• Client game.client.gui.mainmenu or
• Client engine.shared.region

2. Client engine.connect() or engine.connectToListenServer()

• Connecting to address:port...

3. Server engine.onConnect()

• peer has connected.

4. Client engine.onConnect()

• Connected to the server!

5. Client sendAuthTicket()
6. Server

• Received payload "authenticate" from peer

7. Server engine.onPlayerAuthenticate()

• Player username has joined the game.

8. Server engine.sendServerInfo()

• Client

  • Received payload "serverInfo"

9. Client engine.sendClientInfo()

• Server

  • Received payload "clientInfo" from peer

10. Shared player:initialSpawn()

See Also

• Game Loop