PageView

UIScripts: PageViewComponentFeature: UI Controls (≈35 KB)

Optional feature

PageView is part of UI Controls. A build includes it only when a scene, prefab or script uses it — see Feature cropping.

From a script

import { PageViewComponent } from "mmpx";

const pageView = this.entity.TryGetComponent(PageViewComponent);

Full API: PageViewComponent.

Fields

Field	Type	Default	Description
Current Page currentPage	number (0 … ∞)	0
Scroll Threshold scrollThreshold	number (0.05 … 1)	0.3	How far (of a page) a drag goes before it turns the page
Flick Speed flickSpeed	number (0 … ∞) (px/s)	600	A faster flick turns the page however short it was
Turn Duration turnDuration	number (0.05 … ∞) (s)	0.3
Indicator indicator	Entity	—	An entity whose children are the page dots

Indicator

Field	Type	Default	Description
Dot color	colour	#5A5F6E
Current Dot activeColor	colour	#FFFFFF