Add docs and types for the game.join event

This commit is contained in:
Oliver-Akins 2022-01-05 23:06:22 -07:00
parent 885c9c9e71
commit 3b5e643232
3 changed files with 31 additions and 1 deletions

View file

@ -0,0 +1,13 @@
import { ServerResponse } from "../ServerResponse";
import { PlayerData } from "../PlayerData";
/** The data required by the server to be able to join a game */
export interface IGameJoinRequest {
id: string;
name: string;
}
/** The response that the player receives upon succesfully joining a game. */
export interface IGameJoinResponse extends ServerResponse {
players?: PlayerData[];
}