esc キーを押したときにポーズ画面を表示したい

Question

実現したいこと

プレイヤーがゲームをしている最中にescキーを押して、ゲームを一時停止できるようにしています。

getKeyCode() =KeyEvent.VK_ESCAPE　の方で timerをストップさせ、そのあとにplaying = false　にし,そのあともう一回 esc を押すと、timer がリスタートし、またゲームが再開するという仕組みになっています。リスタートする時には playing = true になっています。

そして、playing = false（一回だけ esc を押してポーズをしている状態）の時に、画面に　「PAUSED」という文字を表示させたいです。

発生している問題・分からないこと

esc　キーでゲームの進行を止めることはできましたが、「PUASED」という文字の表示ができません。

該当のソースコード

package breakout;

import javax.swing.JPanel;



import javax.swing.Timer;
import java.awt.color.*;
import java.awt.Font;
import java.awt.Color;
import java.awt.Dimension;
import java.awt.FontMetrics;
import java.awt.Graphics2D;
import java.awt.Graphics;
import java.awt.Point;
import java.awt.RenderingHints;
import java.awt.Toolkit;
import java.awt.event.KeyEvent;
import java.awt.event.ActionEvent;
import java.awt.event.KeyAdapter;
import java.awt.event.ActionListener;
import java.awt.event.KeyListener;

public class Board extends JPanel {
	private Timer timer;
	private String message = "GAME OVER";
	private ball Ball;
	private Paddle paddle;
	private Brick[] bricks;
	private boolean Game = true;//run the game or not
	private TAdapter keyAdapter;
	private int score = 0;
	private boolean playing = true;
	
	
	public Board(){
		initBoard();
		
	}
	
	private void initBoard() {

		this.keyAdapter = new TAdapter();
		addKeyListener(this.keyAdapter);
		setFocusable(true);
		setPreferredSize(new Dimension (Commons.width, Commons.height));
		gameInit();
	}
	
	private void gameInit() {
		bricks = new Brick[Commons.totalBricks];
		Ball = new ball();
		paddle = new Paddle();
		
		int k = 0;
		
		for (int i =0; i < 5; i++) {
			for (int j = 0; j < 6; j++) {
				bricks[k] = new Brick(j*60+30, i*25+80);//place the bricks on the panel
				k++;
			}
		}
		timer  = new Timer(Commons.period, new GameCycle());//perform actions
		timer.start();

		}
	
	
	@Override
	public void paintComponent(Graphics g) {
		super.paintComponent(g);
		
		var g2d = (Graphics2D) g;
		
		
		g2d.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);
		g2d.setRenderingHint(RenderingHints.KEY_RENDERING, RenderingHints.VALUE_RENDER_QUALITY);
		
		if(Game) {
			drawObjects(g2d);//drawing all objects in the game
			if(!playing) {
				pausedScreen(g2d);//ここでポーズ画面を表示させたい
				}
		}
		
