• Studio

  • Studio API

  • Bots

  • Web API

  • Designer Resources

  • Host Resources

  • Globals

    UIScrollView

    Inherits from:

    Properties

    defaultScrollDecelerationRate

    number
    ClientOnly
    ReadOnly

    fastScrollDecelerationRate

    number
    ClientOnly
    ReadOnly

    minInertiaVelocity

    number
    ClientOnly
    ReadOnly

    ussScrollView

    string
    ClientOnly
    ReadOnly

    ussScrollViewContent

    string
    ClientOnly
    ReadOnly

    ussScrollViewFadeEdges

    string
    ClientOnly
    ReadOnly

    ussScrollViewGradients

    string
    ClientOnly
    ReadOnly

    ussScrollViewGradientsBottom

    string
    ClientOnly
    ReadOnly

    ussScrollViewGradientsTop

    string
    ClientOnly
    ReadOnly

    ussScrollViewHorizontal

    string
    ClientOnly
    ReadOnly

    ussScrollViewVertical

    string
    ClientOnly
    ReadOnly

    ussScrollViewViewport

    string
    ClientOnly
    ReadOnly

    Contains full content, potentially partially visible

    contentSize

    number
    ClientOnly
    ReadOnly

    Returns the size of the content container

    Represents the visible part of contentContainer.

    hasInertia

    boolean
    ClientOnly
    ReadOnly

    Returns true if the scroll view has inertia

    isAtEnd

    boolean
    ClientOnly
    ReadOnly

    Check to see if the scrollbar is at the end or not

    isClamped

    boolean
    ClientOnly
    ReadOnly

    Returns true if the scroll view is clamped to the scroll extents

    isDraggable

    boolean
    ClientOnly

    If the scroll view is scrollable using drag gesture

    isElastic

    boolean
    ClientOnly
    ReadOnly

    Returns true if the scroll view will use an elastic behaviour when scrolling past the end of the extents.

    isInertiaEnabled

    boolean
    ClientOnly

    isScrolling

    boolean
    ClientOnly
    ReadOnly

    True if the scroll view is currently moving (scrolling or animating).

    onScrollEnd

    () -> ()
    ClientOnly

    Called when scrolling ends, either by lifting a finger or by the scroll animation ending.

    scrollDecelerationRate

    number
    ClientOnly

    Controls the rate at which the scrolling movement slows after a user scrolls using a touch interaction.

    scrollWheelRate

    number
    ClientOnly

    Global value for the rate at which the scroll wheel scrolls

    scrollableSize

    number
    ClientOnly
    ReadOnly

    Returns the amount of scroll

    value

    number
    ClientOnly

    Get/Set the current scroll offset

    viewportSize

    number
    ClientOnly
    ReadOnly

    Size of the viewport and padding

    worldBound

    ClientOnly
    ReadOnly

    Rect representing the world bounds of the scroll view

    Methods

    Parameters

    delta
    number

    Returns

    void

    Returns

    void

    CancelAnimation

    ClientOnly

    Returns

    void

    Dispose

    ClientOnly

    Returns

    void

    ScrollTo

    ClientOnly

    Scroll to a specific child element.

    Parameters

    Returns

    void

    Parameters

    animationDuration
    number
    optional

    Returns

    void

    ScrollToElement

    ClientOnly

    Parameters

    animationDuration
    number
    optional

    Returns

    void

    ScrollToEnd

    ClientOnly

    Parameters

    animationDuration
    number
    optional

    Returns

    void

    ScrollToOffset

    ClientOnly

    Parameters

    offset
    number
    animationDuration
    number
    optional
    propagateAnimation
    boolean
    optional

    Returns

    void

    Parameters

    newValue
    number

    Returns

    void

    Updated 24 days ago

    PocketWorlds Icon

    © 2025 Pocket Worlds. All rights reserved.