Editor API Reference - v1.1.4
    Preparing search index...

    Type Alias ScrollviewComponent

    Scrollview Component Properties.

    type ScrollviewComponent = {
        bounceAmount: number;
        contentEntity: string;
        enabled: boolean;
        friction: number;
        horizontal: boolean;
        horizontalScrollbarEntity: string;
        horizontalScrollbarVisibility: number;
        mouseWheelSensitivity: number[];
        scrollMode: number;
        useMouseWheel: boolean;
        vertical: boolean;
        verticalScrollbarEntity: string;
        verticalScrollbarVisibility: number;
        viewportEntity: string;
    }
    Index

    Properties

    bounceAmount contentEntity enabled friction horizontal horizontalScrollbarEntity horizontalScrollbarVisibility mouseWheelSensitivity scrollMode useMouseWheel vertical verticalScrollbarEntity verticalScrollbarVisibility viewportEntity

    Properties

    bounceAmount: number

    Controls how far the content should move before bouncing back.

    0.1
    contentEntity: string

    The resource_id of the entity containing the scrolling content. Must have an element component.

    null
    enabled: boolean

    Whether the component is enabled.

    true
    friction: number

    Controls how freely content moves if thrown, with 1 stopping immediately and 0 allowing perpetual movement.

    0.05
    horizontal: boolean

    Whether to enable horizontal scrolling.

    true
    horizontalScrollbarEntity: string

    The resource_id of the entity used as the horizontal scrollbar. Must have a scrollbar component.

    null
    horizontalScrollbarVisibility: number

    Controls visibility of the horizontal scrollbar.

    1
    mouseWheelSensitivity: number[]

    Controls mouse wheel sensitivity for scrolling, with 0 disabling it.

    [1,1]
    scrollMode: number

    How the scroll view behaves when scrolling past content end.

    1
    useMouseWheel: boolean

    Whether to use the mouse wheel for scrolling within bounds.

    true
    vertical: boolean

    Whether to enable vertical scrolling.

    true
    verticalScrollbarEntity: string

    The resource_id of the entity used as the vertical scrollbar. Must have a scrollbar component.

    null
    verticalScrollbarVisibility: number

    Controls visibility of the vertical scrollbar.

    1
    viewportEntity: string

    The resource_id of the entity used as the viewport area, within which content scrolls. Must have an element component of type group.

    null

    Settings

    Member Visibility

    On This Page

    Properties