Class: ScrollLayer

phina.display.ScrollLayer

new phina.display.ScrollLayer (options)

対象に合わせて自身の位置を調整し、スクロールしているように見せるレイヤークラス。
Name Type Description
options object optional phina.display.DisplayElementのパラメータも有効です。
Name Type Default Description
scrollType string linear optional スクロールの方法を指定:'instant', 'linear', 'slip'
scrollSpeed number 8 optional スクロール速度を指定。scrollType:'linear'の時のみ有効
scrollFriction number 0.1 optional slipスクロール時のフォーカス挙動を指定。scrollType:'slip'の時のみ有効
lockX boolean false optional x軸スクロールを禁止
lockY boolean false optional y軸スクロールを禁止
autoUpdate boolean true optional スクロールを自動で行うかどうか。falseの場合、都度updatePositionを呼び出す必要があります
Example
phina.globlize();
const SCREEN_WIDTH = 720;
const SCREEN_HEIGHT = 1080;

// in Scene Class...

// setup layer
const layer = ScrollLayer({
  lockY: true,
})
  .setCoordinate(SCREEN_WIDTH/2, SCREEN_HEIGHT/2)
  .addChildTo(this);

// setup target
this.player = Sprite('player').addChildTo(layer);
layer.setTarget(this.player)

Extends

  • phina.display.DisplayElement

Methods

setCoordinate (x, y)this

注視対象の画面表示位置をセット
例えば画面中心に映したいなら画面サイズ半分を指定する
Set coordinate of focusTarget screen position. layer.setCoordinate(this.width/2, this.height/2)
Name Type Description
x number X coordinate
y number Y coordinate
Returns:
Type Description
this

setLock (x, y)this

Lock x or y-axis scrolling
Name Type Description
x boolean lock x-axis scroll
y boolean lock y-axis scroll
Returns:
Type Description
this

setTarget (focusTarget)this

注視対象を指定
Set focusTarget
Name Type Description
focusTarget Vector2
Returns:
Type Description
this