From 1513576291bb5ccec02e0978a5fe6e961a77babd Mon Sep 17 00:00:00 2001 From: Daniel Grigencha Date: Sun, 1 Dec 2024 18:03:46 +0100 Subject: [PATCH] added javadocs to the 'ServerState' class --- .../pp/mdga/server/automaton/ServerState.java | 68 +++++++++---------- 1 file changed, 34 insertions(+), 34 deletions(-) diff --git a/Projekte/mdga/model/src/main/java/pp/mdga/server/automaton/ServerState.java b/Projekte/mdga/model/src/main/java/pp/mdga/server/automaton/ServerState.java index adc4c3fd..da9ebc44 100644 --- a/Projekte/mdga/model/src/main/java/pp/mdga/server/automaton/ServerState.java +++ b/Projekte/mdga/model/src/main/java/pp/mdga/server/automaton/ServerState.java @@ -33,19 +33,19 @@ public ServerState(ServerGameLogic logic) { public abstract void exit(); /** - * This method will be called whenever the server received an AnimationEnd message. + * This method will be called whenever the server received an AnimationEndMessage message. * It will also get the client id of the player who send this message. * - * @param msg as the message which was sent by the player as a AnimationEnd object. + * @param msg as the message which was sent by the player as a AnimationEndMessage object. * @param from as the client id of the player as an Integer. */ public void received(AnimationEndMessage msg, int from) {} /** - * This method will be called whenever the server received an DeselectTSK message. + * This method will be called whenever the server received a DeselectTSKMessage message. * It will also get the client id of the player who send this message. * - * @param msg as the message which was sent by the player as a DeselectTSK object. + * @param msg as the message which was sent by the player as a DeselectTSKMessage object. * @param from as the client id of the player as an Integer. */ public void received(DeselectTSKMessage msg, int from) {} @@ -60,136 +60,136 @@ public void received(DeselectTSKMessage msg, int from) {} public void received(StartGameMessage msg, int from) {} /** - * This method will be called whenever the server received a JoinServer message. + * This method will be called whenever the server received a JoinedLobbyMessage message. * It will also get the client id of the player who send this message. * - * @param msg as the message which was sent by the player as a JoinServer object. + * @param msg as the message which was sent by the player as a JoinedLobbyMessage object. * @param from as the client id of the player as an Integer. */ public void received(JoinedLobbyMessage msg, int from) {} /** - * This method will be called whenever the server received an LeaveGame message. + * This method will be called whenever the server received an LeaveGameMessage message. * It will also get the client id of the player who send this message. * - * @param msg as the message which was sent by the player as a LeaveGame object. + * @param msg as the message which was sent by the player as a LeaveGameMessage object. * @param from as the client id of the player as an Integer. */ public void received(LeaveGameMessage msg, int from) {} /** - * This method will be called whenever the server received a LobbyReady message. + * This method will be called whenever the server received a LobbyReadyMessage message. * It will also get the client id of the player who send this message. * - * @param msg as the message which was sent by the player as a LobbyReady object. + * @param msg as the message which was sent by the player as a LobbyReadyMessage object. * @param from as the client id of the player as an Integer. */ public void received(LobbyReadyMessage msg, int from) {} /** - * This method will be called whenever the server received a LobbyNotReady message. + * This method will be called whenever the server received a LobbyNotReadyMessage message. * It will also get the client id of the player who send this message. * - * @param msg as the message which was sent by the player as a LobbyNotReady object. + * @param msg as the message which was sent by the player as a LobbyNotReadyMessage object. * @param from as the client id of the player as an Integer. */ public void received(LobbyNotReadyMessage msg, int from) {} /** - * This method will be called whenever the server received a Disconnected message. + * This method will be called whenever the server received a DisconnectedMessage message. * It will also get the client id of the player who send this message. * - * @param msg as the message which was sent by the player as a Disconnected object. + * @param msg as the message which was sent by the player as a DisconnectedMessage object. * @param from as the client id of the player as an Integer. */ public void received(DisconnectedMessage msg, int from) {} /** - * This method will be called whenever the server received a Briefing message. + * This method will be called whenever the server received a RequestBriefingMessage message. * It will also get the client id of the player who send this message. * - * @param msg as the message which was sent by the player as a Briefing object. + * @param msg as the message which was sent by the player as a RequestBriefingMessage object. * @param from as the client id of the player as an Integer. */ public void received(RequestBriefingMessage msg, int from) {} /** - * This method will be called whenever the server received a Die message. + * This method will be called whenever the server received a RequestDieMessage message. * It will also get the client id of the player who send this message. * - * @param msg as the message which was sent by the player as a Die object. + * @param msg as the message which was sent by the player as a RequestDieMessage object. * @param from as the client id of the player as an Integer. */ public void received(RequestDieMessage msg, int from) {} /** - * This method will be called whenever the server received a RequestMove message. + * This method will be called whenever the server received a RequestMoveMessage message. * It will also get the client id of the player who send this message. * - * @param msg as the message which was sent by the player as a RequestMove object. + * @param msg as the message which was sent by the player as a RequestMoveMessage object. * @param from as the client id of the player as an Integer. */ public void received(RequestMoveMessage msg, int from) {} /** - * This method will be called whenever the server received a PlayCard message. + * This method will be called whenever the server received a RequestPlayCardMessage message. * It will also get the client id of the player who send this message. * - * @param msg as the message which was sent by the player as a PlayCard object. + * @param msg as the message which was sent by the player as a RequestPlayCardMessage object. * @param from as the client id of the player as an Integer. */ public void received(RequestPlayCardMessage msg, int from) {} /** - * This method will be called whenever the server received a SelectCard message. + * This method will be called whenever the server received a SelectCardMessage message. * It will also get the client id of the player who send this message. * - * @param msg as the message which was sent by the player as a SelectCard object. + * @param msg as the message which was sent by the player as a SelectCardMessage object. * @param from as the client id of the player as an Integer. */ public void received(SelectCardMessage msg, int from) {} /** - * This method will be called whenever the server received a SelectTSK message. + * This method will be called whenever the server received a SelectTSKMessage message. * It will also get the client id of the player who send this message. * - * @param msg as the message which was sent by the player as a SelectTSK object. + * @param msg as the message which was sent by the player as a SelectTSKMessage object. * @param from as the client id of the player as an Integer. */ public void received(SelectTSKMessage msg, int from) {} /** - * This method will be called whenever the server received a ForceContinueGame message. + * This method will be called whenever the server received a ForceContinueGameMessage message. * It will also get the client id of the player who send this message. * - * @param msg as the message which was sent by the player as a ForceContinueGame object. + * @param msg as the message which was sent by the player as a ForceContinueGameMessage object. * @param from as the client id of the player as an Integer. */ public void received(ForceContinueGameMessage msg, int from) {} /** - * This method will be called whenever the server received a ClientStartGame message. + * This method will be called whenever the server received a ClientStartGameMessage message. * It will also get the client id of the player who send this message. * - * @param msg as the message which was sent by the player as a ClientStartGame object. + * @param msg as the message which was sent by the player as a ClientStartGameMessage object. * @param from as the client id of the player as an Integer. */ public void received(ClientStartGameMessage msg, int from) {} /** - * This method will be called whenever the server received a NoPowerCard message. + * This method will be called whenever the server received a NoPowerCardMessage message. * It will also get the client id of the player who send this message. * - * @param msg as the message which was sent by the player as a NoPowerCard object. + * @param msg as the message which was sent by the player as a NoPowerCardMessage object. * @param from as the client id of the player as an Integer. */ public void received(NoPowerCardMessage msg, int from) {} /** - * This method will be called whenever the server received a SelectedPieces message. + * This method will be called whenever the server received a SelectedPiecesMessage message. * It will also get the client id of the player who send this message. * - * @param msg as the message which was sent by the player as a SelectedPieces object. + * @param msg as the message which was sent by the player as a SelectedPiecesMessage object. * @param from as the client id of the player as an Integer. */ public void received(SelectedPiecesMessage msg, int from) {}