Reference - PYM-Team/API GitHub Wiki

API reference

Player

Model

gameId: { type: Number, required: true }
name: { type: String, required: true }

Params :

• gameId: numéro de la partie courante, compris entre 100000 et 999999
• name: nom d'utilisateur

GET

/api/players/gameid/:gameId

Retourne les joueurs associés à une partie

• gameId: numéro de la partie du joueur

POST

/api/players/gameid/:gameId

Crée un joueur associé à une partie

• gameId: numéro de la partie que le joueur veut rejoindre

PATCH

DELETE

/api/players/gameid/:gameId

Supprime tous les joueurs reliés à une partie

Game

Model

id: { type: Number, required: true },
usernames: { type: Array, required: true },

Params :

• id: numéro de la partie
• usernames: liste des noms des utilisateurs

GET

/api/games/:id

Retourne une partie selon son numéro

POST

/api/games

Crée une partie avec un numéro aléatoire

PATCH

/api/games/:id/:newUsernames

Modifie les noms d'utilisateurs associés à une partie selon son numéro

DELETE

/api/games/:id'

Supprime une partie selon son numéro

Socket.io reference

Emit messages

playerConnected(PlayerList)

Params :

• PlayerList(Required [ String[] ]) : The list of connected player's usernames.

Description

Message sent to the game master when a player connect to his game.

playerDisconnected(PlayerList)

Params :

• PlayerList (Required [ String[] ]) : The list of connected player's usernames.

Description

Message sent to the game master when a player disconnnect from his game.

Handle messages

createGame(roomId)

Params :

• roomId(Required [int]) : An id between 100000 and 999999 with identify the game.

Description

Join the socket to the group with the given id. This message is meant to be send by game masters interface. This message create a game in the database.

connectGame(roomId, playerUsername)

params :

• roomId(Required [int]): An id between 100000 and 999999 with identify the game.
• playerUsername(Required []):

Description

Message send by the player to connect him to the game with the current id. This message is meant to be send by players interface. This message create a player in the game if it does not already exist.