Basalt 1.7 Update
- New Objects (Flexbox, Graph, Treeview) - Pluginsystem to add/remove functionality - Reworked the entire Object system, instead of one big Object Class we have multiple classes: Object, VisualObject, ChangeableObject - Instead of one big Frame Class we have multiple Frame Classes: BaseFrame, Frame, MovableFrame, ScrollableFrame, MonitorFrame, Flexbox - Removed the Animation Object, and added a animation plugin instead - Removed the Graphic Object and merged it's functionality with the image object - Updated currently existing objects
This commit is contained in:
@@ -1,11 +1,17 @@
|
||||
## getInputLimit
|
||||
Returns the input limit.
|
||||
|
||||
#### Returns:
|
||||
### Description
|
||||
|
||||
Returns the character limit set for the Input object.
|
||||
|
||||
### Returns
|
||||
|
||||
1. `number` character limit
|
||||
|
||||
#### Usage:
|
||||
### Usage
|
||||
|
||||
* Creates a default input and sets the character limit to 8. Prints the current limit.
|
||||
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame()
|
||||
local aInput = mainFrame:addInput():setInputLimit(8)
|
||||
|
||||
@@ -1,13 +1,19 @@
|
||||
## getInputType
|
||||
Gets the current input type
|
||||
|
||||
#### Returns:
|
||||
1. `string` input type
|
||||
### Description
|
||||
|
||||
Gets the current input type of the Input object.
|
||||
|
||||
### Returns
|
||||
|
||||
1. `string` inputType - The current input type.
|
||||
|
||||
### Usage
|
||||
|
||||
* Creates a default input, sets it to accept numbers only, and prints the current input type to the log.
|
||||
|
||||
#### Usage:
|
||||
* Creates a default input and sets it to numbers only. Also prints the current input type to log.
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame()
|
||||
local aInput = mainFrame:addInput():setInputType("number")
|
||||
basalt.debug(aInput:getInputType())
|
||||
```
|
||||
```
|
||||
|
||||
@@ -1,20 +1,28 @@
|
||||
## setDefaultText
|
||||
Sets the default text. This will only be displayed if there is no input set by the user.
|
||||
|
||||
#### Parameters:
|
||||
1. `string` input type ("text", "password", "number")
|
||||
2. `number|color` default background color - optional
|
||||
3. `number|color` default text color - optional
|
||||
### Description
|
||||
|
||||
Sets the default text for the Input object. This will only be displayed if there is no input set by the user.
|
||||
|
||||
### Parameters
|
||||
|
||||
1. `string` default text
|
||||
2. `number` default background color (optional)
|
||||
3. `number` default text color (optional)
|
||||
|
||||
### Returns
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Creates a default input and sets the default text to "...".
|
||||
### Usage
|
||||
|
||||
* Creates a default input and sets the default text to "..." with optional background and text colors.
|
||||
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame()
|
||||
local aInput = mainFrame:addInput():setDefaultText("...")
|
||||
local aInput = mainFrame:addInput():setDefaultText("...", colors.gray, colors.lightGray)
|
||||
```
|
||||
|
||||
```xml
|
||||
<input default="..." />
|
||||
```
|
||||
<input default="..." defaultBgColor="gray" defaultTextColor="lightGray" />
|
||||
```
|
||||
|
||||
@@ -1,18 +1,26 @@
|
||||
## setInputLimit
|
||||
Sets a character limit to the input.
|
||||
|
||||
#### Parameters:
|
||||
1. `number` character limit
|
||||
### Description
|
||||
|
||||
Sets a character limit for the Input object, restricting the number of characters that can be entered.
|
||||
|
||||
### Parameters
|
||||
|
||||
1. `number` characterLimit - The maximum number of characters allowed.
|
||||
|
||||
### Returns
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
### Usage
|
||||
|
||||
* Creates a default input and sets the character limit to 8.
|
||||
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame()
|
||||
local aInput = mainFrame:addInput():setInputLimit(8)
|
||||
```
|
||||
|
||||
```xml
|
||||
<input limit="8" />
|
||||
```
|
||||
```
|
||||
|
||||
@@ -1,18 +1,26 @@
|
||||
## setInputType
|
||||
Changes the input type. default: text
|
||||
|
||||
#### Parameters:
|
||||
1. `string` input type ("text", "password", "number")
|
||||
### Description
|
||||
|
||||
Changes the input type of the Input object. The default input type is "text".
|
||||
|
||||
### Parameters
|
||||
|
||||
1. `string` inputType - The input type to set. Accepted values are "text", "password", and "number".
|
||||
|
||||
### Returns
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
### Usage
|
||||
|
||||
* Creates a default input and sets it to numbers only.
|
||||
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame()
|
||||
local aInput = mainFrame:addInput():setInputType("number")
|
||||
```
|
||||
|
||||
```xml
|
||||
<input type="number" />
|
||||
```
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user