DjalimSimaila/SAE-A2-TruthInquiry
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

added missing docstring in game_lobby.js

Browse Source
This commit is contained in:
Djalim Simaila 2023-03-20 14:58:42 +01:00
parent e72f9a9790
commit 3b2d4ca693
1 changed files with 23 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
truthinquiry/static/js/game_lobby.js
View File

@ -69,7 +69,7 @@ function displayWaitingForHostMessage() {
* shown, by removing the hidden CSS class on the element. * shown, by removing the hidden CSS class on the element.
* </p> * </p>
* *
* @param {boolean} errorMessage the error message to show * @param {string} errorMessage the error message to show
*/ */
function displayInvalidNickNameErrorMessage(errorMessage) { function displayInvalidNickNameErrorMessage(errorMessage) {
let gameStartFailedElement = document.querySelector(".game_start_failed"); let gameStartFailedElement = document.querySelector(".game_start_failed");
@ -100,6 +100,12 @@ function startChallengeGame() {
// Join room functions // Join room functions
/**
* This function read the username join an already existing game,
* to do so it calls the joinGame endpoint with the aftermentioned
* username as parameter. If the request succeeds the lobby view
* is displayed.
*/
function joinRoom() { function joinRoom() {
if (isNickNameInvalid()) { if (isNickNameInvalid()) {
displayInvalidNickNameErrorMessage("Le nom saisi n'est pas valide."); displayInvalidNickNameErrorMessage("Le nom saisi n'est pas valide.");
@ -218,13 +224,21 @@ function unsetListenerToCopyCodeButton() {
document.getElementById("invite_friends_button").removeEventListener("click", copyCode); document.getElementById("invite_friends_button").removeEventListener("click", copyCode);
} }
// Utility functions /**
* This predicate asks the server is the current player is the owner of the
* room stored in the session cookie.
* @returns {boolean} true if the player is the owner of the game, false otherwise
*/
async function isRoomOwner() { async function isRoomOwner() {
const response = await makeAPIRequest("isOwner"); const response = await makeAPIRequest("isOwner");
return response["owner"]; return response["owner"];
} }
/**
* This predicate asks the server is the current player has joined the
* room stored in the session cookie.
* @returns {boolean} true if the player has joined the game, false otherwise
*/
async function hasJoinedRoom() { async function hasJoinedRoom() {
const response = await makeAPIRequest("hasJoined"); const response = await makeAPIRequest("hasJoined");
return response["joined"]; return response["joined"];
@ -312,6 +326,12 @@ function getRoomCode() {
return document.getElementById("game_id").value; return document.getElementById("game_id").value;
} }
/**
* Initialize the websocket for this page, its primary use is to
* show in realtime players joining the room and to start the game
* of every player in the same time when the game owner starts the
* gane
*/
function initSock() { function initSock() {
const socket = io({ const socket = io({
auth: { auth: {