Type Alias ScrollviewComponent

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;
}

Scrollview Component Properties.

Type declaration

  • bounceAmount: number

    Controls how far the content should move before bouncing back.

    Default

    0.1
  • contentEntity: string

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

    Default

    null
  • enabled: boolean

    Whether the component is enabled.

    Default

    true
  • friction: number

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

    Default

    0.05
  • horizontal: boolean

    Whether to enable horizontal scrolling.

    Default

    true
  • horizontalScrollbarEntity: string

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

    Default

    null
  • horizontalScrollbarVisibility: number

    Controls visibility of the horizontal scrollbar.

    Default

    1
  • mouseWheelSensitivity: number[]

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

    Default

    [1,1]
  • scrollMode: number

    How the scroll view behaves when scrolling past content end.

    Default

    1
  • useMouseWheel: boolean

    Whether to use the mouse wheel for scrolling within bounds.

    Default

    true
  • vertical: boolean

    Whether to enable vertical scrolling.

    Default

    true
  • verticalScrollbarEntity: string

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

    Default

    null
  • verticalScrollbarVisibility: number

    Controls visibility of the vertical scrollbar.

    Default

    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.

    Default

    null

Settings

Member Visibility