Add docstrings to the IGameOption type

This commit is contained in:
Oliver Akins 2022-03-13 01:48:23 -06:00
parent 8eb4a3c48f
commit c68849fd1a
No known key found for this signature in database
GPG key ID: 3C2014AF9457AF99

View file

@ -1,7 +1,26 @@
/**
* The object structure that represents an option that can be applied to the
* game's logic
*/
export interface IGameOption { export interface IGameOption {
/** The user-friendly name of the option */
name: string; name: string;
/**
* The ID that is used in the code to change what options are active in the
* game
*/
id: string; id: string;
/** Whether or not the host has activated this option */
active: boolean; active: boolean;
/**
* Whether or not the option should be displayed to the users in the lobby
*/
hidden: boolean; hidden: boolean;
/** The description of the option that is put into the info modal. */
description: string; description: string;
} }