composants.adoc

= Conception préliminaire

== Liste des fonctions de l'interface Client-Serveur

=== Game Service
- createRoom(player : TPlayer) : TRoomId
- joinRoom(player : TPlayer, roomId : TRoomId) : Response
- sendStartGame(player : TPlayer, creatureId : Integer, board : TBoard, color : TColor, placeCards : Tcards[*]) : Response
- getGameDescription(player : TPlayer) : TDescription
- sendFinishPhase(player : TPlayer, phase : TPhase) : void
- sendPlayCards(player : TPlayer, playerCards : TCard[*]) : void
- sendPlaceJetons(player : TPlayer, placedJetons : TPlacedJeton[*]) : void
- sendResist(player : TPlayer, number : Integer) : void
- sendGiveUp(player : TPlayer) : void

=== Player Service

- sendGameDescription(gameDescription : TDescription) : void
- sendGameStart(): void
- sendGameIsFinished(common.TPlayerTeam winner) : void
- sendFirstRoundStart() : void
- sendStartPhase(phase : TPhase, gameDescription : TDescription) : void
- askAction(askedAction : TAskAction) : TAction
- sendAction(askedAction : TAskAction) : void
- sendResponse(response : Response) : void

== Components diagram

- Not alone (Joueur, Créature, Traqué, Main, Carte, Pioche, Réserve, Planète, Partie, Pouvoir)
- Base de données (Sauvegarde de joueurs)
- Authentificateur (SecurityWrapper)
- Client

== Components diagram

[plantuml, components-diagram, png]
....
hide circle
skinparam monochrome true

component GameService as na

component GameClient as c

database DataBase as db

component SecurityWrapper as sw

interface Data as dbi

interface GameServices as nai

interface Security as swi

interface ClientServices as ci

c - ci
nai - na
na .> "use" swi
c .> "use" nai
na ..> "use" ci

dbi - db

swi - sw
sw .> "use" dbi 

....

=== Interface

[plantuml, interface-diagrams, png]
....
hide circle
skinparam monochrome true

class "«interface» \n Data" as dbi{
	existUser(id : String):Boolean
	findUser(id : String):User
    findPlaceCard(id : String):PlaceCard
    findPlaceCards(ids : String[*]):PlaceCard[*]
    findSurvivalCard(id : String):SurvivalCard
    findSurvivalCards(ids : String[*]):SurvivalCard[*]
    findAllSurvivalCards():SurvivalCard[*]
    findTrackingCard(id : String):TrackingCard
    findTrackingCards(ids : String[*]):TrackingCard[*]
    findAllTrackingCards():TrackingCard[*]
}

class  "«interface» \n Security" as swi{
	verifyUser(id : String, password : String):Boolean
	generateToken(id : String , gameId : String):String
	getUser(id : String):User
}

class "«interface» \n GameService" as si{
	createRoom(player : TPlayer) : TRoomId
    joinRoom(player : TPlayer, roomId : TRoomId) : Response
    sendStartGame(player : TPlayer, creatureId : Integer, board : TBoard, color : TColor, placeCards : Tcards[*]) : Response
    getGameDescription(player : TPlayer) : TDescription
    sendFinishPhase(player : TPlayer, phase : TPhase) : void
    sendPlayCards(player : TPlayer, playerCards : TCard[*]) : void
    sendPlaceJetons(player : TPlayer, placedJetons : TPlacedJeton[*]) : void
    sendResist(player : TPlayer, number : Integer) : void
    sendGiveUp(player : TPlayer) : void
}

class "«interface» \n PlayerService" as csi{
	sendGameDescription(gameDescription : TDescription) : void
    sendGameStart(): void
    sendGameIsFinished(common.TPlayerTeam winner) : void
    sendFirstRoundStart() : void
    sendStartPhase(phase : TPhase, gameDescription : TDescription) : void
    askAction(askedAction : TAskAction) : TAction
    sendAction(askedAction : TAskAction) : void
    sendResponse(response : Response) : void
}
....


== Diagrammes de séquence

== Diagramme de séquence de mise en place

### Pour créer une partie 

