Add docstrings to the IGameOption type
This commit is contained in:
parent
8eb4a3c48f
commit
c68849fd1a
1 changed files with 19 additions and 0 deletions
|
|
@ -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;
|
||||||
}
|
}
|
||||||
Loading…
Add table
Add a link
Reference in a new issue