		else {
			gameFinished(g2d);//display result
		}
		
		
		Toolkit.getDefaultToolkit().sync();	
	}
	
	private void drawObjects(Graphics2D g2d) {//基本的なゲーム画面
		g2d.drawImage(Ball.getImage(), Ball.getX(), Ball.getY(), Ball.getImageWidth(), Ball.getImageHeight(), this);
		g2d.drawImage(paddle.getImage(), paddle.getX(), paddle.getY(), paddle.getImageWidth(), paddle.getImageHeight(), this);
		
		g2d.setColor(Color.black);
		g2d.setFont(new Font("Monospaced",Font.BOLD, 25));
		g2d.drawString("Score: "+score, 30,40);
		
		for (int i =0; i<Commons.totalBricks; i++) {
			
			if (!bricks[i].isDestroyed()) {
				g2d.drawImage(bricks[i].getImage(), bricks[i].getX(), bricks[i].getY(), bricks[i].getImageWidth(), bricks[i].getImageHeight(), this);
				
			}
		}
		
	}
	
	private void pausedScreen(Graphics2D g2d) {//ポーズ画面
			g2d.setColor(Color.black);
			g2d.setFont(new Font("Monospaced",Font.BOLD,25));
			g2d.drawString("PAUSE",200,200);
	}
	

	private void gameFinished(Graphics2D g2d) {
		//called when a player failed
		var font = new Font("Verdana", Font.BOLD, 18);
		FontMetrics fontMetrics = this.getFontMetrics(font);
		
		String scoreMessage = "Score: "+score;
		String restartMessage = "Press ENTER to restart";
		g2d.setColor(Color.black);
		g2d.setFont(font);
	
		g2d.drawString(message,(Commons.width - fontMetrics.stringWidth(message))/2, Commons.width/2);
		g2d.drawString(scoreMessage, (Commons.width - fontMetrics.stringWidth(scoreMessage))/2,250);
		g2d.drawString(restartMessage,(Commons.width - fontMetrics.stringWidth(restartMessage))/2,300);
		
		addKeyListener(this.keyAdapter);
	}
	


	//key listeners
	private class TAdapter extends KeyAdapter {		
		@Override
		public void keyReleased(KeyEvent e) {
			paddle.keyReleased(e);//perform when key released
		}
		
		@Override
		public void keyPressed(KeyEvent e) {
			if(e.getKeyCode()== KeyEvent.VK_ESCAPE){
				if(Game) {
					if(playing) {
						timer.stop();
						playing = false;
					}
					else if(!playing) {
						timer.restart();
						playing =true;
					}

				}
			}
			paddle.keyPressed(e);//move the paddle when the key is pressed
			
			//press enter to restart and initialize the score 
			if (e.getKeyCode() == KeyEvent.VK_ENTER) {
				if (!Game) {
					Game = true;
					score = 0;
					
					timer.setRepeats(false);
					initBoard();
				}
				
			}
			
		}
	}

	private class GameCycle implements ActionListener{
		@Override
		public void actionPerformed(ActionEvent e) {
			doGameCycle();
		}
	}

	
	private void doGameCycle() {
		
	//call all movements
		Ball.ballmove();
		paddle.move();
		checkCollision();
		repaint();
		
	}
	private void stopGame() {
	//stop the game
		Game = false;
		timer.stop();
		
	}
	
	private void checkCollision() {
		if (Ball.getRect().getMaxY()>Commons.bottomEdge) {
			//Game Over
			stopGame();
		}
		
		for (int i = 0,j = 0; i<Commons.totalBricks; i++) {
			if (bricks[i].isDestroyed()) {
				j++;
			}
			
			if (j==Commons.totalBricks) {
				message = "Victory";
				stopGame();
			}
		}

試したこと・調べたこと

• teratailやGoogle等で検索した
• ソースコードを自分なりに変更した
• 知人に聞いた
• その他

上記の詳細・結果

• keypressed は戻り値がないからreturnは使えない
• Graphic2DのクラスはTAdaptor クラスでは呼べない
• drawObjects の方に同じ　if(!playing){... を書いてみたけれど、結果ポーズ画面は表示されなかった

補足

特になし

Comments

[jimbe]

全体的な話になりますが、そも Board クラスでゲーム自体からゲーム終了から途中停止まで全てやらないといけないのでしょうか。
例えば Board クラスでゲーム自体とし、ゲーム終了や一時停止はそれぞれ別の Panel にして Board クラスと随時差し替えるとかレイアウトによって上に重ねるとかする方法もあると思いますが。

[RRk]

問題解決できました！
ご回答ありがとうございました。

Answer 1

Swing の表示は全て paintComponent で行います。
キー操作によって表示を変えるのなら、表示要因を変更したうえで repaint 等を呼んで Swing に表示を更新して貰う形になります。

---

質問へのコメントで提案させて頂きましたが、ゲームパネル・フィニッシュパネル・一時停止パネルを用意して重ねて置き、状況によって表示を切り替える形を作って見ました。
こうするとゲームパネルの paintComponent 等から全体の状況別の処理切替が無くなります。

一応ゲームパネルはそれっぽく動いている状態を見れるように、左上に (Timer が動いていることを示す)ランダムに動き続けるバーと、左右矢印キーで数値を増減できる数値の表示を置き、数値が 0 か 100 になったらフィニッシュとしてその数値をスコアとして表示するようにしてみました。
フィニッシュ後は ENTER で再スタート、ゲーム中は ESC で一時停止/復帰します。

PanelsFrame.java

import java.awt.*;
import java.awt.event.*;
import java.util.Random;
import java.util.function.BiConsumer;

import javax.swing.*;

public class PanelsFrame extends JFrame {
  public static void main(String[] args) {
    SwingUtilities.invokeLater(() -> new PanelsFrame().setVisible(true));
  }

  PanelsFrame() {
    super("PanelsFrame");
    setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);

    GamePanel gamePanel = new GamePanel();
    PausePanel pausePanel = new PausePanel(gamePanel::resume); //esc が押されたら gamePanel.resume() を呼ぶ
    FinishedPanel finishedPanel = new FinishedPanel(gamePanel::start); //enter が押されたら gamePane.start() を呼ぶ

    gamePanel.setPauseListener(pausePanel::showAndFocus); //esc が押されたら pausePanel.showAndFocus() を呼ぶ
    gamePanel.setFinishedListener(finishedPanel::showAndFocus); //finish したら finishedPanel.showAndFocus(String,int) を呼ぶ

    setLayout(new OverlayLayout(getContentPane())); //全てを重ねる
    add(finishedPanel); //一番上
    add(pausePanel);
    add(gamePanel); //一番下
    pack();

    gamePanel.start();
  }
}

class StringDrawer {
  private Font font;
  private FontMetrics fontMetrics;

  StringDrawer(JComponent comp, Font font) {
    this.font = font;
    fontMetrics = comp.getFontMetrics(font);
  }
  void drawInCenter(Graphics g, String s, JComponent comp) {
    int x = (comp.getWidth() - fontMetrics.stringWidth(s)) / 2;
    int y = (comp.getHeight() - fontMetrics.getHeight()) / 2;
    draw(g, s, x, y);
  }
  void draw(Graphics g, String s, int x, int y) {
    g.setFont(font);
    g.drawString(s, x, y + fontMetrics.getAscent());
  }
}

class GamePanel extends JPanel {
  private BiConsumer<String,Integer> finishedListener;
  private Runnable pauseListener;
  private StringDrawer sd1, sd2;
  private Timer timer;
  private Random random = new Random();
  private int keycode, value, bar;

  GamePanel() {
    super(null);
    setSize(400, 400);
    setPreferredSize(getSize());
    setFocusable(true);
    setBackground(Color.CYAN); //重なりを分かり易くするため色を付けてみる

    sd1 = new StringDrawer(this, getFont());
    sd2 = new StringDrawer(this, getFont().deriveFont(Font.BOLD, 50f));

    addKeyListener(new KeyAdapter() {
      @Override
      public void keyPressed(KeyEvent e) {
        int kc = e.getKeyCode();
        if(kc == KeyEvent.VK_LEFT || kc == KeyEvent.VK_RIGHT) keycode = kc;
      }
      @Override
      public void keyReleased(KeyEvent e) {
        int kc = e.getKeyCode();
        if(kc == KeyEvent.VK_ESCAPE) pause();
        if(kc == keycode) keycode = 0;
      }
      private void pause() {
        timer.stop();
        keycode = 0;
        if(pauseListener != null) pauseListener.run();
      }
    });
  }

  void setFinishedListener(BiConsumer<String,Integer> listener) {
    finishedListener = listener;
  }
  void setPauseListener(Runnable listener) {
    pauseListener = listener;
  }

  void start() {
    keycode = 0;
    value = 50;
    resume();
  }

  void resume() {
    requestFocus();
    timer = new Timer(50, e -> {
      if(value == 0 || value == 100) { //終わり判定
        timer.stop();
        if(finishedListener != null) finishedListener.accept(value==0?"GAME OVER":"Victory", value); //テキトウに渡してみる
        return;
      }
      if(keycode == KeyEvent.VK_LEFT) value -= 1;
      if(keycode == KeyEvent.VK_RIGHT) value += 1;
      bar = random.nextInt(10); //タイマーが動いているかを確認する為の表示
      repaint();
    });
    timer.start();
  }

  @Override
  public void paintComponent(Graphics g) {
    super.paintComponent(g);

    sd1.draw(g, "=".repeat(bar), 10, 10);
    sd2.drawInCenter(g, "← " + value + " →", this);
  }
}

abstract class OverlapPanel extends JPanel {
  OverlapPanel(Color bg) {
    super(new GridBagLayout());
    setBackground(bg);
    setFocusable(true);
    setVisible(false);
  }

  void showAndFocus() {
    setVisible(true);
    requestFocus();
  }

  protected JLabel addLabel(String text, Color fg, Font font, Object constraints) {
    JLabel label = new JLabel(text);
    label.setForeground(fg);
    label.setFont(font);
    add(label, constraints);
    return label;
  }

  protected enum KeyAction {
    PRESSED {
      KeyListener createKeyListener(JComponent comp, int keyCode, Runnable listener) {
        return new KeyAdapter() {
          @Override
          public void keyPressed(KeyEvent e) { if(e.getKeyCode() == keyCode) action(comp, listener); }
        };
      }
    },
    RELEASED {
      KeyListener createKeyListener(JComponent comp, int keyCode, Runnable listener) {
        return new KeyAdapter() {
          @Override
          public void keyReleased(KeyEvent e) { if(e.getKeyCode() == keyCode) action(comp, listener); }
        };
      }
    };

    abstract KeyListener createKeyListener(JComponent comp, int keyCode, Runnable listener);
    private static void action(JComponent comp, Runnable listener) {
      comp.setVisible(false);
      listener.run();
    }
  }

  protected void addKeyEvent(int keyCode, KeyAction keyAction, Runnable listener) {
    addKeyListener(keyAction.createKeyListener(this, keyCode, listener));
  }
}

class FinishedPanel extends OverlapPanel {
  private JLabel messageLabel, scoreLabel;

  FinishedPanel(Runnable restartListener) {
    super(new Color(0,0,0,180)); //半透明

    Font font = new Font("Verdana", Font.BOLD, 18);

    GridBagConstraints gbc = new GridBagConstraints();
    gbc.gridx = 0;

    messageLabel = addLabel(null, Color.WHITE, font, gbc);
    add(Box.createVerticalStrut(50), gbc);
    scoreLabel = addLabel(null, Color.WHITE, font, gbc);
    add(Box.createVerticalStrut(30), gbc);
    addLabel("Press ENTER to restart", Color.GREEN, font, gbc);

    addKeyEvent(KeyEvent.VK_ENTER, KeyAction.PRESSED, restartListener);
  }

  void showAndFocus(String message, int score) {
    messageLabel.setText(message);
    scoreLabel.setText("Score: " + score);
    showAndFocus();
  }
}

class PausePanel extends OverlapPanel {
  PausePanel(Runnable resumeListener) {
    super(new Color(100,100,100,180)); //白っぽい半透明

    addLabel("PAUSE", Color.YELLOW, new Font("Monospaced", Font.BOLD, 25), null);

    addKeyEvent(KeyEvent.VK_ESCAPE, KeyAction.RELEASED, resumeListener);
  }
}

Comments

[RRk]

回答ありがとうございます。
repaintを呼んだところ、問題が解決しました！
ベストアンサーに選ばせていただきました。

[RRk]

追加の回答ありがとうございます。
こちらのコードも参考にさせていただきます。

[jimbe]

ちょっとコードを修正しました。
FinishedPanel と PausePanel から共通の OverlapPanel を抜き出したり等で動きは変わりません。
コードが減るかと思ったら増えてしまいました、 KeyAction がやり過ぎか…。

Answer 2

解決済みですが...

前回（提示コード不足で）動かしていなかったので気が付きませんでしたが、リトライするたびにaddKeyListenerされていきますね（1回のキー操作で複数回keyPressedが呼ばれるようになる）

Timerも不要に複数個作っています（なんでtimer.setRepeats(false)しているのかと思いましたが今回の問題と同根です）

こんな感じがいいんじゃないかな？（BallやPaddle等も作り直さなくてもいいかもしれないが）

public class Board extends JPanel {
    private final Timer timer;
    private String message = "GAME OVER";
    private Ball ball;
    private Paddle paddle;
    private Brick[] bricks;
    private boolean game;
    private int score;
    private boolean playing;

    public Board() {
        addKeyListener(new TAdapter());
        setFocusable(true);
        setPreferredSize(new Dimension(Commons.width, Commons.height));
        timer = new Timer(Commons.period, new GameCycle());
        initBoard();
    }

    private void initBoard() {
        game = true;
        score = 0;
        playing = true;
        bricks = new Brick[Commons.totalBricks];
        ball = new Ball();
        paddle = new Paddle();

        for (int i = 0, k = 0; i < 5; i++) {
            for (int j = 0; j < 6; j++) {
                bricks[k] = new Brick(j * 60 + 30, i * 25 + 80);
                k++;
            }
        }
        timer.start();
    }

Comments

[RRk]

回答ありがとうございます。

addKeyListener は多分試行錯誤していた時の産物ですね。timer は指摘されるまで気づきませんでした。どちらも自分では気づかないところだったので、参考になりました。