- TPlayer tPlayer1 = {"Jean", "192.168.1.12:4200"}
- TPlayer tPlayer2 = {"Sébastien", "192.168.1.13:4200"}

Couleur partie : Bleu
[plantuml]
----
hide circle
skinparam monochrome true

C1Client -> S1Serveur : createRoom(tPlayer1)
C1Client <-- S1Serveur : 1001
C2Client -> S1Serveur : joinGame(tPlayer2, 1001)
C2Client <-- S1Serveur : {true, ""}
C1Client -> S1Serveur : sendStartGame(tPlayer1, 1, "PLATEAU_RECTO_ID", "Bleu", [Nexus, Jungle, Rivière, Dôme, Plage, Mangrove , Abri, Epave, Fungi, Portail])
C1Client <-- S1Serveur : {true, ""}
S1Serveur ->> C1Client : sendFirstRoundStart()
S1Serveur ->> C2Client : sendFirstRoundStart()
C1Client -> S1Serveur : getGameDescription(tPlayer1)
C2Client -> S1Serveur : getGameDescription(tPlayer2)
----

### Pour rejoindre une partie

- ID de la partie 1001 
- ID du joueur : 10

[plantuml]
----
hide circle
skinparam monochrome true

C1Client -> S1Serveur : joinGame("1001", "10")
C1Client <-- S1Serveur : sendConfirmation("{token : token10}")
C1Client ->> S1Serveur : waitGameStart("token10")
C1Client <<-- S1Serveur : sendConfirmation()
C1Client -> S1Serveur : getGameDescription("token10")
C1Client <-- S1Serveur : sendGameDescription("Traqué,{[L'antre,La jungle,La rivière,La plage,Le rover], [], 3, [Riposte]}, 2, [{Antre, []}, {Jungle, []}, ...], [{Marais, 3}, {Abri, 3}, ...], [10, 5, 8, 15], [20]")
C1Client ->> S1Serveur : waitStartPhase("token10", "PREPHASE_1_ID")
C1Client <<-- S1Serveur : sendConfirmation()
----

=== Diagramme de séquence du déroulement d'une partie

### Déroulement d'une manche (Traqué)

- Token du joueur : token5
- Equipe du joueur : Traqué

[plantuml]
----
hide circle
skinparam monochrome true

C1Client ->> S1Serveur : waitStartPhase("token5", "PREPHASE_1_ID")
C1Client <<-- S1Serveur : sendStartPhase("PREPHASE_1_ID", "GameDescription")
C1Client -> S1Serveur : sendResist("token5")
C1Client <-- S1Serveur : sendConfirmation()
C1Client -> S1Serveur : sendFinishPhase("token5", "PREPHASE_1_ID")
C1Client <-- S1Serveur : sendConfirmation()

C1Client ->> S1Serveur : waitStartPhase("token5", "PHASE_1_ID")
C1Client <<-- S1Serveur : sendStartPhase("PHASE_1_ID", "GameDescription")
C1Client -> S1Serveur : sendPlayCards("token5", "{La Plage}")
C1Client <-- S1Serveur : sendConfirmation()
C1Client -> S1Serveur : sendFinishPhase("token5", "PHASE_1_ID")
C1Client <-- S1Serveur : sendConfirmation()

C1Client ->> S1Serveur : waitStartPhase("token5", "POSTPHASE_1_ID")
C1Client <<-- S1Serveur :  sendStartPhase("POSTPHASE_1_ID", "GameDescription")
C1Client -> S1Serveur : sendPlayCards("token5", "{Adrénaline}")
C1Client <-- S1Serveur : sendConfirmation()
C1Client -> S1Serveur : sendFinishPhase("token5", "POSTPHASE_1_ID")
C1Client <-- S1Serveur : sendConfirmation()

C1Client ->> S1Serveur : waitStartPhase("token5", "PREPHASE_2_ID")
C1Client <<-- S1Serveur : sendStartPhase("PREPHASE_2_ID", "GameDescription")
C1Client -> S1Serveur : sendFinishPhase("token5", "PREPHASE_2_ID")
C1Client <-- S1Serveur : sendConfirmation()

