| ... | ... | @@ -279,9 +279,9 @@ |
|
|
|
## Front-end emitters
|
|
|
|
|
|
|
|
### Approve File
|
|
|
|
| Socket | Description | User | Listeners |
|
|
|
|
|--------|-------------|------|-----------|
|
|
|
|
| `approveFile` | Changes player submission's status to `"Approved"` or `"Rejected"` | Gamemaster | [`fileStatusPlayer`](#file-status-player)<br>[`newFile`](#new-file)<br>[`finalScore_update`](#final-score-update) |
|
|
|
|
| Socket | Description | User | Listeners |File|
|
|
|
|
|--------|-------------|------|-----------|--|
|
|
|
|
| `approveFile` | Changes player submission's status to `"Approved"` or `"Rejected"` | Gamemaster | [`fileStatusPlayer`](#file-status-player)<br>[`newFile`](#new-file)<br>[`finalScore_update`](#final-score-update) |[approvalFile](https://gitlab.labranet.jamk.fi/wimma-lab-2022/iotitude/source-backend/-/blob/development/src/socket/listeners/fileListeners/approvalFile.js)|
|
|
|
|
|
|
|
|
<details>
|
|
|
|
<summary><b>Required payload</b></summary>
|
| ... | ... | @@ -301,27 +301,27 @@ Requires gamemaster `token`. |
|
|
|
---
|
|
|
|
|
|
|
|
### Fetch Scoreboard
|
|
|
|
| Socket | Description | User | Listeners |
|
|
|
|
|--------|-------------|------|-----------|
|
|
|
|
| `fetchScoreBoard` | Triggers `finalScore_update` socket listener. The listener will get challenge room's scoreboard information. | All | [`finalScore_update`](#final-score-update) |
|
|
|
|
| Socket | Description | User | Listeners |File|
|
|
|
|
|--------|-------------|------|-----------|--|
|
|
|
|
| `fetchScoreBoard` | Triggers `finalScore_update` socket listener. The listener will get challenge room's scoreboard information. | All | [`finalScore_update`](#final-score-update) |[fetchScoreBoard](https://gitlab.labranet.jamk.fi/wimma-lab-2022/iotitude/source-backend/-/blob/development/src/socket/listeners/challengeListeners/fetchScoreBoard.js)|
|
|
|
|
|
|
|
|
Requires `token`.
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
### List Files
|
|
|
|
| Socket | Description | User | Listeners |
|
|
|
|
|--------|-------------|------|-----------|
|
|
|
|
| `listFiles` | Triggers `newFile` listener to receive all unreviewed challenge files in the challenge room. | Gamemaster | [`newFile`](#new-file) |
|
|
|
|
| Socket | Description | User | Listeners |File|
|
|
|
|
|--------|-------------|------|-----------|--|
|
|
|
|
| `listFiles` | Triggers `newFile` listener to receive all unreviewed challenge files in the challenge room. | Gamemaster | [`newFile`](#new-file) |[listFiles](https://gitlab.labranet.jamk.fi/wimma-lab-2022/iotitude/source-backend/-/blob/development/src/socket/listeners/fileListeners/listFiles.js)|
|
|
|
|
|
|
|
|
Requires gamemaster `token`.
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
### Modify Challenge
|
|
|
|
| Socket | Description | User | Listeners |
|
|
|
|
|--------|-------------|------|-----------|
|
|
|
|
| `modifyChallenge` | Changes room's information | Gamemaster | [`challengeModify`](#challenge-modify) |
|
|
|
|
| Socket | Description | User | Listeners |File|
|
|
|
|
|--------|-------------|------|-----------|--|
|
|
|
|
| `modifyChallenge` | Changes room's information | Gamemaster | [`challengeModify`](#challenge-modify) |[modifyChallenge](https://gitlab.labranet.jamk.fi/wimma-lab-2022/iotitude/source-backend/-/blob/development/src/socket/listeners/challengeListeners/modifyChallenge.js)|
|
|
|
|
|
|
|
|
<details>
|
|
|
|
<summary><b>Required payload</b></summary>
|
| ... | ... | @@ -343,9 +343,9 @@ Requires gamemaster `token`. |
|
|
|
---
|
|
|
|
|
|
|
|
### Remove Player
|
|
|
|
| Socket | Description | User | Listeners |
|
|
|
|
|--------|-------------|------|-----------|
|
|
|
|
| `removePlayer` | Removes player from the challenge room. | Gamemaster | [`youWereRemoved`](#you-were-removed)<br>[`finalScore_update`](#final-score-update)<br>[`playerWasRemoved`](#player-was-removed) |
|
|
|
|
| Socket | Description | User | Listeners |File|
|
|
|
|
|--------|-------------|------|-----------|--|
|
|
|
|
| `removePlayer` | Removes player from the challenge room. | Gamemaster | [`youWereRemoved`](#you-were-removed)<br>[`finalScore_update`](#final-score-update)<br>[`playerWasRemoved`](#player-was-removed) |[removePlayer](https://gitlab.labranet.jamk.fi/wimma-lab-2022/iotitude/source-backend/-/blob/development/src/socket/listeners/utilitiesListener/removePlayer.js)|
|
|
|
|
|
|
|
|
<details>
|
|
|
|
<summary><b>Required payload</b></summary>
|
| ... | ... | @@ -363,27 +363,27 @@ Requires gamemaster `token`. |
|
|
|
---
|
|
|
|
|
|
|
|
### Fetch Player File Statuses
|
|
|
|
| Socket | Description | User | Listeners |
|
|
|
|
|--------|-------------|------|-----------|
|
|
|
|
| `fetchPlayerFileStatuses` | Triggers `playerFileStatuses` to receive array of all the player's submissions. | Player | [`playerFileStatuses`](#player-file-statuses) |
|
|
|
|
| Socket | Description | User | Listeners |File|
|
|
|
|
|--------|-------------|------|-----------|--|
|
|
|
|
| `fetchPlayerFileStatuses` | Triggers `playerFileStatuses` to receive array of all the player's submissions. | Player | [`playerFileStatuses`](#player-file-statuses) |[fetchPlayerFileStatuses](https://gitlab.labranet.jamk.fi/wimma-lab-2022/iotitude/source-backend/-/blob/development/src/socket/listeners/fileListeners/fetchPlayerFileStatuses.js)|
|
|
|
|
|
|
|
|
Requires `token`.
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
### Start Game
|
|
|
|
| Socket | Description | User | Listeners |
|
|
|
|
|--------|-------------|------|-----------|
|
|
|
|
| `startGame` | Changes challenge room's starting time to current time, so it will start immediately | Gamemaster | [`gameStarted`](#game-started)
|
|
|
|
| Socket | Description | User | Listeners |File|
|
|
|
|
|--------|-------------|------|-----------|--|
|
|
|
|
| `startGame` | Changes challenge room's starting time to current time, so it will start immediately | Gamemaster | [`gameStarted`](#game-started)|[startGame](https://gitlab.labranet.jamk.fi/wimma-lab-2022/iotitude/source-backend/-/blob/development/src/socket/listeners/challengeListeners/startGame.js)|
|
|
|
|
|
|
|
|
Requires gamemaster `token`.
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
### Pause Game
|
|
|
|
| Socket | Description | User | Listeners |
|
|
|
|
|--------|-------------|------|-----------|
|
|
|
|
| `pauseGame` | Changes challenge room's pause status and extends game times with given pause time. | Gamemaster | [`gamePauseChanged`](#game-pause-changed)
|
|
|
|
| Socket | Description | User | Listeners |File|
|
|
|
|
|--------|-------------|------|-----------|--|
|
|
|
|
| `pauseGame` | Changes challenge room's pause status and extends game times with given pause time. | Gamemaster | [`gamePauseChanged`](#game-pause-changed)|[pauseGame](https://gitlab.labranet.jamk.fi/wimma-lab-2022/iotitude/source-backend/-/blob/development/src/socket/listeners/challengeListeners/pauseGame.js)|
|
|
|
|
|
|
|
|
<details>
|
|
|
|
<summary><b>Required payload</b></summary>
|
| ... | ... | |
| ... | ... | |
