Partydeck/Extension-Druid
3
0
Fork 0
mirror of https://github.com/Insality/druid.git synced 2025-06-27 18:37:44 +02:00
Code Issues Packages Projects Releases Wiki Activity
Extension-Druid/api/components/base/scroll_api.md
Insality b30cf9109e Test new markdown api generator
2025-03-14 20:29:05 +02:00

8.1 KiB
Raw Blame History

druid.scroll API

at /druid/base/scroll.lua

Functions

Fields

init

scroll:init(view_node, content_node)

The Scroll constructor

  • Parameters:
    • view_node (string|node): GUI view scroll node
    • content_node (string|node): GUI content scroll node

on_style_change

scroll:on_style_change(style)
  • Parameters:
    • style (druid.scroll.style): Scroll style parameters

on_late_init

scroll:on_late_init()

on_layout_change

scroll:on_layout_change()

update

scroll:update([dt])
  • Parameters:
    • [dt] (any):

on_input

scroll:on_input([action_id], [action])

  • Parameters:

    • [action_id] (any):
    • [action] (any):

  • Returns:

    • `` (boolean):

on_remove

scroll:on_remove()

scroll_to

scroll:scroll_to(point, [is_instant])

Start scroll to target point.

  • Parameters:
    • point (vector3): Target point
    • [is_instant] (boolean|nil): Instant scroll flag

scroll_to_index

scroll:scroll_to_index(index, [skip_cb])

Scroll to item in scroll by point index.

  • Parameters:
    • index (number): Point index
    • [skip_cb] (boolean|nil): If true, skip the point callback

scroll_to_percent

scroll:scroll_to_percent(percent, [is_instant])

Start scroll to target scroll percent

  • Parameters:
    • percent (vector3): target percent
    • [is_instant] (boolean|nil): instant scroll flag

get_percent

scroll:get_percent()

Return current scroll progress status. Values will be in [0..1] interval

  • Returns:
    • New (vector3): vector with scroll progress values

set_size

scroll:set_size(size, [offset])

Set scroll content size. It will change content gui node size

  • Parameters:

    • size (vector3): The new size for content node
    • [offset] (vector3|nil): Offset value to set, where content is starts

  • Returns:

    • Current (druid.scroll): scroll instance

set_view_size

scroll:set_view_size(size)

Set new scroll view size in case the node size was changed.

  • Parameters:

    • size (vector3): The new size for view node

  • Returns:

    • Current (druid.scroll): scroll instance

update_view_size

scroll:update_view_size()

Refresh scroll view size

  • Returns:
    • `` (druid.scroll):

set_inert

scroll:set_inert(state)

Enable or disable scroll inert If disabled, scroll through points (if exist) If no points, just simple drag without inertion

  • Parameters:

    • state (boolean): Inert scroll state

  • Returns:

    • Current (druid.scroll): scroll instance

is_inert

scroll:is_inert()

Return if scroll have inertion

  • Returns:
    • is_inert (boolean): If scroll have inertion

set_extra_stretch_size

scroll:set_extra_stretch_size([stretch_size])

Set extra size for scroll stretching Set 0 to disable stretching effect

  • Parameters:

    • [stretch_size] (number|nil): Size in pixels of additional scroll area

  • Returns:

    • Current (druid.scroll): scroll instance

get_scroll_size

scroll:get_scroll_size()

Return vector of scroll size with width and height.

  • Returns:
    • Available (vector3): scroll size

set_points

scroll:set_points(points)

Set points of interest. Scroll will always centered on closer points

  • Parameters:

    • points (table): Array of vector3 points

  • Returns:

    • Current (druid.scroll): scroll instance

set_horizontal_scroll

scroll:set_horizontal_scroll(state)

Lock or unlock horizontal scroll

  • Parameters:

    • state (boolean): True, if horizontal scroll is enabled

  • Returns:

    • Current (druid.scroll): scroll instance

set_vertical_scroll

scroll:set_vertical_scroll(state)

Lock or unlock vertical scroll

  • Parameters:

    • state (boolean): True, if vertical scroll is enabled

  • Returns:

    • Current (druid.scroll): scroll instance

is_node_in_view

scroll:is_node_in_view(node)

Check node if it visible now on scroll. Extra border is not affected. Return true for elements in extra scroll zone

  • Parameters:

    • node (node): The node to check

  • Returns:

    • True (boolean): if node in visible scroll area

bind_grid

scroll:bind_grid([grid])

Bind the grid component (Static or Dynamic) to recalculate scroll size on grid changes

  • Parameters:

    • [grid] (druid.grid|nil): Druid grid component

  • Returns:

    • Current (druid.scroll): scroll instance

set_click_zone

scroll:set_click_zone(node)

Strict drag scroll area. Useful for restrict events outside stencil node

  • Parameters:
    • node (string|node): Gui node

Fields

  • node (node): The root node

  • click_zone (node): Optional click zone to restrict scroll area

  • on_scroll (event): Triggered on scroll move with (self, position)

  • on_scroll_to (event): Triggered on scroll_to with (self, target, is_instant)

  • on_point_scroll (event): Triggered on scroll_to_index with (self, index, point)

  • view_node (node): The scroll view node (static part)

  • view_border (vector4): The scroll view borders

  • content_node (node): The scroll content node (moving part)

  • view_size (vector3): Size of the view node

  • position (vector3): Current scroll position

  • target_position (vector3): Target scroll position for animations

  • available_pos (vector4): Available content position (min_x, max_y, max_x, min_y)

  • available_size (vector3): Size of available positions (width, height, 0)

  • drag (druid.drag): The drag component instance

  • selected (number): Current selected point of interest index

  • is_animate (boolean): True if scroll is animating

  • style (druid.scroll.style): Component style parameters

  • druid (druid.instance)

  • hover (druid.hover)

  • points (table)

  • available_pos_extra (unknown)

  • available_size_extra (vector3)