From c4a16e5695d660d2cf8b5a4e3f13a308327d4cc8 Mon Sep 17 00:00:00 2001 From: Oliver-Akins Date: Thu, 1 Oct 2020 21:08:04 -0600 Subject: [PATCH] Add docstring --- src/events/PresidentPolicies.ts | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/src/events/PresidentPolicies.ts b/src/events/PresidentPolicies.ts index 0a72350..de91b20 100644 --- a/src/events/PresidentPolicies.ts +++ b/src/events/PresidentPolicies.ts @@ -1,3 +1,15 @@ +/* +This is triggered whenever the president selects two policies to give to the +chancellor. This verifies the client sending the event is in fact the president +if the player is not the active president, this will return an error event. + +Emissions: + PresidentResponse - This is returned to the client so that the president + knows if the choice went through or not and if there was an error along + the way. + ChancellorChoice - This emits to everyone, but only the active chancellor's + client should do anything. +*/ import { Socket } from 'socket.io'; export const PresidentPolicies = (socket: Socket, data: PresidentPolicies) => { console.log(`Received Presidential policies`);