Update docs

This commit is contained in:
Insality
2023-07-11 21:46:56 +03:00
parent bdacd4a440
commit 6ed48772a3
10 changed files with 67 additions and 18 deletions

View File

@@ -1,12 +1,12 @@
-- Copyright (c) 2023 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
--- Component with event on back and backspace button.
-- # Overview #
-- <b># Overview #</b>
--
-- Back Handler is recommended to put in every game window to close it
-- or in main screen to call settings window.
--
-- # Notes #
-- <b># Notes #</b>
--
-- • Back Handler inheritance @{BaseComponent}, you can use all of its methods in addition to those described here.
--

View File

@@ -1,9 +1,9 @@
-- Copyright (c) 2023 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
--- Component to consume input in special zone defined by GUI node.
-- # Overview #
-- <b># Overview #</b>
--
-- # Notes #
-- <b># Notes #</b>
--
-- Blocker consume input if `gui.pick_node` works on it.
--

View File

@@ -2,12 +2,12 @@
--- Druid Component for Handling User Click Interactions: Click, Long Click, Double Click, and More.
--
-- # Overview #
-- <b># Overview #</b>
--
-- This component provides a versatile solution for handling user click interactions.
-- It allows you to make any GUI node clickable and define various callbacks for different types of clicks.
--
-- # Notes #
-- <b># Notes #</b>
--
-- • The click callback will not trigger if the cursor moves outside the node's
-- area between the pressed and released states.

View File

@@ -1,7 +1,7 @@
-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
--- Component to handle scroll content.
-- # Overview #
-- <b># Overview #</b>
--
-- The Scroll component is designed to handle scrollable content and consists of two nodes: the scroll parent and the scroll input.
--
@@ -12,7 +12,7 @@
-- The initial scroll size can be set by adjusting the size of the scroll parent.
-- If the size of the scroll parent is smaller than the scroll input size, scrolling is not available.
--
-- # Notes #
-- <b># Notes #</b>
--
-- • By default, the scroll style includes inertia and extra size for a stretching effect.
-- These settings can be adjusted using the scroll style settings.