Skip to content

A fast 2D and 3D game engine — TypeScript SDK, C++/WebAssembly core, visual editor. Ship one project to web, desktop, WeChat MiniGames, playable ads, and native Android / iOS.

1.3 KB
Raw Blame
// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright (c) 2024-present ESEngine Team
import { defineBuiltin } from '../../ecs/component';

// Clamped stops dead at the ends; Elastic overshoots and springs back, which is
// the touch-UI feel. Single-sourced from the C++ ES_ENUM via the generated
// module, so the number this writes is the number the scroller reads.
export { ScrollMovement } from '../../wasm/wasm.generated';
import { ScrollMovement } from '../../wasm/wasm.generated';

/**
 * A scrollable viewport, authored in the scene rather than constructed in code.
 * `uiBehaviorPlugin` attaches a ScrollContainer to every entity carrying one.
 */
export interface UIScrollData {
    enabled: boolean;
    /** The child that moves; 0 ⇒ this node's first child. */
    content: number;
    horizontal: boolean;
    vertical: boolean;
    movement: ScrollMovement;
    wheelSpeed: number;
    dragScroll: boolean;
    /** Fraction of flick velocity kept per second; 0 stops on release. */
    decelerationRate: number;
}

export const UIScroll = defineBuiltin<UIScrollData>('UIScroll', {
    enabled: true,
    content: 0,
    horizontal: false,
    vertical: true,
    movement: ScrollMovement.Clamped,
    wheelSpeed: 1,
    dragScroll: true,
    decelerationRate: 0.135,
});