update documentation

1 files changed, 4 insertions, 4 deletions

diff --git a/test-client/protocol.ts b/test-client/protocol.ts
index 0d2183dd..3bceb351 100644
--- a/test-client/protocol.ts
+++ b/test-client/protocol.ts
@@ -16,9 +16,9 @@
 
 */
 export type Vec2 = [number, number] // x, y
-export type PlayerID = number
-export type ItemIndex = number
-export type TileIndex = number
+export type PlayerID = number // opaque number to identify players.
+export type ItemIndex = number // index used primarily for item_names in Gamedata
+export type TileIndex = number // index used primarily for tile_names in Gamedata
 
 export interface MapMetadata {
     name: string,
@@ -32,7 +32,7 @@ export interface Gamedata {
     tile_collide: boolean[], // Look-up table for TileIndex to check tile collision with players
     tile_interact: boolean[], // Look-up table for TileIndex to check if a tile is interactable
     spawn: Vec2, // Where players spawn when they join.
-    maps: [string, MapMetadata][],
+    maps: [string, MapMetadata][], // Metadata for most available maps
 }
 
 export type PacketS =