GitHub/Basalt
1
0
Fork 0
Code Issues 28 Pull Requests 3 Actions Packages Projects Releases 9 Wiki Activity

updated param and return headers

Browse Source
This commit is contained in:
Samuel Pizette
2022-06-09 11:43:59 -04:00
parent 4b8f3c2d5c
commit b6ee09636b
14 changed files with 188 additions and 188 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
docs/objects/Dropdown.md
View File

@@ -20,8 +20,8 @@ aDropdown:addItem("1. Entry")
aDropdown:addItem("2. Entry",colors.yellow)
aDropdown:addItem("3. Entry",colors.yellow,colors.green)
```
**parameters:** string text, number bgcolor, number fgcolor, any ... - (text is the displayed text, bgcolor and fgcolors the colors of background/text and args (...) is something dynamic, you wont see them but if you require some more information per item you can use that)<br>
**returns:** self<br>
#### Parameters: string text, number bgcolor, number fgcolor, any ... - (text is the displayed text, bgcolor and fgcolors the colors of background/text and args (...) is something dynamic, you wont see them but if you require some more information per item you can use that)<br>
#### Returns: self<br>
## removeItem
Removes a item from the dropdown
@@ -34,8 +34,8 @@ aDropdown:addItem("2. Entry",colors.yellow)
aDropdown:addItem("3. Entry",colors.yellow,colors.green)
aDropdown:removeItem(2)
```
**parameters:** number index<br>
**returns:** self<br>
#### Parameters: number index<br>
#### Returns: self<br>
## editItem
Edits a item on the dropdown
@@ -48,8 +48,8 @@ aDropdown:addItem("2. Entry",colors.yellow)
aDropdown:addItem("3. Entry",colors.yellow,colors.green)
aDropdown:editItem(3,"3. Edited Entry",colors.yellow,colors.green)
```
**parameters:** number index, string text, number bgcolor, number fgcolor, any ...<br>
**returns:** self<br>
#### Parameters: number index, string text, number bgcolor, number fgcolor, any ...<br>
#### Returns: self<br>
## setScrollable
Makes the dropdown scrollable
@@ -62,8 +62,8 @@ aDropdown:addItem("2. Entry",colors.yellow)
aDropdown:addItem("3. Entry",colors.yellow,colors.green)
aDropdown:setScrollable(true)
```
**parameters:** boolean isScrollable<br>
**returns:** self<br>
#### Parameters: boolean isScrollable<br>
#### Returns: self<br>
## selectItem
selects a item in the dropdown (same as a player would click on a item)
@@ -76,8 +76,8 @@ aDropdown:addItem("2. Entry",colors.yellow)
aDropdown:addItem("3. Entry",colors.yellow,colors.green)
aDropdown:selectItem(1)
```
**parameters:** number index<br>
**returns:** self<br>
#### Parameters: number index<br>
#### Returns: self<br>
## clear
clears the entire list (dropdown)
@@ -90,8 +90,8 @@ aDropdown:addItem("2. Entry",colors.yellow)
aDropdown:addItem("3. Entry",colors.yellow,colors.green)
aDropdown:clear()
```
**parameters:** -<br>
**returns:** self<br>
#### Parameters: -<br>
#### Returns: self<br>
## getItemIndex
returns the item index of the currently selected item
@@ -104,8 +104,8 @@ aDropdown:addItem("2. Entry",colors.yellow)
aDropdown:addItem("3. Entry",colors.yellow,colors.green)
aDropdown:getItemIndex()
```
**parameters:** -<br>
**returns:** number index<br>
#### Parameters: -<br>
#### Returns: number index<br>
## setSelectedItem
Sets the background of the item which is currently selected
@@ -118,8 +118,8 @@ aDropdown:addItem("2. Entry",colors.yellow)
aDropdown:addItem("3. Entry",colors.yellow,colors.green)
aDropdown:setSelectedItem(colors.green, colors.blue)
```
**parameters:** number bgcolor, number fgcolor, boolean isActive (isActive means if different colors for selected item should be used)<br>
**returns:** self<br>
#### Parameters: number bgcolor, number fgcolor, boolean isActive (isActive means if different colors for selected item should be used)<br>
#### Returns: self<br>
## setOffset
sets the dropdown offset (will automatically change if scrolling is active)
@@ -132,8 +132,8 @@ aDropdown:addItem("2. Entry",colors.yellow)
aDropdown:addItem("3. Entry",colors.yellow,colors.green)
aDropdown:setOffset(3)
```
**parameters:** number offsetValue<br>
**returns:** self<br>
#### Parameters: number offsetValue<br>
#### Returns: self<br>
## getOffset
returns the current offset
@@ -146,8 +146,8 @@ aDropdown:addItem("2. Entry",colors.yellow)
aDropdown:addItem("3. Entry",colors.yellow,colors.green)
aDropdown:getOffset()
```
**parameters:** -<br>
**returns:** number offsetValue<br>
#### Parameters: -<br>
#### Returns: number offsetValue<br>
## getOffset
returns the current offset
@@ -160,8 +160,8 @@ aDropdown:addItem("2. Entry",colors.yellow)
aDropdown:addItem("3. Entry",colors.yellow,colors.green)
aDropdown:getOffset()
```
**parameters:** -<br>
**returns:** number offsetValue<br>
#### Parameters: -<br>
#### Returns: number offsetValue<br>
## setDropdownSize
sets the dropdown size (if you click on the button)
@@ -174,5 +174,5 @@ aDropdown:addItem("2. Entry",colors.yellow)
aDropdown:addItem("3. Entry",colors.yellow,colors.green)
aDropdown:setDropdownSize(12, 4)
```
**parameters:** number width, number height<br>
**returns:** self<br>
#### Parameters: number width, number height<br>
#### Returns: self<br>