From c68849fd1a597f25a2d1c7e3b1ee30ca8225937e Mon Sep 17 00:00:00 2001 From: Oliver Akins Date: Sun, 13 Mar 2022 01:48:23 -0600 Subject: [PATCH] Add docstrings to the IGameOption type --- common/src/types/GameOption.ts | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/common/src/types/GameOption.ts b/common/src/types/GameOption.ts index ee94642..cbd2484 100644 --- a/common/src/types/GameOption.ts +++ b/common/src/types/GameOption.ts @@ -1,7 +1,26 @@ +/** + * The object structure that represents an option that can be applied to the + * game's logic + */ export interface IGameOption { + + /** The user-friendly name of the option */ name: string; + + /** + * The ID that is used in the code to change what options are active in the + * game + */ id: string; + + /** Whether or not the host has activated this option */ active: boolean; + + /** + * Whether or not the option should be displayed to the users in the lobby + */ hidden: boolean; + + /** The description of the option that is put into the info modal. */ description: string; } \ No newline at end of file