

Scroll-able panel

Introduction

A container with a panel, slider, and scroller.

• Author: Rex
• Game object

Source code

Plugin, minify

Class

Usage

Sample code

Install scene plugin

Install plugin in configuration of game

import UIPlugin from 'rexTemplates/ui/ui-plugin.js';

var config = {
    // ...
    plugins: {
        scene: [{
            key: 'rexUI',
            plugin: UIPlugin,
            mapping: 'rexUI'
        },
        // ...
        ]
    }
    // ...
};
var game = new Phaser.Game(config);

Add scroll-able panel object

var scrollablePanel = scene.rexUI.add.scrollablePanel({
    // x: 0,
    // y: 0,
    // anchor: undefined,
    // width: undefined,
    // height: undefined,

    scrollMode: 0,

    // Elements
    background: backgroundGameObject,

    panel: {
        child: panelGameObject,
        mask: {
            padding: 0
        }
    }.

    slider: {
        track: trackGameObject,
        thumb: thumbGameObject,
    },

    scroller: {
        threshold: 10,
        slidingDeceleration: 5000,
        backDeceleration: 2000,
    },

    clamplChildOY: false,

    header: headerGameObject,
    footer: footerGameObject,

    space: {
        left: 0,
        right: 0,
        top: 0,
        bottom: 0,

        panel: 0,
        // panel: {
        //    top: 0,
        //    bottom: 0,
        //    left: 0,
        //    right: 0,
        //},
        header: 0,
        footer: 0,
    },

    expand: {
        header: true,
        footer: true,
    },

    align: {
        header: 'center',
        footer: 'center',
    },

    // name: '',
    // draggable: false
});

• x, y : Position of this object, it is valid when this object is the top object.
• anchor : See anchor.
  • left, right, centerX, x, top, bottom, centerY, y : Position based on visible window, which composed of
    • Percentage of visible width/height : 'p%', p: 0 ~ 100.
      • 'left'(=0%), 'center'(=50%), 'right'(=100%)
      • 'top'(=0%), 'center'(=50%), 'bottom'(=100%)
    • Offset : '+n', or '-n'.
• width, height : Minimum width, minimum height.
• scrollMode : Scroll panel vertically, or horizontally.
  • 0, 'vertical', or 'v' : Scroll panel vertically. Default value.
  • 1, 'horizontal', or 'h' : Scroll panel horizontally.
• background : Game object of background, optional. This background game object will be resized to fit the size of scroll-able panel.
• panel : Configuration of panel game object.
  • panel.child : Panel game object.
  • panel.mask : Configuration of panel's mask.
    • Set panel.mask to false to disable masking.
  • panel.mask.padding : Extend mask with padding. Default value is 0.
• slider : Componments of slider, optional.
  • slider.background : Game object of slider background, optional.
  • slider.track : Game object of track.
  • slider.thumb : Game object of thumb.
  • slider.input :
    • 'drag' : Control slider by dragging thumb game object. Default setting.
    • 'click' : Control slider by touching track game object.
    • 'none' : Disable sider controlling.
  • Set to false to skip creating slider.
• scroller : Configuration of scroller behavior.
  • scroller.threshold : Minimal movement to scroll. Set 0 to scroll immediately.
  • scroller.slidingDeceleration : Deceleration of slow down when dragging released.
    • Set false to disable it.
  • scroller.backDeceleration : Deceleration of pull back when out of bounds.
    • Set false to disable it.
  • Set to false to skip creating scroller.
• clamplChildOY : Set true to clamp scrolling.
• header : Game object of header, optional.
• footer : Game object of footer, optional.
• space : Pads spaces
  • space.left, space.right, space.top, space.bottom : Space of bounds.
  • space.panel :
    • A number: Space between panel object and slider object.
    • An object: Padding of panel object.
      • If scrollMode is 0 (vertical) :
        • space.panel.top, space.panel.bottom : Top, bottom padding space of panel object.
        • space.panel.right : Space between panel object and slider object.
      • If scrollMode is 1 (horizontal) :
        • space.panel.left, space.panel.right : Left, right padding space of panel object.
        • space.panel.bottom : Space between panel object and slider object.
  • space.header : Space between header and panel.
  • space.footer : Space between footer and panel.
• expand : Expand width or height of element
  • expand.header : Set true to expand width or height of header game object.
  • expand.footer
• align : Align element
  • align.header
    • 'center', or Phaser.Display.Align.CENTER : Align game object at center. Default value.
    • 'left', or Phaser.Display.Align.LEFT_CENTER : Align game object at left-center.
    • 'right', or Phaser.Display.Align.RIGHT_CENTER : Align game object at right-center.
  • align.footer
• name : Set name of this panel.

Custom class

• Define class

  class MyPanel extends RexPlugins.UI.ScrollablePanel {
      constructor(scene, config) {
          super(scene, config);
          // ...
      }
      // ...
  }
  

• Create instance

  var scrollablePanel = new MyPanel(scene, config);
  

Layout children

Arrange position of all elements.

scrollablePanel.layout();

Scroll content

• Set

  scrollablePanel.setChildOY(oy);
  

  or

  scrollablePanel.childOY = oy;
  

• Get

  var childOY = scrollablePanel.childOY;
  

Scroll by percentage

• Set

  scrollablePanel.setT(t);  // t: 0~1
  

  or

  scrollablePanel.t = t;
  

• Get

  var t = scrollablePanel.t;
  

• Top OY

  var topOY = scrollablePanel.topChildOY;
  

• Bottom OY

  var bottomOY = scrollablePanel.bottomChildOY;
  

Scroll to top/bottom

• Scroll to top

  scrollablePanel.scrollToTop();
  

  • Equal to scrollablePanel.t = 0;
• Scroll to bottom

  scrollablePanel.scrollToBottom();
  

  • Equal to scrollablePanel.t = 1;

Enable/disable scrolling

• Slider
  • Set enable state

    scrollablePanel.setSliderEnable(enabled);
    

    or

    scrollablePanel.sliderEnable = enabled;
    

  • Get enable state

    var enable = scrollablePanel.sliderEnable;
    

• Scroller
  • Set enable state

    scrollablePanel.setScrollerEnable(enabled);
    

    or

    scrollablePanel.scrollerEnable = enabled;
    

  • Get enable state

    var enable = scrollablePanel.scrollerEnable;
    

Other properties

See sizer object, base sizer object.

Get element

• Get element
  • Background game object

    var background = scrollablePanel.getElement('background');
    

  • Panel game object

    var panel = scrollablePanel.getElement('panel');
    

  • Slider
    • Track

      var track = scrollablePanel.getElement('slider.track');
      

    • Thumb

      var thumb = scrollablePanel.getElement('slider.thumb');
      

  • Scroller

    var scroller = scrollablePanel.getElement('scroller');
    

• Get by name

  var gameObject = scrollablePanel.getElement('#' + name);