92 lines
2.1 KiB
Markdown
92 lines
2.1 KiB
Markdown
With input's you are able to create a object where the user can type something in.<br>
|
|
|
|
Here are all possible functions available for inputs:<br>
|
|
Remember Input inherits from [Object](objects/Object.md)
|
|
|
|
## setInputType
|
|
Changes the input type. default: text
|
|
|
|
#### Parameters:
|
|
1. `string` input type ("text", "password", "number")
|
|
|
|
#### Returns:
|
|
1. `object` The object in use
|
|
|
|
#### 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" />
|
|
```
|
|
|
|
## getInputType
|
|
Gets the current input type
|
|
|
|
#### Returns:
|
|
1. `string` input type
|
|
|
|
#### 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())
|
|
```
|
|
|
|
## 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
|
|
|
|
#### Returns:
|
|
1. `object` The object in use
|
|
|
|
#### Usage:
|
|
* Creates a default input and sets the default text to "...".
|
|
```lua
|
|
local mainFrame = basalt.createFrame()
|
|
local aInput = mainFrame:addInput():setDefaultText("...")
|
|
```
|
|
```xml
|
|
<input default="..." />
|
|
```
|
|
|
|
## setInputLimit
|
|
Sets a character limit to the input.
|
|
|
|
#### Parameters:
|
|
1. `number` character limit
|
|
|
|
#### Returns:
|
|
1. `object` The object in use
|
|
|
|
#### 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" />
|
|
```
|
|
|
|
## getInputLimit
|
|
Returns the input limit.
|
|
|
|
#### Returns:
|
|
1. `number` character limit
|
|
|
|
#### 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)
|
|
basalt.debug(aInput:getInputLimit())
|
|
```
|