kinugasa.game
クラス GameConfig

java.lang.Object
  上位を拡張 kinugasa.game.GameConfig

public class GameConfig
extends java.lang.Object

Kinugasa : GameConfig : ゲームの初期設定を指定するためのビルダです.
このクラスはゲームの起動時に様々な設定を行うために使用します。
ゲーム起動時の設定が非常に複雑な場合には、このクラスを継承することで 適切な値を返す専用クラスを作成できます。


設定可能なオプションは以下の通りです。

オプション 説明 デフォルト値 nullの許可 ゲーム開始後の設定変更
title ゲームウインドウのタイトルおよびゲームの名前 "My Game" yes kinugasa.game.GameWindow
location ゲームウインドウが出現する位置
スクリーン左上からのピクセル単位の距離
x=0, y=0 kinugasa.game.GameWindow
size ゲームウインドウのサイズ width=600, height=400 kinugasa.game.GameWindow
backColor ゲームウインドウの描画可能領域の背景色 R=68, G=98, B=162(#4462A2) kinugasa.game.GameWindow
icon ゲームウインドウのアイコン null yes kinugasa.game.GameWindow
fps 動作FPS 60 kinugasa.game.GameTimeManager
renderingHints レンダリングの品質 kinugasa.contents.graphics.RenderingPolicy.DEFAULT 変更不能
useMouseCursor ゲームウインドウ上でマウスカーソルを表示する false 変更不能
useGamePad DLLをロードし、ゲームパッドを使用可能にする true 変更不能
useKeyboard キーリスナをゲームウインドウに登録し、キー状態を検査可能にする true 変更不能
closeEvetList ゲームウインドウを閉じる際のイベント 空のリスト kinugasa.game.GameWindow

バージョン:
1.0.0 - 2013/01/13_20:55:27
作成者:
Dra0211

フィールドの概要
private  java.awt.Color backColor
          ゲームウインドウの背景色です.
private  java.util.List<WindowCloseEvent> closeEvetList
          ウインドウを閉じた際のイベントです.
private  int fps
          FPSです.
private  java.awt.Image icon
          ゲームウインドウのアイコンです.
private  java.awt.Point location
          ゲームウインドウが表示される位置です.
private  java.awt.RenderingHints renderingHints
          レンダリングの品質です.
private  java.awt.Dimension size
          ゲームウインドウのサイズです.
private  java.lang.String title
          ゲームウインドウのタイトルバーの文字列です.
private  boolean useGamePad
          ゲームパッドのDLLロードを行うかを決定します.
private  boolean useKeyboard
          キー入力を検査するかを決定します.
private  boolean useMouseCursor
          マウスカーソルをゲームウインドウ上に表示するかを決定します.
 
コンストラクタの概要
GameConfig()
          適当なタイトルでゲーム設定を作成します.
GameConfig(java.lang.String title)
          ゲーム設定を作成します.
 
メソッドの概要
 GameConfig addCloseEvent(WindowCloseEvent event)
          ウインドウを閉じる際のイベントを追加します.
protected  java.awt.Color getBackColor()
          ゲームウインドウの背景色を取得します.
protected  java.util.List<WindowCloseEvent> getCloseEvetList()
          追加されたウインドウクローズイベントを取得します.
protected  int getFps()
          FPSの最大値を取得します.
protected  java.awt.Image getIcon()
          ゲームウインドウのアイコンを取得します.
protected  java.awt.Point getLocation()
          ゲームウインドウの出現位置を取得します.
protected  java.awt.RenderingHints getRenderingHints()
          描画品質を取得します.
protected  java.awt.Dimension getSize()
          ゲームウインドウのサイズを取得します.
protected  java.lang.String getTitle()
          ゲームウインドウのタイトルを取得します.
protected  boolean isUseGamePad()
          ゲームパッドを使用するかを決定します.
protected  boolean isUseKeyboard()
          キーボードを使用するかを決定します.
protected  boolean isUseMouseCursor()
          マウスカーソルを使用するかを決定します.
 GameConfig setBackColor(java.awt.Color backColor)
          ウインドウの描画可能領域の背景色を指定します.
 GameConfig setCenterOfScreen()
          現在のウインドウサイズを使用して、ウインドウがスクリーンの中央に出現するように 位置を調節します.
 GameConfig setFps(int fps)
          FPSの最大値を設定します.
 GameConfig setHeight(int height)
          ウインドウのサイズを変更します.
 GameConfig setIcon(java.awt.Image icon)
          ゲームウインドウのアイコンを指定します.
 GameConfig setIcon(java.lang.String filePath)
          ゲームウインドウのアイコンを指定します.
 GameConfig setLocation(int x, int y)
          ゲームウインドウが出現する位置を指定します.
 GameConfig setLocation(java.awt.Point location)
          ゲームウインドウが出現する位置を指定します.
 GameConfig setRenderingHints(java.awt.RenderingHints renderingHints)
          描画品質を設定します.
 GameConfig setRenderingHints(RenderingPolicy policy)
          描画品質を設定します.
 GameConfig setSize(java.awt.Dimension size)
          ウインドウのサイズを変更します.
 GameConfig setSize(int width, int height)
          ウインドウのサイズを変更します.
 GameConfig setTitle(java.lang.String title)
          ゲームウインドウのタイトルバーの文字列を設定します.
 GameConfig setWidth(int width)
          ウインドウのサイズを変更します.
 GameConfig setX(int x)
          ゲームウインドウが出現する位置を指定します.
 GameConfig setY(int y)
          ゲームウインドウが出現する位置を指定します.
 java.lang.String toString()
           
 GameConfig useGamePad(boolean use)
          DLLをロードし、ゲームパッドを使用可能にするかを決定します.
 GameConfig useKeyboard(boolean use)
          キーリスナをゲームウインドウに登録し、キー状態を検査可能にするかを決定します.
 GameConfig useMouse(boolean use)
          ゲームウインドウ上でマウスカーソルを使用するかを決定します.
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

フィールドの詳細

title

private java.lang.String title
ゲームウインドウのタイトルバーの文字列です.


location

private java.awt.Point location
ゲームウインドウが表示される位置です.


size

private java.awt.Dimension size
ゲームウインドウのサイズです.


backColor

private java.awt.Color backColor
ゲームウインドウの背景色です.


icon

private java.awt.Image icon
ゲームウインドウのアイコンです.


fps

private int fps
FPSです.


renderingHints

private java.awt.RenderingHints renderingHints
レンダリングの品質です.


useMouseCursor

private boolean useMouseCursor
マウスカーソルをゲームウインドウ上に表示するかを決定します.


useGamePad

private boolean useGamePad
ゲームパッドのDLLロードを行うかを決定します.


useKeyboard

private boolean useKeyboard
キー入力を検査するかを決定します.


closeEvetList

private java.util.List<WindowCloseEvent> closeEvetList
ウインドウを閉じた際のイベントです.

コンストラクタの詳細

GameConfig

public GameConfig()
適当なタイトルでゲーム設定を作成します.


GameConfig

public GameConfig(java.lang.String title)
ゲーム設定を作成します.

パラメータ:
title - タイトルバーに表示する文字列を指定します。
メソッドの詳細

setTitle

public GameConfig setTitle(java.lang.String title)
ゲームウインドウのタイトルバーの文字列を設定します.

パラメータ:
title - タイトルバーに表示する文字列を指定します。
戻り値:
thisインスタンスを返します。

addCloseEvent

public GameConfig addCloseEvent(WindowCloseEvent event)
ウインドウを閉じる際のイベントを追加します.

パラメータ:
event - 新しいイベントを追加します。
戻り値:
thisインスタンスを返します。

setLocation

public GameConfig setLocation(java.awt.Point location)
ゲームウインドウが出現する位置を指定します.

パラメータ:
location - 位置を指定します。
戻り値:
thisインスタンスを返します。

setLocation

public GameConfig setLocation(int x,
                              int y)
ゲームウインドウが出現する位置を指定します.

パラメータ:
x - X方向の位置を指定します。
y - Y方向の位置を指定します。
戻り値:
thisインスタンスを返します。

setX

public GameConfig setX(int x)
ゲームウインドウが出現する位置を指定します.

パラメータ:
x - X方向の位置を指定します。
戻り値:
thisインスタンスを返します。

setY

public GameConfig setY(int y)
ゲームウインドウが出現する位置を指定します.

パラメータ:
y - Y方向の位置を指定します。
戻り値:
thisインスタンスを返します。

setCenterOfScreen

public GameConfig setCenterOfScreen()
現在のウインドウサイズを使用して、ウインドウがスクリーンの中央に出現するように 位置を調節します.

戻り値:
thisインスタンスを返します。

setSize

public GameConfig setSize(java.awt.Dimension size)
ウインドウのサイズを変更します. このメソッドでの”サイズ”とは、描画可能な領域のサイズです。 したがって、ウインドウ自体のサイズは、指定されたサイズよりも若干大きくなります。

パラメータ:
size - サイズを指定します。
戻り値:
thisインスタンスを返します。

setSize

public GameConfig setSize(int width,
                          int height)
ウインドウのサイズを変更します. このメソッドでの”サイズ”とは、描画可能な領域のサイズです。 したがって、ウインドウ自体のサイズは、指定されたサイズよりも若干大きくなります。

パラメータ:
width - 幅を指定します。
height - 高さを指定します。
戻り値:
thisインスタンスを返します。

setWidth

public GameConfig setWidth(int width)
ウインドウのサイズを変更します. このメソッドでの”サイズ”とは、描画可能な領域のサイズです。 したがって、ウインドウ自体のサイズは、指定されたサイズよりも若干大きくなります。

パラメータ:
width - 幅を指定します。
戻り値:
thisインスタンスを返します。

setHeight

public GameConfig setHeight(int height)
ウインドウのサイズを変更します. このメソッドでの”サイズ”とは、描画可能な領域のサイズです。 したがって、ウインドウ自体のサイズは、指定されたサイズよりも若干大きくなります。

パラメータ:
height - 高さを指定します。
戻り値:
thisインスタンスを返します。

setBackColor

public GameConfig setBackColor(java.awt.Color backColor)
ウインドウの描画可能領域の背景色を指定します.

パラメータ:
backColor - 背景色を指定します。
戻り値:
thisインスタンスを返します。

setIcon

public GameConfig setIcon(java.awt.Image icon)
ゲームウインドウのアイコンを指定します.

パラメータ:
icon - ウインドウのアイコンを指定します。
戻り値:
thisインスタンスを返します。

setIcon

public GameConfig setIcon(java.lang.String filePath)
                   throws ContentsFileNotFoundException,
                          ContentsIOException
ゲームウインドウのアイコンを指定します.

パラメータ:
filePath - ウインドウのアイコンのファイルパスを指定します。
戻り値:
thisインスタンスを返します。
例外:
ContentsFileNotFoundException - 画像ファイルが存在しないときに投げられます。
ContentsIOException - 画像がロードできない場合に投げられます。

setFps

public GameConfig setFps(int fps)
FPSの最大値を設定します.

パラメータ:
fps - FPSを指定します。通常は30?60です。
戻り値:
thisインスタンスを返します。

setRenderingHints

public GameConfig setRenderingHints(java.awt.RenderingHints renderingHints)
描画品質を設定します. 描画の品質を高く設定すると、画像やプリミティブ図名がきれいに表示できますが、 描画速度が下がります。
ゲームデザインを考慮し、品質と速度のバランスをとった設定を決める必要があります。

パラメータ:
renderingHints - レンダリングの設定を送信します。
戻り値:
thisインスタンスを返します。

setRenderingHints

public GameConfig setRenderingHints(RenderingPolicy policy)
描画品質を設定します. 描画の品質を高く設定すると、画像やプリミティブ図名がきれいに表示できますが、 描画速度が下がります。
ゲームデザインを考慮し、品質と速度のバランスをとった設定を決める必要があります。

パラメータ:
policy - レンダリングの設定を送信します。
戻り値:
thisインスタンスを返します。

useMouse

public GameConfig useMouse(boolean use)
ゲームウインドウ上でマウスカーソルを使用するかを決定します.

パラメータ:
use - trueを指定すると有効化されます。
戻り値:
thisインスタンスを返します。

useGamePad

public GameConfig useGamePad(boolean use)
DLLをロードし、ゲームパッドを使用可能にするかを決定します.

パラメータ:
use - trueを指定すると有効化されます。
戻り値:
thisインスタンスを返します。

useKeyboard

public GameConfig useKeyboard(boolean use)
キーリスナをゲームウインドウに登録し、キー状態を検査可能にするかを決定します.

パラメータ:
use - trueを指定すると有効化されます。
戻り値:
thisインスタンスを返します。

getBackColor

protected java.awt.Color getBackColor()
ゲームウインドウの背景色を取得します. このメソッドはKinugasaGameクラスから使用されます。

戻り値:
背景色を返します。

getFps

protected int getFps()
FPSの最大値を取得します. このメソッドはKinugasaGameクラスから使用されます。

戻り値:
FPSの最大値を返します。

getIcon

protected java.awt.Image getIcon()
ゲームウインドウのアイコンを取得します. このメソッドはKinugasaGameクラスから使用されます。

戻り値:
アイコンを返します。

getLocation

protected java.awt.Point getLocation()
ゲームウインドウの出現位置を取得します. このメソッドはKinugasaGameクラスから使用されます。

戻り値:
ゲームウインドウの出現位置を返します。

getRenderingHints

protected java.awt.RenderingHints getRenderingHints()
描画品質を取得します. このメソッドはKinugasaGameクラスから使用されます。

戻り値:
描画品質の設定を返します。

getSize

protected java.awt.Dimension getSize()
ゲームウインドウのサイズを取得します. このメソッドはKinugasaGameクラスから使用されます。

戻り値:
ゲームウインドウのサイズを返します。

getTitle

protected java.lang.String getTitle()
ゲームウインドウのタイトルを取得します. このメソッドはKinugasaGameクラスから使用されます。

戻り値:
ゲームウインドウのタイトルとゲームクラスの名前となる 文字列を返します。

isUseMouseCursor

protected boolean isUseMouseCursor()
マウスカーソルを使用するかを決定します. このメソッドはKinugasaGameクラスから使用されます。

戻り値:
マウスカーソルを使用する場合はtrueを返します。

isUseGamePad

protected boolean isUseGamePad()
ゲームパッドを使用するかを決定します. このメソッドはKinugasaGameクラスから使用されます。

戻り値:
ゲームパッドを使用する場合はtrueを返します。

isUseKeyboard

protected boolean isUseKeyboard()
キーボードを使用するかを決定します. このメソッドはKinugasaGameクラスから使用されます。

戻り値:
キーボードを使用する場合はtrueを返します。

getCloseEvetList

protected java.util.List<WindowCloseEvent> getCloseEvetList()
追加されたウインドウクローズイベントを取得します. このメソッドはKinugasaGameクラスから使用されます。

戻り値:
このゲーム設定に追加されているウインドウクローズイベントを追加された順の リストとして取得します。

toString

public java.lang.String toString()
オーバーライド:
クラス java.lang.Object 内の toString