Phaser 3 UI Components

Class: UIScrollPanel

PhaserComps.UIComponents. UIScrollPanel

Scrolling panel with scrollbar applied to it. First parameter is container, where this should find the panel, scroll bar and dimensions instances UIScrollBar instance created inside with a provided scrollBarKey

Warning! This component doesn't extend UIComponent.ComponentPrototype

new UIScrollPanel(container, panelKey, scrollBarKey, dimensionsKey [, vertical])

Parameters:
Name Type Argument Default Description
container PhaserComps.UIComponents.UIComponentPrototype
panelKey String
scrollBarKey String
dimensionsKey String
vertical Boolean <optional>
 false

Type Definitions

ScrollBoundsObject

Object is generated automatically on container's clip update, by the dimensions clip

Properties:
Name Type Description
x Number

Start x position of the container. Used, if panel is horizontal
y Number

Start x position of the container. Used, if panel is vertical
len Number

Scroll distance of the container. On scroll down/right, x or y position will be subtracted by len multiplied by scrollbar value