Oliver/Gravwell-Online
0
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add docs and types for the game.join event

Browse source
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
Download patch file Download diff file Expand all files Collapse all files

1
common/src/index.ts
View file

@ -9,5 +9,6 @@ export * from "./types/PlayerData";
// Server-Client Communications
export * from "./types/ServerResponse";
export * from "./types/events/SaveShip";
export * from "./types/events/game_join";
export * from "./types/events/server_info";
export * from "./types/events/game_create";

13
common/src/types/events/game_join.ts Normal file
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[];
}