ScrollViewComponent(system, entity) 

Create a new ScrollViewComponent.

Parameters

system	ScrollViewComponentSystem	The ComponentSystem that created this Component.
entity	Entity	The Entity that this Component is attached to.

numberbounceAmount 

Controls how far the content should move before bouncing back.

EntitycontentEntity 

The entity which contains the scrolling content itself. This entity must have an Element component.

numberfriction 

Controls how freely the content should move if thrown, i.e. By flicking on a phone or by flinging the scroll wheel on a mouse. A value of 1 means that content will stop immediately; 0 means that content will continue moving forever (or until the bounds of the content are reached, depending on the scrollMode).

booleanhorizontal 

Whether to enable horizontal scrolling.

EntityhorizontalScrollbarEntity 

The entity to be used as the vertical scrollbar. This entity must have a Scrollbar component.

numberhorizontalScrollbarVisibility 

Controls whether the horizontal scrollbar should be visible all the time, or only visible when the content exceeds the size of the viewport.

Vec2mouseWheelSensitivity 

Mouse wheel horizontal and vertical sensitivity. Only used if useMouseWheel is set. Setting a direction to 0 will disable mouse wheel scrolling in that direction. 1 is a default sensitivity that is considered to feel good. The values can be set higher or lower than 1 to tune the sensitivity. Defaults to [1, 1].

numberscrollMode 

Specifies how the scroll view should behave when the user scrolls past the end of the content. Modes are defined as follows:

• SCROLL_MODE_CLAMP: Content does not scroll any further than its bounds.
• SCROLL_MODE_BOUNCE: Content scrolls past its bounds and then gently bounces back.
• SCROLL_MODE_INFINITE: Content can scroll forever.

booleanuseMouseWheel 

Whether to use mouse wheel for scrolling (horizontally and vertically).

booleanvertical 

Whether to enable vertical scrolling.

EntityverticalScrollbarEntity 

The entity to be used as the vertical scrollbar. This entity must have a Scrollbar component.

numberverticalScrollbarVisibility 

Controls whether the vertical scrollbar should be visible all the time, or only visible when the content exceeds the size of the viewport.

EntityviewportEntity 

The entity to be used as the masked viewport area, within which the content will scroll. This entity must have an ElementGroup component.

set:scroll 

Fired whenever the scroll position changes.

Parameters

scrollPosition

Vec2

Horizontal and vertical scroll values in the range 0...1.

booleanenabled 

Enables or disables the component.

Entityentity 

The Entity that this Component is attached to.

ComponentSystemsystem 

The ComponentSystem used to create this Component.

fire(name, [arg1], [arg2], [arg3], [arg4], [arg5], [arg6], [arg7], [arg8]) 

Fire an event, all additional arguments are passed on to the event listener.

obj.fire('test', 'This is the message');

Parameters

name	string	Name of event to fire.
arg1	*	First argument that is passed to the event handler.
arg2	*	Second argument that is passed to the event handler.
arg3	*	Third argument that is passed to the event handler.
arg4	*	Fourth argument that is passed to the event handler.
arg5	*	Fifth argument that is passed to the event handler.
arg6	*	Sixth argument that is passed to the event handler.
arg7	*	Seventh argument that is passed to the event handler.
arg8	*	Eighth argument that is passed to the event handler.

Returns

EventHandler

Self for chaining.

hasEvent(name) 

Test if there are any handlers bound to an event name.

obj.on('test', function () { }); // bind an event to 'test'
obj.hasEvent('test'); // returns true
obj.hasEvent('hello'); // returns false

Parameters

name

string

The name of the event to test.

Returns

boolean

True if the object has handlers bound to the specified event name.

off([name], [callback], [scope]) 

Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.

const handler = function () {
};
obj.on('test', handler);

obj.off(); // Removes all events
obj.off('test'); // Removes all events called 'test'
obj.off('test', handler); // Removes all handler functions, called 'test'
obj.off('test', handler, this); // Removes all handler functions, called 'test' with scope this

Parameters

name	string	Name of the event to unbind.
callback	HandleEventCallback	Function to be unbound.
scope	object	Scope that was used as the this when the event is fired.

Returns

EventHandler

Self for chaining.

on(name, callback, [scope]) 

Attach an event handler to an event.

obj.on('test', function (a, b) {
    console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console

const evt = obj.on('test', function (a, b) {
    console.log(a + b);
});
// some time later
evt.off();

Parameters

name	string	Name of the event to bind the callback to.
callback	HandleEventCallback	Function that is called when event is fired. Note the callback is limited to 8 arguments.
scope	object	Object to use as 'this' when the event is fired, defaults to current this.

Returns

EventHandle

Can be used for removing event in the future.

once(name, callback, [scope]) 

Attach an event handler to an event. This handler will be removed after being fired once.

obj.once('test', function (a, b) {
    console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console
obj.fire('test', 1, 2); // not going to get handled

Parameters

name	string	Name of the event to bind the callback to.
callback	HandleEventCallback	Function that is called when event is fired. Note the callback is limited to 8 arguments.
scope	object	Object to use as 'this' when the event is fired, defaults to current this.

Returns

EventHandle

• can be used for removing event in the future.