forked from AY2425S1-CS2103T-T12-4/tp
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request AY2425S1-CS2103T-T12-4#218
Update UG with addgame and deletegame
- Loading branch information
Showing
1 changed file
with
33 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -87,13 +87,15 @@ Underneath each suggested command is the syntax for that command and what parame | |
|
|
||
| ## Command summary | ||
|
|
||
| | Action | Format, Examples | | ||
| |---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | **Help** | `help` | | ||
| | **List** | `list` | | ||
| | **Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [g/GAME]… [t/TAG]… [pt/TIME]…` <br> e.g., `add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 g/Overwatch t/friend t/colleague pt/2130` | | ||
| | **Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [g/Game]… [t/TAG]… [pt/TIME]…`<br> e.g.,`edit 2 n/James Lee e/[email protected]` | | ||
| | **EditGame** | `editgame INDEX g/GAME [u/USERNAME] [s/SKILLLEVEL] [r/ROLE]`<br> e.g.,`editgame 1 g/Overwatch u/Potato` | | ||
| | Action | Format, Examples | | ||
| |----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | **Help** | `help` | | ||
| | **List** | `list` | | ||
| | **Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [g/GAME]… [t/TAG]… [pt/TIME]…` <br> e.g., `add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 g/Overwatch t/friend t/colleague pt/2130` | | ||
| | **Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [g/Game]… [t/TAG]… [pt/TIME]…`<br> e.g.,`edit 2 n/James Lee e/[email protected]` | | ||
| | **AddGame** | `addgame INDEX g/GAME [u/USERNAME] [s/SKILLLEVEL] [r/ROLE]`<br> e.g.,`addgame 1 g/Overwatch u/Potato` | | ||
| | **EditGame** | `editgame INDEX g/GAME [u/USERNAME] [s/SKILLLEVEL] [r/ROLE]`<br> e.g.,`editgame 1 g/Overwatch u/Potato` | | ||
| | **DeleteGame** | `deletegame INDEX g/GAME`<br> e.g.,`deletegame 1 g/Overwatch u/Potato` | | ||
| | **FavGame** | `favgame INDEX g/GAME`<br> e.g.,`favgame 2 g/Overwatch` | | ||
| | **UnFavGame** | `unfavgame INDEX g/GAME`<br> e.g.,`unfavgame 2 g/Overwatch` | | ||
| | **Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake` | | ||
|
|
@@ -159,6 +161,19 @@ Examples: | |
| * `edit 2 n/Matthew g/Overwatch g/Valorant` Edits the name of the 2nd person to be `Matthew` with games `Overwatch` and `Valorant`. | ||
| * `edit 2 n/Betsy Crower t/ pt/` Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags and preferred times. | ||
|
|
||
| ### Adding a game : `addgame` | ||
|
|
||
| Adds a game to an existing person in the address book. | ||
|
|
||
| Format: `addgame INDEX g/GAME [u/USERNAME] [s/SKILLLEVEL] [r/ROLE]` | ||
|
|
||
| * Adds a game `GAME` to the person at the specified `INDEX`. The index refers to the index number shown in the displayed person list. The index **must be a positive integer** 1, 2, 3, … | ||
| * If the game `GAME` already exists for that person, it will not be added. It may be edited using the editgame command instead. | ||
|
|
||
| Examples: | ||
| * `addgame 1 g/Overwatch` Adds the game `Overwatch` to the 1st person. | ||
| * `addgame 2 g/League of Legends u/Potato s/Pro r/Support` Adds the game `League of Legends` to the 2nd person with the following information: Username: `Potato` Skill level: `Pro` Role: `Support` | ||
|
|
||
| ### Editing a game : `editgame` | ||
|
|
||
| Edits the game of an existing person in the address book. | ||
|
|
@@ -173,6 +188,17 @@ Examples: | |
| * `editgame 1 g/Overwatch u/Potato` Edits the username of game `Overwatch` of the 1st person to be `Potato`. | ||
| * `editgame 2 g/League of Legends u/Potato s/Pro r/Support` Edits the game `League of Legends` of the 2nd person to have the following information: Username: `Potato` Skill level: `Pro` Role: `Support` | ||
|
|
||
| ### Deleting a game : `deletegame` | ||
|
|
||
| Deletes the specified game from an existing person in the address book. | ||
|
|
||
| Format: `deletegame INDEX g/GAME` | ||
|
|
||
| * Deletes the game `GAME` of the person at the specified `INDEX`. | ||
| * The index refers to the index number shown in the displayed person list. | ||
| * The index **must be a positive integer** 1, 2, 3, … | ||
|
|
||
|
|
||
| ### Favouriting a game : `favgame` | ||
|
|
||
| Gives a **singular** game under an existing person in the address book the "favourite" status. | ||
|
|
||