updated Object.md to new format
This commit is contained in:
Samuel Pizette
@@ -1,247 +1,433 @@
|
||||
This is the base class of all visual objects. This means, if you create a button, label, frame or something else visual (no timers, threads or animations) the following list can be used:
|
||||
This is the base class of all visual objects. This means, if you create a button, label, frame or something else visual (no timers, threads or animations) the following methods apply:
|
||||
|
||||
## show
|
||||
shows the object (only if the parent frame is already visible)
|
||||
Shows the object (only if the parent frame is already visible)
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Shows a frame named "myFirstFrame"
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame("myFirstFrame"):show()
|
||||
local button = mainFrame:addButton("myFirstButton")
|
||||
button:show()
|
||||
```
|
||||
#### Parameters: -<br>
|
||||
#### Returns: self<br>
|
||||
|
||||
## hide
|
||||
hides the object
|
||||
Hides the object
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Hides a frame named "myFirstFrame"
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame("myFirstFrame"):show()
|
||||
local button = mainFrame:addButton("myFirstButton"):setText("Close"):onClick(function() mainFrame:hide() end)
|
||||
button:show()
|
||||
```
|
||||
#### Parameters: -<br>
|
||||
#### Returns: self<br>
|
||||
|
||||
## setPosition
|
||||
Changes the position relative to its parent frame
|
||||
#### Parameters:
|
||||
1. `number` x coordinate
|
||||
2. `number` y coordinate
|
||||
3. `boolean` Whether it will add/remove to the current coordinates instead of setting them
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Sets the frame's position to an x coordinate of 2 with a y coordinate of 3
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame("myFirstFrame"):setPosition(2,3)
|
||||
```
|
||||
#### Parameters: number x, number y[, boolean relative], if relative is set to true it will add/remove instead of set x, y<br>
|
||||
#### Returns: self<br>
|
||||
|
||||
|
||||
|
||||
## setBackground
|
||||
Changes the object background color
|
||||
#### Parameters:
|
||||
1. `number|color` Background color
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Creates a frame, and sets its background color to `colors.lightGray`
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame("myFirstFrame"):setBackground(colors.lightGray)
|
||||
```
|
||||
#### Parameters: number color<br>
|
||||
#### Returns: self<br>
|
||||
|
||||
## setForeground
|
||||
Changes the object text color
|
||||
#### Parameters:
|
||||
1. `number|color` Foreground color
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Creates a frame, and sets its foreground color to `colors.black`
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame("myFirstFrame"):setForeground(colors.black)
|
||||
```
|
||||
#### Parameters: number color<br>
|
||||
#### Returns: self<br>
|
||||
|
||||
## setSize
|
||||
Changes the object size
|
||||
#### Parameters:
|
||||
1. `number` width
|
||||
2. `number` height
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Sets the frame to have a width of 15 and a height of 5
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame("myFirstFrame"):setSize(15,5)
|
||||
```
|
||||
#### Parameters: number width, number length<br>
|
||||
#### Returns: self<br>
|
||||
|
||||
## setFocus
|
||||
sets the object to be the focused object.
|
||||
If you click on a object, it's normaly automatically the focused object. As example, if you :show() a frame and you want this particular frame to be in
|
||||
the foreground, you have to use :setFocus()
|
||||
Sets the object to be the focused object.
|
||||
If you click on an object, it's normally automatically the focused object. For example, if you call :show() on a frame, and you want this particular frame to be in
|
||||
the foreground, you should use :setFocus()
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Sets the button to the focused object
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame("myFirstFrame"):show()
|
||||
local aButton = mainFrame:addButton("myFirstButton"):setFocus():show()
|
||||
```
|
||||
#### Parameters: -<br>
|
||||
#### Returns: self<br>
|
||||
|
||||
## setZIndex
|
||||
changes the z index (higher z index do have higher draw/event priority) 10 is more important than 5 or 1. You are also able to add multiple objects to the same z index, which means if you create a couple of buttons, you set their z index to 10, everything below 10 is less important, everything above 10 is more important. On the same z index: the last object which gets created is the most important one.
|
||||
Sets the z index where a higher z index has higher draw/event priority, with higher values higher priority. You are also able to add multiple objects to the same z index. On the same z index: the last created object has the highest priority.
|
||||
#### Parameters:
|
||||
1. `number` z-index
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Sets the z-index of "myFirstButton" to `1`
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame("myFirstFrame"):show()
|
||||
local aButton = mainFrame:addButton("myFirstButton"):setZIndex(1):show()
|
||||
```
|
||||
#### Parameters: number index<br>
|
||||
#### Returns: self<br>
|
||||
|
||||
## setParent
|
||||
changes the frame parent of that object
|
||||
Sets the parent frame of the object
|
||||
#### Parameters:
|
||||
1. `frame` The to-be parent frame
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Sets the parent frame of the random frame, adding it to the main frame when the button is clicked"
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame("myFirstFrame"):show()
|
||||
local aRandomFrame = basalt.createFrame("aRandomFrame"):show()
|
||||
local aButton = mainFrame:addButton("myFirstButton"):onClick(function() aRandomFrame:setParent(mainFrame) end):show()
|
||||
local aButton = mainFrame:addButton("myFirstButton"):onClick(
|
||||
function()
|
||||
aRandomFrame:setParent(mainFrame)
|
||||
end
|
||||
):show()
|
||||
```
|
||||
#### Parameters: frame object<br>
|
||||
#### Returns: self<br>
|
||||
|
||||
## isFocused
|
||||
returns if the object is currently the focused object of the parent frame
|
||||
Returns if the object is currently the focused object of the parent frame
|
||||
|
||||
#### Returns:
|
||||
1. `boolean` Whether the object is focused
|
||||
|
||||
#### Usage:
|
||||
* Prints whether the button is focused to the debug console
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame("myFirstFrame"):show()
|
||||
local aButton = mainFrame:addButton("myFirstButton"):show()
|
||||
basalt.debug(aButton:isFocused()) -- shows true or false as a debug message
|
||||
```
|
||||
#### Parameters: -<br>
|
||||
#### Returns: boolean<br>
|
||||
|
||||
## getAnchorPosition
|
||||
converts the x,y coordinates into the anchor coordinates of that object
|
||||
Converts the x and y coordinates into the anchor coordinates of the object
|
||||
|
||||
#### Parameters:
|
||||
1. `number|nil` x
|
||||
2. `number|nil` y, if nothing it uses the object's x, y
|
||||
|
||||
#### Returns:
|
||||
1. `number` x
|
||||
2. `number` y
|
||||
|
||||
#### Usage:
|
||||
* Prints the anchor position to the debug console
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame("myFirstFrame"):setSize(15,15):show()
|
||||
local aButton = mainFrame:addButton("myFirstButton"):setAnchor("right","bottom"):setSize(8,1):setPosition(1,1):show()
|
||||
local aButton = mainFrame:addButton("myFirstButton")
|
||||
:setAnchor("right","bottom")
|
||||
:setSize(8,1)
|
||||
:setPosition(1,1)
|
||||
:show()
|
||||
basalt.debug(aButton:getAnchorPosition()) -- returns 7,14 (framesize - own size) instead of 1,1
|
||||
```
|
||||
#### Parameters: number x, number y - or nothing (if nothing it uses the object's x, y)<br>
|
||||
#### Returns: number x, number y (converted)<br>
|
||||
|
||||
## setAnchor
|
||||
sets the anchor of that object
|
||||
Sets the anchor of the object
|
||||
|
||||
#### Parameters:
|
||||
1. `string` Anchor sides `("left", "right", "top", "bottom")` Positions stack like so `object:setAnchor("right", "bottom")`
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Sets the mainFrame to have an anchor of `right` and aButton to have an anchor of `bottom, right`
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame("myFirstFrame"):setAnchor("right"):show()
|
||||
local aButton = mainFrame:addButton("myFirstButton"):setAnchor("bottom","right"):setSize(8,1):setPosition(1,1):show()
|
||||
local mainFrame = basalt.createFrame("myFirstFrame")
|
||||
:setAnchor("right")
|
||||
:show()
|
||||
local aButton = mainFrame:addButton("myFirstButton")
|
||||
:setAnchor("bottom","right")
|
||||
:setSize(8,1)
|
||||
:setPosition(1,1)
|
||||
:show()
|
||||
```
|
||||
#### Parameters: string sides - ("left", "right", "top", "bottom") you can stack positions like so ..:setAnchor("right", "bottom")<br>
|
||||
#### Returns: self<br>
|
||||
|
||||
## getAbsolutePosition
|
||||
converts the relative coordinates into absolute coordinates
|
||||
Converts the relative coordinates into absolute coordinates
|
||||
#### Parameters:
|
||||
1. `number|nil` x
|
||||
2. `number|nil` y
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Creates a frame and a button and prints the button's absolute position to the debug console
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame("myFirstFrame"):setPosition(3,3):show()
|
||||
local aButton = mainFrame:addButton("myFirstButton"):setSize(8,1):setPosition(4,2):show()
|
||||
basalt.debug(aButton:getAbsolutePosition()) -- returns 7,5 (frame coords + own coords) instead of 4,2
|
||||
```
|
||||
#### Parameters: number x, number y - or nothing (if nothing it uses the object's x, y)<br>
|
||||
#### Returns: self<br>
|
||||
|
||||
## setTextAlign
|
||||
sets the text align of the object (for example buttons)
|
||||
Sets the text align of the object (for example buttons)
|
||||
#### Parameters:
|
||||
1. `string` horizontal
|
||||
2. `string` vertical ("left", "center", "right")
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Creates a button with text aligned to `right, center`
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame("myFirstFrame"):show()
|
||||
local aButton = mainFrame:addButton("myFirstButton"):setSize(12,3):setTextAlign("right", "center"):setText("Dont't..."):show()
|
||||
local aButton = mainFrame:addButton("myFirstButton")
|
||||
:setSize(12,3)
|
||||
:setTextAlign("right", "center")
|
||||
:setText("Don't...")
|
||||
:show()
|
||||
```
|
||||
#### Parameters: string horizontal, string vertical - ("left", "center", "right")<br>
|
||||
#### Returns: self<br>
|
||||
|
||||
## setValue
|
||||
sets the value of that object (input, label, checkbox, textfield, scrollbar,...)
|
||||
Sets the value of that object (input, label, checkbox, textfield, scrollbar,...)
|
||||
#### Parameters:
|
||||
1. `any` Value to set the object to
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Creates a checkbox and ticks it
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame("myFirstFrame"):show()
|
||||
local aCheckbox = mainFrame:addCheckbox("myFirstCheckbox"):setValue(true):show()
|
||||
```
|
||||
#### Parameters: any value<br>
|
||||
#### Returns: self<br>
|
||||
|
||||
## getValue
|
||||
returns the currently saved value
|
||||
Returns the currently saved value
|
||||
#### Returns:
|
||||
1. `any` Object's value
|
||||
|
||||
#### Usage:
|
||||
* Prints the value of the checkbox to the debug console
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame("myFirstFrame"):show()
|
||||
local aCheckbox = mainFrame:addCheckbox("myFirstCheckbox"):setValue(true):show()
|
||||
basalt.debug(aCheckbox:getValue()) -- returns true
|
||||
```
|
||||
#### Parameters:-<br>
|
||||
#### Returns: any value<br>
|
||||
|
||||
## getHeight/getWidth
|
||||
returns the height or width
|
||||
Returns the respective height/width of the object
|
||||
#### Returns:
|
||||
1. `number` height/width
|
||||
|
||||
#### Usage:
|
||||
* Prints the height of the object to the debug console
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame("myFirstFrame"):show()
|
||||
local aButton = mainFrame:addButton("myFirstButton"):setSize(5,8):show()
|
||||
basalt.debug(aButton:getHeight()) -- returns 8
|
||||
```
|
||||
#### Parameters:-<br>
|
||||
#### Returns: number height/width<br>
|
||||
|
||||
## isVisible
|
||||
returns if the object is currently visible
|
||||
Returns if the object is currently visible
|
||||
#### Returns:
|
||||
1. `boolean`
|
||||
|
||||
#### Usage:
|
||||
* Prints boolean visibility of object to debug console
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame("myFirstFrame"):show()
|
||||
local aButton = mainFrame:addButton("myFirstButton"):setSize(5,8):show()
|
||||
basalt.debug(aButton:isVisible()) -- returns true
|
||||
```
|
||||
#### Parameters:-<br>
|
||||
#### Returns: boolean<br>
|
||||
|
||||
## getName
|
||||
returns the given name of that object
|
||||
Returns the given name of the object
|
||||
|
||||
#### Returns:
|
||||
1. `string` name
|
||||
|
||||
#### Usage:
|
||||
* Prints name of object to debug window
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame("myFirstFrame"):show()
|
||||
basalt.debug(mainFrame:getName()) -- returns myFirstFrame
|
||||
```
|
||||
#### Parameters:-<br>
|
||||
#### Returns: string name<br>
|
||||
|
||||
# Object Events
|
||||
These object events are available for all objects, if a object got some unique events, you can see them in their own category
|
||||
These events are available for all objects, objects with unique events will have documentation in their respective sections
|
||||
|
||||
## onClick
|
||||
creates a mouse_click event
|
||||
Creates a mouse_click event listener
|
||||
#### Parameters:
|
||||
1. `function` Function handling event listener logic
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Prints to the debug console when the button is clicked
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame("myFirstFrame"):show()
|
||||
local aButton = mainFrame:addButton("myFirstButton"):setSize(10,3):onClick(function(self,event,button,x,y) basalt.debug("Hellooww UwU") end):show()
|
||||
local aButton = mainFrame:addButton("myFirstButton"):setSize(10,3):onClick(
|
||||
function(self,event,button,x,y)
|
||||
basalt.debug("Hellooww UwU")
|
||||
end
|
||||
):show()
|
||||
```
|
||||
#### Parameters: function func<br>
|
||||
#### Returns: self<br>
|
||||
|
||||
## onClickUp
|
||||
creates a click_up event
|
||||
Creates a click_up event listener
|
||||
#### Parameters:
|
||||
1. `function` Function handling event listener logic
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Prints to the debug console when there is a click_up event
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame("myFirstFrame"):show()
|
||||
local aButton = mainFrame:addButton("myFirstButton"):setSize(10,3):onClickUp(function(self,event,button,x,y) basalt.debug("Byeeeee UwU") end):show()
|
||||
local aButton = mainFrame:addButton("myFirstButton"):setSize(10,3):onClickUp(
|
||||
function(self,event,button,x,y)
|
||||
basalt.debug("Byeeeee UwU")
|
||||
end
|
||||
):show()
|
||||
```
|
||||
#### Parameters: function func<br>
|
||||
#### Returns: self<br>
|
||||
|
||||
## onMouseDrag
|
||||
creates a mouse_drag event
|
||||
### _Not currently implemented_
|
||||
Creates a mouse_drag event listener
|
||||
#### Parameters:
|
||||
1. `function` Function handling event listener logic
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Prints to the debug console when the object is dragged
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame("myFirstFrame"):show()
|
||||
local aButton = mainFrame:addButton("myFirstButton"):setSize(10,3):onClickUp(function(self,event,button,x,y) basalt.debug("Byeeeee UwU") end):show()
|
||||
local aButton = mainFrame:addButton("myFirstButton"):setSize(10,3):onClickUp(
|
||||
function(self,event,button,x,y)
|
||||
basalt.debug("Byeeeee UwU")
|
||||
end
|
||||
):show()
|
||||
```
|
||||
#### Parameters: function func<br>
|
||||
#### Returns: self<br>
|
||||
|
||||
## onChange
|
||||
creates a change event (fires as soon as the value gets changed)
|
||||
Creates an on change event listener (called when the value gets changed)
|
||||
#### Parameters:
|
||||
1. `function` Function handling event listener logic
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Prints the checkbox value to the debug window when changed
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame("myFirstFrame"):show()
|
||||
local aCheckbox = mainFrame:addCheckbox("myFirstCheckbox"):onChange(function(self) basalt.debug("i got changed into "..self:getValue()) end):show()
|
||||
local aCheckbox = mainFrame:addCheckbox("myFirstCheckbox"):onChange(
|
||||
function(self)
|
||||
basalt.debug("I got changed into " .. self:getValue())
|
||||
end
|
||||
):show()
|
||||
```
|
||||
#### Parameters: function func<br>
|
||||
#### Returns: self<br>
|
||||
|
||||
## onKey
|
||||
creates a key(board) - event can be key or char
|
||||
Creates a keyboard event listener that can be key or character based
|
||||
#### Parameters:
|
||||
1. `function` Function handling event listener logic
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Prints the clicked key to the debug window
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame("myFirstFrame"):onKey(function(self,event,key) basalt.debug("you clicked "..key) end):show()
|
||||
local mainFrame = basalt.createFrame("myFirstFrame"):onKey(
|
||||
function(self,event,key)
|
||||
basalt.debug("You clicked " .. key)
|
||||
end
|
||||
):show()
|
||||
```
|
||||
#### Parameters: function func<br>
|
||||
#### Returns: self<br>
|
||||
|
||||
## onLoseFocus
|
||||
creates a lose focus event
|
||||
Creates a lose focus event listener
|
||||
#### Parameters:
|
||||
1. `function` Function handling event listener logic
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Prints "Please come back... :(" to the debug window when the frame loses focus
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame("myFirstFrame"):onLoseFocus(function(self) basalt.debug("please come back..") end):show()
|
||||
local mainFrame = basalt.createFrame("myFirstFrame"):onLoseFocus(
|
||||
function(self)
|
||||
basalt.debug("Please come back... :(")
|
||||
end
|
||||
):show()
|
||||
```
|
||||
#### Parameters: function func<br>
|
||||
#### Returns: self<br>
|
||||
|
||||
## onGetFocus
|
||||
creates a get focus event
|
||||
Creates a get focus event listener
|
||||
#### Parameters:
|
||||
1. `function` Function handling event listener logic
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Prints "Thanks!" to the debug window when "myFirstFrame" is focused
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame("myFirstFrame"):onGetFocus(function(self) basalt.debug("thanks!") end):show()
|
||||
```
|
||||
#### Parameters: function func<br>
|
||||
#### Returns: self<br>
|
||||
local mainFrame = basalt.createFrame("myFirstFrame"):onGetFocus(
|
||||
function(self)
|
||||
basalt.debug("Thanks!")
|
||||
end
|
||||
):show()
|
||||
```
|
||||
Reference in New Issue
Block a user