PulseStudio/VoxelEngine
PulseStudio/VoxelEngine
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

fix

Browse Source
This commit is contained in:
MihailRis 2024-12-06 20:01:26 +03:00
parent 65f208fc61
commit 98de0d45ef
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
doc/en/scripting/ui.md
View File

@ -32,7 +32,7 @@ document["worlds-panel"]:clear()
Properties that apply to all elements: Properties that apply to all elements:
| Title | Type | Read | Write | Description | | Name | Type | Read | Write | Description |
| ------------- | ------ | ---- | ----- | ------------------------------------------- | | ------------- | ------ | ---- | ----- | ------------------------------------------- |
| id | string | yes | *no* | element id | | id | string | yes | *no* | element id |
| pos | vec2 | yes | yes | element position inside a container | | pos | vec2 | yes | yes | element position inside a container |
@ -60,17 +60,17 @@ Common element methods:
Common methods for containers (elements: container, panel, button, pagebox): Common methods for containers (elements: container, panel, button, pagebox):
| Method | Description | | Method | Description |
| ------------------------------- | ------------------------------------------------------------------ | | ------------------------------- | -------------------------------------------------------------------------------------------- |
| clear() | clears content | | clear() | clears content |
| add(xml) | adds an element, creating it using xml code. Example: `container:add("<image src='test'/>")` | | add(xml) | adds an element, creating it using xml code. Example: `container:add("<image src='test'/>")` |
| setInterval(interval, callback) | assigns a function to be executed repeatedly at an interval specified in milliseconds | | setInterval(interval, callback) | assigns a function to be executed repeatedly at an interval specified in milliseconds |
## Textbox ## Textbox
Properties: Properties:
| Title | Type | Read | Write | Description | | Name | Type | Read | Write | Description |
| ----------- | ------ | ---- | ----- | ------------------------------------------------------------------------------------ | | ----------- | ------ | ---- | ----- | ------------------------------------------------------------------------------------ |
| text | string | yes | yes | entered text or placeholder | | text | string | yes | yes | entered text or placeholder |
| placeholder | string | yes | yes | placeholder (used if nothing has been entered) | | placeholder | string | yes | yes | placeholder (used if nothing has been entered) |
@ -97,7 +97,7 @@ Methods:
Properties: Properties:
| Title | Type | Read | Write | Description | | Name | Type | Read | Write | Description |
| ---------- | ----- | ---- | ----- | --------------------- | | ---------- | ----- | ---- | ----- | --------------------- |
| value | float | yes | yes | current value | | value | float | yes | yes | current value |
| min | float | yes | yes | minimum value | | min | float | yes | yes | minimum value |
@ -110,7 +110,7 @@ Properties:
Properties: Properties:
| Title | Type | Read | Write | Description | | Name | Type | Read | Write | Description |
| ----- | ------ | ---- | ----- | ------------ | | ----- | ------ | ---- | ----- | ------------ |
| page | string | yes | yes | current page | | page | string | yes | yes | current page |
@ -125,7 +125,7 @@ Methods:
Properties: Properties:
| Title | Type | Read | Write | Description | | Name | Type | Read | Write | Description |
| ------- | ---- | ---- | ----- | ----------- | | ------- | ---- | ---- | ----- | ----------- |
| checked | bool | yes | yes | mark status | | checked | bool | yes | yes | mark status |
@ -133,7 +133,7 @@ Properties:
Properties: Properties:
| Title | Type | Read | Write | Description | | Name | Type | Read | Write | Description |
| ----- | ------ | ---- | ----- | ------------ | | ----- | ------ | ---- | ----- | ------------ |
| text | string | yes | yes | button text | | text | string | yes | yes | button text |
@ -141,7 +141,7 @@ Properties:
Properties: Properties:
| Title | Type | Read | Write | Description | | Name | Type | Read | Write | Description |
| ------ | ------ | ---- | ----- | -------------------------------------- | | ------ | ------ | ---- | ----- | -------------------------------------- |
| text | string | yes | yes | label text | | text | string | yes | yes | label text |
| markup | string | yes | yes | text markup language ("md" - Markdown) | | markup | string | yes | yes | text markup language ("md" - Markdown) |
@ -150,7 +150,7 @@ Properties:
Properties: Properties:
| Title | Type | Read | Write | Description | | Name | Type | Read | Write | Description |
| ----- | ------ | ---- | ----- | ------------ | | ----- | ------ | ---- | ----- | ------------ |
| src | string | yes | yes | texture name | | src | string | yes | yes | texture name |
@ -158,6 +158,6 @@ Properties:
Properties: Properties:
| Title | Type | Read | Write | Description | | Name | Type | Read | Write | Description |
| --------- | ---- | ---- | ----- | ------------------------------------------------- | | --------- | ---- | ---- | ----- | ------------------------------------------------- |
| inventory | int | yes | yes | id of the inventory to which the element is bound | | inventory | int | yes | yes | id of the inventory to which the element is bound |