mirror of
https://github.com/Insality/druid.git
synced 2025-09-27 18:12:19 +02:00
Test new markdown api generator
This commit is contained in:
Insality
178
api/components/custom/rich_input_api.md
Normal file
178
api/components/custom/rich_input_api.md
Normal file
@@ -0,0 +1,178 @@
|
||||
# druid.rich_input API
|
||||
|
||||
> at /druid/custom/rich_input/rich_input.lua
|
||||
|
||||
|
||||
## Functions
|
||||
- [init](#init)
|
||||
- [on_input](#on_input)
|
||||
- [set_placeholder](#set_placeholder)
|
||||
- [select](#select)
|
||||
- [set_text](#set_text)
|
||||
- [set_font](#set_font)
|
||||
- [get_text](#get_text)
|
||||
- [set_allowed_characters](#set_allowed_characters)
|
||||
|
||||
|
||||
## Fields
|
||||
- [root](#root)
|
||||
- [input](#input)
|
||||
- [cursor](#cursor)
|
||||
- [cursor_text](#cursor_text)
|
||||
- [cursor_position](#cursor_position)
|
||||
- [druid](#druid)
|
||||
- [is_lshift](#is_lshift)
|
||||
- [is_lctrl](#is_lctrl)
|
||||
- [is_button_input_enabled](#is_button_input_enabled)
|
||||
- [drag](#drag)
|
||||
- [placeholder](#placeholder)
|
||||
- [text_position](#text_position)
|
||||
|
||||
|
||||
|
||||
### init
|
||||
|
||||
---
|
||||
```lua
|
||||
rich_input:init(template, nodes)
|
||||
```
|
||||
|
||||
- **Parameters:**
|
||||
- `template` *(string)*: The template string name
|
||||
- `nodes` *(table)*: Nodes table from gui.clone_tree
|
||||
|
||||
### on_input
|
||||
|
||||
---
|
||||
```lua
|
||||
rich_input:on_input([action_id], [action])
|
||||
```
|
||||
|
||||
- **Parameters:**
|
||||
- `[action_id]` *(any)*:
|
||||
- `[action]` *(any)*:
|
||||
|
||||
- **Returns:**
|
||||
- `` *(boolean)*:
|
||||
|
||||
### set_placeholder
|
||||
|
||||
---
|
||||
```lua
|
||||
rich_input:set_placeholder(placeholder_text)
|
||||
```
|
||||
|
||||
Set placeholder text
|
||||
|
||||
- **Parameters:**
|
||||
- `placeholder_text` *(string)*: The placeholder text
|
||||
|
||||
- **Returns:**
|
||||
- `` *(druid.rich_input)*:
|
||||
|
||||
### select
|
||||
|
||||
---
|
||||
```lua
|
||||
rich_input:select()
|
||||
```
|
||||
|
||||
Select input field
|
||||
|
||||
### set_text
|
||||
|
||||
---
|
||||
```lua
|
||||
rich_input:set_text(text)
|
||||
```
|
||||
|
||||
Set input field text
|
||||
|
||||
- **Parameters:**
|
||||
- `text` *(string)*: The input text
|
||||
|
||||
- **Returns:**
|
||||
- `self` *(druid.rich_input)*: Current instance
|
||||
|
||||
### set_font
|
||||
|
||||
---
|
||||
```lua
|
||||
rich_input:set_font(font)
|
||||
```
|
||||
|
||||
Set input field font
|
||||
|
||||
- **Parameters:**
|
||||
- `font` *(hash)*: The font hash
|
||||
|
||||
- **Returns:**
|
||||
- `self` *(druid.rich_input)*: Current instance
|
||||
|
||||
### get_text
|
||||
|
||||
---
|
||||
```lua
|
||||
rich_input:get_text()
|
||||
```
|
||||
|
||||
Set input field text
|
||||
|
||||
- **Returns:**
|
||||
- `` *(string)*:
|
||||
|
||||
### set_allowed_characters
|
||||
|
||||
---
|
||||
```lua
|
||||
rich_input:set_allowed_characters(characters)
|
||||
```
|
||||
|
||||
Set allowed charaters for input field.
|
||||
See: https://defold.com/ref/stable/string/
|
||||
ex: [%a%d] for alpha and numeric
|
||||
|
||||
- **Parameters:**
|
||||
- `characters` *(string)*: Regulax exp. for validate user input
|
||||
|
||||
- **Returns:**
|
||||
- `Current` *(druid.rich_input)*: instance
|
||||
|
||||
|
||||
## Fields
|
||||
<a name="root"></a>
|
||||
- **root** (_node_)
|
||||
|
||||
<a name="input"></a>
|
||||
- **input** (_druid.input_)
|
||||
|
||||
<a name="cursor"></a>
|
||||
- **cursor** (_node_)
|
||||
|
||||
<a name="cursor_text"></a>
|
||||
- **cursor_text** (_node_)
|
||||
|
||||
<a name="cursor_position"></a>
|
||||
- **cursor_position** (_vector3_)
|
||||
|
||||
<a name="druid"></a>
|
||||
- **druid** (_druid.instance_)
|
||||
|
||||
<a name="is_lshift"></a>
|
||||
- **is_lshift** (_boolean_)
|
||||
|
||||
<a name="is_lctrl"></a>
|
||||
- **is_lctrl** (_boolean_)
|
||||
|
||||
<a name="is_button_input_enabled"></a>
|
||||
- **is_button_input_enabled** (_unknown_)
|
||||
|
||||
<a name="drag"></a>
|
||||
- **drag** (_druid.drag_)
|
||||
|
||||
<a name="placeholder"></a>
|
||||
- **placeholder** (_druid.text_)
|
||||
|
||||
<a name="text_position"></a>
|
||||
- **text_position** (_unknown_)
|
||||
|
||||
187
api/components/custom/rich_text_api.md
Normal file
187
api/components/custom/rich_text_api.md
Normal file
@@ -0,0 +1,187 @@
|
||||
# druid.rich_text API
|
||||
|
||||
> at /druid/custom/rich_text/rich_text.lua
|
||||
|
||||
|
||||
## Functions
|
||||
- [init](#init)
|
||||
- [on_layout_change](#on_layout_change)
|
||||
- [on_style_change](#on_style_change)
|
||||
- [set_text](#set_text)
|
||||
- [get_text](#get_text)
|
||||
- [on_remove](#on_remove)
|
||||
- [clear](#clear)
|
||||
- [tagged](#tagged)
|
||||
- [characters](#characters)
|
||||
- [get_words](#get_words)
|
||||
- [get_line_metric](#get_line_metric)
|
||||
|
||||
|
||||
## Fields
|
||||
- [root](#root)
|
||||
- [text_prefab](#text_prefab)
|
||||
- [style](#style)
|
||||
|
||||
|
||||
|
||||
### init
|
||||
|
||||
---
|
||||
```lua
|
||||
rich_text:init(text_node, [value])
|
||||
```
|
||||
|
||||
- **Parameters:**
|
||||
- `text_node` *(string|node)*: The text node to make Rich Text
|
||||
- `[value]` *(string|nil)*: The initial text value. Default will be gui.get_text(text_node)
|
||||
|
||||
### on_layout_change
|
||||
|
||||
---
|
||||
```lua
|
||||
rich_text:on_layout_change()
|
||||
```
|
||||
|
||||
### on_style_change
|
||||
|
||||
---
|
||||
```lua
|
||||
rich_text:on_style_change(style)
|
||||
```
|
||||
|
||||
- **Parameters:**
|
||||
- `style` *(druid.rich_text.style)*:
|
||||
|
||||
### set_text
|
||||
|
||||
---
|
||||
```lua
|
||||
rich_text:set_text([text])
|
||||
```
|
||||
|
||||
Set text for Rich Text
|
||||
|
||||
- **Parameters:**
|
||||
- `[text]` *(string|nil)*: The text to set
|
||||
|
||||
- **Returns:**
|
||||
- `words` *(druid.rich_text.word[])*:
|
||||
- `line_metrics` *(druid.rich_text.lines_metrics)*:
|
||||
|
||||
- **Example Usage:**
|
||||
|
||||
```lua
|
||||
rich_text:set_text("＜color=red＞Foobar＜/color＞")
|
||||
rich_text:set_text("＜color=1.0,0,0,1.0＞Foobar＜/color＞")
|
||||
rich_text:set_text("＜color=#ff0000＞Foobar＜/color＞")
|
||||
rich_text:set_text("＜color=#ff0000ff＞Foobar＜/color＞")
|
||||
rich_text:set_text("＜shadow=red＞Foobar＜/shadow＞")
|
||||
rich_text:set_text("＜shadow=1.0,0,0,1.0＞Foobar＜/shadow＞")
|
||||
rich_text:set_text("＜shadow=#ff0000＞Foobar＜/shadow＞")
|
||||
rich_text:set_text("＜shadow=#ff0000ff＞Foobar＜/shadow＞")
|
||||
rich_text:set_text("＜outline=red＞Foobar＜/outline＞")
|
||||
rich_text:set_text("＜outline=1.0,0,0,1.0＞Foobar＜/outline＞")
|
||||
rich_text:set_text("＜outline=#ff0000＞Foobar＜/outline＞")
|
||||
rich_text:set_text("＜outline=#ff0000ff＞Foobar＜/outline＞")
|
||||
rich_text:set_text("＜font=MyCoolFont＞Foobar＜/font＞")
|
||||
rich_text:set_text("＜size=2＞Twice as large＜/size＞")
|
||||
rich_text:set_text("＜br/＞Insert a line break")
|
||||
rich_text:set_text("＜nobr＞Prevent the text from breaking")
|
||||
rich_text:set_text("＜img=texture:image＞Display image")
|
||||
rich_text:set_text("＜img=texture:image,size＞Display image with size")
|
||||
rich_text:set_text("＜img=texture:image,width,height＞Display image with width and height")
|
||||
```
|
||||
### get_text
|
||||
|
||||
---
|
||||
```lua
|
||||
rich_text:get_text()
|
||||
```
|
||||
|
||||
Get current text
|
||||
|
||||
- **Returns:**
|
||||
- `text` *(string)*:
|
||||
|
||||
### on_remove
|
||||
|
||||
---
|
||||
```lua
|
||||
rich_text:on_remove()
|
||||
```
|
||||
|
||||
### clear
|
||||
|
||||
---
|
||||
```lua
|
||||
rich_text:clear()
|
||||
```
|
||||
|
||||
Clear all created words.
|
||||
|
||||
### tagged
|
||||
|
||||
---
|
||||
```lua
|
||||
rich_text:tagged(tag)
|
||||
```
|
||||
|
||||
Get all words, which has a passed tag.
|
||||
|
||||
- **Parameters:**
|
||||
- `tag` *(string)*:
|
||||
|
||||
- **Returns:**
|
||||
- `words` *(druid.rich_text.word[])*:
|
||||
|
||||
### characters
|
||||
|
||||
---
|
||||
```lua
|
||||
rich_text:characters(word)
|
||||
```
|
||||
|
||||
Split a word into it's characters
|
||||
|
||||
- **Parameters:**
|
||||
- `word` *(druid.rich_text.word)*:
|
||||
|
||||
- **Returns:**
|
||||
- `characters` *(druid.rich_text.word[])*:
|
||||
|
||||
### get_words
|
||||
|
||||
---
|
||||
```lua
|
||||
rich_text:get_words()
|
||||
```
|
||||
|
||||
Get all current words.
|
||||
|
||||
- **Returns:**
|
||||
- `` *(druid.rich_text.word[])*:
|
||||
|
||||
### get_line_metric
|
||||
|
||||
---
|
||||
```lua
|
||||
rich_text:get_line_metric()
|
||||
```
|
||||
|
||||
Get current line metrics
|
||||
-@return druid.rich_text.lines_metrics
|
||||
|
||||
- **Returns:**
|
||||
- `` *(druid.rich_text.lines_metrics)*:
|
||||
|
||||
|
||||
## Fields
|
||||
<a name="root"></a>
|
||||
- **root** (_node_)
|
||||
|
||||
<a name="text_prefab"></a>
|
||||
- **text_prefab** (_node_)
|
||||
|
||||
<a name="style"></a>
|
||||
- **style** (_table_)
|
||||
|
||||
Reference in New Issue
Block a user