Add docstring

This commit is contained in:
Oliver-Akins 2020-10-01 21:08:04 -06:00
parent 64b5428136
commit c4a16e5695

View file

@ -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'; import { Socket } from 'socket.io';
export const PresidentPolicies = (socket: Socket, data: PresidentPolicies) => { export const PresidentPolicies = (socket: Socket, data: PresidentPolicies) => {
console.log(`Received Presidential policies`); console.log(`Received Presidential policies`);