C1Client ->> S1Serveur : waitStartPhase("token5", "PHASE_2_ID")
C1Client <<-- S1Serveur : sendStartPhase("PHASE_2_ID", "GameDescription")
C1Client -> S1Serveur : sendFinishPhase("token5", "PHASE_2_ID")
C1Client <-- S1Serveur : sendConfirmation()

C1Client ->> S1Serveur : waitStartPhase("token5", "POSTPHASE_2_ID")
C1Client <<-- S1Serveur : sendStartPhase("POSTPHASE_2_ID", "GameDescription")
C1Client -> S1Serveur : sendFinishPhase("token5", "POSTPHASE_2_ID")
C1Client <-- S1Serveur : sendConfirmation()

C1Client ->> S1Serveur : waitStartPhase("token5", "PREPHASE_3_ID")
C1Client <<-- S1Serveur : sendStartPhase("PREPHASE_3_ID", "GameDescription")
C1Client -> S1Serveur : sendFinishPhase("token5", "PREPHASE_3_ID")
C1Client <-- S1Serveur : sendConfirmation()

C1Client ->> S1Serveur : waitStartPhase("token5", "PHASE_3_ID")
C1Client <<-- S1Serveur : sendStartPhase("PHASE_3_ID", "GameDescription")
C1Client -> S1Serveur : sendChooseAction("token5", "POWER_1_ID")
C1Client <-- S1Serveur : sendConfirmation()
C1Client -> S1Serveur : sendFinishPhase("token5", "PHASE_3_ID")
C1Client <-- S1Serveur : sendConfirmation()

C1Client ->> S1Serveur : waitStartPhase("token5", "POSTPHASE_3_ID")
C1Client <<-- S1Serveur : sendStartPhase("POSTPHASE_3_ID", "GameDescription")
C1Client -> S1Serveur : sendFinishPhase("token5", "POSTPHASE_3_ID")
C1Client <-- S1Serveur : sendConfirmation()

C1Client ->> S1Serveur : waitStartPhase("token5", "PREPHASE_4_ID")
C1Client <<-- S1Serveur : sendStartPhase("PREPHASE_4_ID", "GameDescription")
C1Client -> S1Serveur : sendFinishPhase("token5", PREPHASE_4_ID)
C1Client <-- S1Serveur : sendConfirmation()

C1Client ->> S1Serveur : waitStartPhase("token5", "PHASE_4_ID")
C1Client <<-- S1Serveur : sendStartPhase("PHASE_4_ID", "GameDescription")
C1Client -> S1Serveur : sendFinishPhase("token5", "PHASE_4_ID")
C1Client <-- S1Serveur : sendConfirmation()

C1Client ->> S1Serveur : waitStartPhase("token5", "POSTPHASE_4_ID")
C1Client <<-- S1Serveur : sendStartPhase("POSTPHASE_4_ID", "GameDescription")
C1Client -> S1Serveur : sendFinishPhase("token5", "POSTPHASE_4_ID")
C1Client <-- S1Serveur : sendConfirmation()

C1Client ->> S1Serveur : waitStartPhase("token5", "PREPHASE_1_ID")
C1Client <<-- S1Serveur : sendStartPhase("FINISH_ID", "GameDescription")
----

### Déroulement d'une manche (Créature)

- Equipe du joueur : Créature
- Token du joueur : token8

[plantuml]
----
hide circle
skinparam monochrome true

C1Client ->> S1Serveur : waitStartPhase("token8", "PREPHASE_1_ID")
C1Client <<-- S1Serveur : sendStartPhase("PREPHASE_1_ID", "GameDescription")
C1Client -> S1Serveur : sendFinishPhase("token8", "PREPHASE_1_ID")
C1Client <-- S1Serveur : sendConfirmation()

C1Client ->> S1Serveur : waitStartPhase("token8", "PHASE_1_ID")
C1Client <<-- S1Serveur : sendStartPhase("PHASE_1_ID", "GameDescription")
C1Client -> S1Serveur : sendFinishPhase("token8", "PHASE_1_ID")
C1Client <-- S1Serveur : sendConfirmation()

