Rename the event identifier in the type documentation

This commit is contained in:
Oliver-Akins 2022-01-03 18:50:35 -07:00
parent 988810b9eb
commit 7db70bc4ec

View file

@ -1,6 +1,6 @@
import { ServerResponse } from "../ServerResponse";
/** The data the client must provide in the `SaveShip` event. */
/** The data the client must provide in the `put.player.design` event. */
export interface SaveShip {
colour: string;
ship: string;
@ -8,7 +8,7 @@ export interface SaveShip {
/**
* The event that get's sent out to all the other players on a successful
* `SaveShip` event
* `put.player.design` event
*/
export interface DesignUpdate {
player: string;
@ -16,5 +16,5 @@ export interface DesignUpdate {
colour: string;
}
/** The response to the client that triggered the `SaveShip` event. */
/** The response to the client that triggered the `put.player.design` event. */
export interface SaveShipResponse extends ServerResponse {}