Add documents for /server

2021-12-15 15:07:39 +08:00
parent f7bdf676cc
commit 1aebedb5b0
9 changed files with 82 additions and 52 deletions
--- a/server/gameplay.go
+++ b/server/gameplay.go
@ -6,5 +6,9 @@ import (
 )

 type GamePlay interface {
+	// AcceptPlayer handle everything after "LoginSuccess" is sent.
+	//
+	// Note: the connection will be closed after this function returned.
+	// You don't need to close the connection, but to keep not returning while the player is playing.
 	AcceptPlayer(name string, id uuid.UUID, protocol int32, conn *net.Conn)
 }