codePugHacKEr/bedrock-protocol
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update docs and error handling (#155)

Browse source
This commit is contained in:
extremeheat 2021-11-28 00:57:41 -05:00 • committed by GitHub
commit b0856e0cc7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 34 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

11
docs/API.md
View file

@ -23,6 +23,14 @@ Returns a `Client` instance and connects to the server.
| authTitle | *optional* | The client ID to sign in as, defaults to Minecraft for Nintendo Switch. Set false to sign in through Azure. See prismarine-auth |
| deviceType | *optional* | The device type to sign in as, defaults to "Nintendo". See prismarine-auth |
The following events are emitted by the client:
* 'status' - When the client's login sequence status has changed
* 'join' - When the client has joined the server after authenticating
* 'spawn' - When the client has spawned into the game world, as it is getting chunks
* 'kick' - The server has kicked the client
* 'close' - The server has closed the connection
* 'error' - An recoverable exception has happened. Not catching will throw an exception
## be.createServer(options) : Server
Returns a `Server` instance and starts listening for clients. All clients will be
@ -88,6 +96,9 @@ Order of server client event emissions:
* 'join' - the client is ready to recieve game packets after successful server-client handshake/encryption
* 'spawn' - emitted after the client lets the server know that it has successfully spawned
'error' event is emitted when a catchable exception happens with a client (for example receiving a bad encrypted packet).
## Client docs
You can create a server as such: