vel
/
VelNet-Unity
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

change bullet formatting to work on mkdocs

main
Anton Franzluebbers 2023-09-14 14:01:27 -04:00
parent 9d8b7378c6
commit 758d5836d3
1 changed files with 49 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

98
Documentation/docs/client/implementation/message-types.md
View File

@ -23,16 +23,16 @@ public enum MessageSendType
``` ```
### MESSAGE_LOGIN = 0 ### MESSAGE_LOGIN = 0
This message contains: This message contains:
- `byte` - The length of the deviceId string - `byte` - The length of the deviceId string
- `byte[]` - UTF8 encoding of the deviceId string - `byte[]` - UTF8 encoding of the deviceId string
- `byte` - The length of the appName string - `byte` - The length of the appName string
- `byte[]` - UTF8 encoding of the appName string - `byte[]` - UTF8 encoding of the appName string
### MESSAGE_GETROOMS = 1 ### MESSAGE_GETROOMS = 1
This message contains no data, just the single-byte header. This message contains no data, just the single-byte header.
### MESSAGE_JOINROOM = 2 ### MESSAGE_JOINROOM = 2
This message contains: This message contains:
- `byte` - The length of the roomName string - `byte` - The length of the roomName string
- `byte[]` - UTF8 encoding of the roomName string - `byte[]` - UTF8 encoding of the roomName string
### MESSAGE_OTHERS = 3 ### MESSAGE_OTHERS = 3
### MESSAGE_ALL = 4 ### MESSAGE_ALL = 4
### MESSAGE_GROUP = 5 ### MESSAGE_GROUP = 5
@ -58,63 +58,63 @@ public enum MessageReceivedType
``` ```
### LOGGED_IN = 0 ### LOGGED_IN = 0
This message contains: This message contains:
- `int` - The userid given by the server to this user. - `int` - The userid given by the server to this user.
### ROOM_LIST = 1 ### ROOM_LIST = 1
This message contains: This message contains:
- `int` - The length of the room mesesage string. This is an int instead of a byte because of the possible string length with many rooms. - `int` - The length of the room mesesage string. This is an int instead of a byte because of the possible string length with many rooms.
- `byte[]` - A UTF8-encoded string for the room message - `byte[]` - A UTF8-encoded string for the room message
- This string is encoded as a comma-separated list of rooms, with the format `name:numUsers` for each room. - This string is encoded as a comma-separated list of rooms, with the format `name:numUsers` for each room.
- e.g. `Common_1:0:3,Auditorium_123:0,room1:10` - e.g. `Common_1:0:3,Auditorium_123:0,room1:10`
### PLAYER_JOINED = 2 ### PLAYER_JOINED = 2
This message contains: This message contains:
- `int` - The userid of the player that joined - `int` - The userid of the player that joined
- `byte` - The length of the room name string - `byte` - The length of the room name string
- `byte[]` - A UTF8-encoded string for the room name - `byte[]` - A UTF8-encoded string for the room name
### DATA_MESSAGE = 3 ### DATA_MESSAGE = 3
This message contains: This message contains:
- `int` - The userid of the player that sent this message - `int` - The userid of the player that sent this message
- `int` - The size of the payload - `int` - The size of the payload
- `byte[]` - The message data - `byte[]` - The message data
- Decoding the actual message data is handled in `VelNetPlayer.cs` - Decoding the actual message data is handled in `VelNetPlayer.cs`
- Within DATA_MESSAGE messages, there is an additonal type header: - Within DATA_MESSAGE messages, there is an additonal type header:
```cs ```cs
public enum MessageType : byte public enum MessageType : byte
{ {
ObjectSync, ObjectSync,
TakeOwnership, TakeOwnership,
Instantiate, Instantiate,
InstantiateWithTransform, InstantiateWithTransform,
Destroy, Destroy,
DeleteSceneObjects, DeleteSceneObjects,
Custom Custom
} }
``` ```
### MASTER_MESSAGE = 4 ### MASTER_MESSAGE = 4
This message contains: This message contains:
- `int` - The new master client id. The sender of this message is the master. - `int` - The new master client id. The sender of this message is the master.
### YOU_JOINED = 5 ### YOU_JOINED = 5
This is returned after you join a room. This is returned after you join a room.
This message contains: This message contains:
- `int` - The number of players in the room - `int` - The number of players in the room
- For each player: - For each player:
- `int` - The player's userid - `int` - The player's userid
- `byte` - The length of the room name string - `byte` - The length of the room name string
- `byte[]` - A UTF8-encoded string for the room name - `byte[]` - A UTF8-encoded string for the room name
### PLAYER_LEFT = 6 ### PLAYER_LEFT = 6
This message contains: This message contains:
- `int` - The player's userid - `int` - The player's userid
- `byte` - The length of the room name string - `byte` - The length of the room name string
- `byte[]` - A UTF8-encoded string for the room name - `byte[]` - A UTF8-encoded string for the room name
### YOU_LEFT = 7 ### YOU_LEFT = 7
This message contains: This message contains:
- `byte` - The length of the room name string - `byte` - The length of the room name string
- `byte[]` - A UTF8-encoded string for the room name - `byte[]` - A UTF8-encoded string for the room name
### ROOM_DATA = 8 ### ROOM_DATA = 8
This message contains: This message contains:
- `byte` - The length of the room name string - `byte` - The length of the room name string
- `byte[]` - A UTF8-encoded string for the room name - `byte[]` - A UTF8-encoded string for the room name
- `int` - The number of client data blocks to read - `int` - The number of client data blocks to read
- For each client data block: - For each client data block:
- `int` - The userid of this client - `int` - The userid of this client
- `byte` - The length of the username string - `byte` - The length of the username string
- `byte[]` - A UTF8-encoded string for the username - `byte[]` - A UTF8-encoded string for the username