peet/Gruppe-02-clone
1
0
Fork 0
mirror of https://athene2.informatik.unibw-muenchen.de/progproj/gruppen-ht24/Gruppe-02.git synced 2025-01-18 22:56:15 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

added documentation for Gulag

Browse Source
This commit is contained in:
Yvonne Schmidt 2024-12-02 08:42:08 +01:00
parent cc157a3cf3
commit a4c0afe277
1 changed files with 22 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
Projekte/monopoly/client/src/main/java/pp/monopoly/client/gui/popups/Gulag.java
View File

@ -16,16 +16,29 @@ import pp.monopoly.client.MonopolyApp;
import pp.monopoly.notification.Sound;
/**
* Gulag is a warning popup that is triggered when a certain player enters the "Wache" field
* Gulag is a warning popup triggered when a player lands on the "Wache" field in the Monopoly game.
* <p>
* This popup informs the player that they are being sent to the Gulag and includes a confirmation button.
* </p>
*/
public class Gulag extends Dialog {
/** Reference to the Monopoly application instance. */
private final MonopolyApp app;
/** Semi-transparent overlay background for the popup. */
private final Geometry overlayBackground;
/** Main container for the Gulag warning message. */
private final Container gulagContainer;
/** Background container providing a border for the popup. */
private final Container backgroundContainer;
/**
* Constructs the Gulag popup, displaying a warning when a player lands on the "Wache" field.
*
* @param app the Monopoly application instance
*/
public Gulag(MonopolyApp app) {
super(app.getDialogManager());
this.app = app;
@ -82,9 +95,9 @@ public class Gulag extends Dialog {
}
/**
* Erstellt einen halbtransparenten Hintergrund für das Menü.
* Creates a semi-transparent overlay background for the popup.
*
* @return Geometrie des Overlays
* @return the geometry of the overlay
*/
private Geometry createOverlayBackground() {
Quad quad = new Quad(app.getCamera().getWidth(), app.getCamera().getHeight());
@ -98,7 +111,7 @@ public class Gulag extends Dialog {
}
/**
* Schließt das Menü und entfernt die GUI-Elemente.
* Closes the popup and removes its associated GUI elements.
*/
@Override
public void close() {
@ -108,6 +121,9 @@ public class Gulag extends Dialog {
super.close();
}
/**
* Handles the escape action to close the popup.
*/
@Override
public void escape() {
close();