mirror of
https://github.com/Insality/druid
synced 2025-09-27 18:12:21 +02:00
Update docs
This commit is contained in:
@@ -1,4 +1,4 @@
|
||||
-- Copyright (c) 2021 Maxim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
|
||||
-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
|
||||
|
||||
--- Druid checkbox component
|
||||
-- @module Checkbox
|
||||
|
@@ -1,4 +1,4 @@
|
||||
-- Copyright (c) 2021 Maxim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
|
||||
-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
|
||||
|
||||
--- Checkbox group module
|
||||
-- @module CheckboxGroup
|
||||
|
@@ -1,4 +1,4 @@
|
||||
-- Copyright (c) 2021 Maxim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
|
||||
-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
|
||||
|
||||
--- Druid component template
|
||||
-- @module druid.component
|
||||
|
@@ -1,4 +1,4 @@
|
||||
-- Copyright (c) 2021 Maxim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
|
||||
-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
|
||||
|
||||
--- Component to manage data for huge dataset in scroll.
|
||||
-- It requires Druid Scroll and Druid Grid (Static or Dynamic) components
|
||||
|
@@ -1,4 +1,4 @@
|
||||
-- Copyright (c) 2021 Maxim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
|
||||
-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
|
||||
|
||||
--- Component to handle placing components in row
|
||||
-- @module DynamicGrid
|
||||
@@ -140,7 +140,7 @@ end
|
||||
-- @tparam node node Gui node
|
||||
-- @tparam[opt] number index The node position. By default add as last node
|
||||
-- @tparam[opt=SHIFT.RIGHT] number shift_policy How shift nodes, if required. See const.SHIFT
|
||||
-- @tparam[opt=false] boolean is_instance If true, update node positions instantly
|
||||
-- @tparam[opt=false] boolean is_instant If true, update node positions instantly
|
||||
function DynamicGrid.add(self, node, index, shift_policy, is_instant)
|
||||
shift_policy = shift_policy or const.SHIFT.RIGHT
|
||||
local delta = shift_policy -- -1 or 1 or 0
|
||||
@@ -182,7 +182,7 @@ end
|
||||
-- @tparam DynamicGrid self
|
||||
-- @tparam number index The grid node index to remove
|
||||
-- @tparam[opt=SHIFT.RIGHT] number shift_policy How shift nodes, if required. See const.SHIFT
|
||||
-- @tparam[opt=false] boolean is_instance If true, update node positions instantly
|
||||
-- @tparam[opt=false] boolean is_instant If true, update node positions instantly
|
||||
-- @treturn Node The deleted gui node from grid
|
||||
function DynamicGrid.remove(self, index, shift_policy, is_instant)
|
||||
shift_policy = shift_policy or const.SHIFT.RIGHT
|
||||
|
@@ -1,4 +1,4 @@
|
||||
-- Copyright (c) 2021 Maxim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
|
||||
-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
|
||||
|
||||
--- Druid input text component.
|
||||
-- Carry on user text input
|
||||
|
@@ -1,4 +1,4 @@
|
||||
-- Copyright (c) 2021 Maxim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
|
||||
-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
|
||||
|
||||
--- Component to handle all GUI texts
|
||||
-- Good working with localization system
|
||||
@@ -63,7 +63,13 @@ end
|
||||
--- Translate the text by locale_id
|
||||
-- @tparam LangText self
|
||||
-- @tparam string locale_id Locale id
|
||||
-- @tparam string ... Locale arguments to pass in text function
|
||||
-- @tparam[opt] string a Optional param to string.format
|
||||
-- @tparam[opt] string b Optional param to string.format
|
||||
-- @tparam[opt] string c Optional param to string.format
|
||||
-- @tparam[opt] string d Optional param to string.format
|
||||
-- @tparam[opt] string e Optional param to string.format
|
||||
-- @tparam[opt] string f Optional param to string.format
|
||||
-- @tparam[opt] string g Optional param to string.format
|
||||
-- @treturn LangText Current instance
|
||||
function LangText.translate(self, locale_id, a, b, c, d, e, f, g)
|
||||
self.last_locale_args = { a, b, c, d, e, f, g }
|
||||
@@ -76,7 +82,13 @@ end
|
||||
|
||||
--- Format string with new text params on localized text
|
||||
-- @tparam LangText self
|
||||
-- @tparam string ... Locale arguments to pass in text function
|
||||
-- @tparam[opt] string a Optional param to string.format
|
||||
-- @tparam[opt] string b Optional param to string.format
|
||||
-- @tparam[opt] string c Optional param to string.format
|
||||
-- @tparam[opt] string d Optional param to string.format
|
||||
-- @tparam[opt] string e Optional param to string.format
|
||||
-- @tparam[opt] string f Optional param to string.format
|
||||
-- @tparam[opt] string g Optional param to string.format
|
||||
-- @treturn LangText Current instance
|
||||
function LangText.format(self, a, b, c, d, e, f, g)
|
||||
self.last_locale_args = { a, b, c, d, e, f, g }
|
||||
|
@@ -1,4 +1,4 @@
|
||||
-- Copyright (c) 2021 Maxim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
|
||||
-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
|
||||
|
||||
--- Basic progress bar component.
|
||||
-- For correct progress bar init it should be in max size from gui
|
||||
|
@@ -1,4 +1,4 @@
|
||||
-- Copyright (c) 2021 Maxim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
|
||||
-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
|
||||
|
||||
--- Radio group module
|
||||
-- @module RadioGroup
|
||||
|
@@ -1,4 +1,4 @@
|
||||
-- Copyright (c) 2021 Maxim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
|
||||
-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
|
||||
|
||||
--- Druid slider component
|
||||
-- @module Slider
|
||||
|
@@ -1,4 +1,4 @@
|
||||
-- Copyright (c) 2021 Maxim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
|
||||
-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
|
||||
|
||||
--- Component to handle GUI timers.
|
||||
-- Timer updating by game delta time. If game is not focused -
|
||||
|
Reference in New Issue
Block a user