C1Client ->> S1Serveur : waitStartPhase("token8", "POSTPHASE_1_ID")
C1Client <<-- S1Serveur :  sendStartPhase("POSTPHASE_1_ID", "GameDescription")
C1Client -> S1Serveur : sendFinishPhase("token8", "POSTPHASE_1_ID")
C1Client <-- S1Serveur : sendConfirmation()

C1Client ->> S1Serveur : waitStartPhase("token8", "PREPHASE_2_ID")
C1Client <<-- S1Serveur : sendStartPhase("PREPHASE_2_ID", "GameDescription")
C1Client -> S1Serveur : sendPlayCards("token8", "{Soif de sang}")
C1Client <-- S1Serveur : sendConfirmation()
C1Client -> S1Serveur : sendFinishPhase("token8", "PREPHASE_2_ID")
C1Client <-- S1Serveur : sendConfirmation()

C1Client ->> S1Serveur : waitStartPhase("token8", "PHASE_2_ID")
C1Client <<-- S1Serveur : sendStartPhase("PHASE_2_ID", "GameDescription")
C1Client -> S1Serveur : sendPlaceJetons("token8", "{{Créature, EMPLACEMENT_1_ID} {Cible, EMPLACEMENT_7_ID}}")
C1Client <-- S1Serveur : sendConfirmation()
C1Client -> S1Serveur : sendFinishPhase("token8", "PHASE_2_ID")
C1Client <-- S1Serveur : sendConfirmation()

C1Client ->> S1Serveur : waitStartPhase("token8", "POSTPHASE_2_ID")
C1Client <<-- S1Serveur : sendStartPhase("POSTPHASE_2_ID", "GameDescription")
C1Client -> S1Serveur : sendFinishPhase("token8", "POSTPHASE_2_ID")
C1Client <-- S1Serveur : sendConfirmation()

C1Client ->> S1Serveur : waitStartPhase("token8", "PREPHASE_3_ID")
C1Client <<-- S1Serveur : sendStartPhase("PREPHASE_3_ID", "GameDescription")
C1Client -> S1Serveur : sendFinishPhase("token8", "PREPHASE_3_ID")
C1Client <-- S1Serveur : sendConfirmation()

C1Client ->> S1Serveur : waitStartPhase("token8", "PHASE_3_ID")
C1Client <<-- S1Serveur : sendStartPhase("PHASE_3_ID", "GameDescription")
C1Client -> S1Serveur : sendFinishPhase("token8", "PHASE_3_ID")
C1Client <-- S1Serveur : sendConfirmation()

C1Client ->> S1Serveur : waitStartPhase("token8", "POSTPHASE_3_ID")
C1Client <<-- S1Serveur : sendStartPhase("POSTPHASE_3_ID", "GameDescription")
C1Client -> S1Serveur : sendFinishPhase("token8", "POSTPHASE_3_ID")
C1Client <-- S1Serveur : sendConfirmation()

C1Client ->> S1Serveur : waitStartPhase("token8", "PREPHASE_4_ID")
C1Client <<-- S1Serveur : sendStartPhase("PREPHASE_4_ID", "GameDescription")
C1Client -> S1Serveur : sendFinishPhase("token8", "PREPHASE_4_ID")
C1Client <-- S1Serveur : sendConfirmation()

C1Client ->> S1Serveur : waitStartPhase("token8", "PHASE_4_ID")
C1Client <<-- S1Serveur : sendStartPhase("PHASE_4_ID", "GameDescription")
C1Client -> S1Serveur : sendFinishPhase("token8", "PHASE_4_ID")
C1Client <-- S1Serveur : sendConfirmation()

C1Client ->> S1Serveur : waitStartPhase("token8", "POSTPHASE_4_ID")
C1Client <<-- S1Serveur : sendStartPhase("POSTPHASE_4_ID", "GameDescription")
C1Client -> S1Serveur : sendFinishPhase("POSTPHASE_4_ID")
C1Client <-- S1Serveur : sendConfirmation()

C1Client ->> S1Serveur : waitStartPhase("token8", "PREPHASE_1_ID")
C1Client <<-- S1Serveur : sendStartPhase("FINISH_ID", "GameDescription")
----