Class: viewport

viewport()

ワールド座標系と実際の画面表示座標系の変換を管理するクラスです。
\ ゲーム内のスプライトがどの位置にあり、画面のどこに表示されるべきか、
\ また、表示範囲内にあるかどうかの判定を行います。

Constructor

new viewport()

Source:

Members

bmh :number

ビューポート周囲の余白高さ
Type:
  • number
Source:

bmw :number

ビューポート周囲の余白幅
Type:
  • number
Source:

h :number

ビューポートの表示領域高さ
Type:
  • number
Source:

w :number

ビューポートの表示領域幅
Type:
  • number
Source:

x :number

ワールド座標系におけるビューポート(左上)の水平基準位置
Type:
  • number
Source:

y :number

ワールド座標系におけるビューポート(左上)の垂直基準位置
Type:
  • number
Source:

Methods

border(w, h)

表示範囲の判定に使用する、ビューポート周囲の余白を設定します。
\ オブジェクトがこの余白範囲から外に出るまで
\ ビューポート内に存在すると判定されます。
Parameters:
Name Type Description
w number 余白幅
h number 余白高さ
Source:

repeat(modeopt)

ビューポートの繰り返しモードを有効/無効にします。
\ このモードが`true`の場合、画面外に出たオブジェクトが反対側から現れるように
\ 座標が折り返して計算されます。
Parameters:
Name Type Attributes Default Description
mode boolean <optional>
true 有効/無効
Source:

setPos(x, y)

ワールド座標系におけるビューポートの基準位置(左上)を設定します。
\ この位置を移動させることで、ゲームの世界をスクロールさせたり
\ カメラの視点を変更したりできます。
Parameters:
Name Type Description
x number 基準位置X
y number 基準位置Y
Source:

size(w, h)

ビューポートの表示領域の幅と高さを設定します。
\ 通常、これはゲームの実際の画面解像度に合わせて設定され、
\ 表示可能な範囲を定義します。
Parameters:
Name Type Description
w number 表示領域幅
h number 表示領域高さ
Source:

viewtoReal(sx, sy) → {viewportResult}

ワールド座標を実際の画面表示座標に変換し、ビューポート内にあるかを判定します。
\ スプライトなどのワールド座標をこのメソッドに通すことで、
\ 正しい画面上の位置と表示可否の情報を取得できます。
Parameters:
Name Type Description
sx number ワールド座標X
sy number ワールド座標Y
Source:
Returns:
Type
viewportResult