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:
@@ -0,0 +1,20 @@
|
||||
## getOffset
|
||||
|
||||
### Description
|
||||
|
||||
Returns the current offset
|
||||
|
||||
### Returns
|
||||
|
||||
1. `x` the x coordinate
|
||||
2. `y` the y coordinate
|
||||
|
||||
### Usage
|
||||
|
||||
* Returns the offset coordinates
|
||||
|
||||
```lua
|
||||
local myFrame = basalt.createFrame():setOffset(5, 3)
|
||||
|
||||
basalt.debug(myFrame:getOffset())
|
||||
```
|
||||
|
||||
@@ -1,25 +1,36 @@
|
||||
## setOffset
|
||||
|
||||
### Description
|
||||
|
||||
Sets the frame's coordinate offset. The frame's child objects will receive the frame's coordinate offset. For example, when using a scrollbar, if you use its value to add an offset to a frame, you will get a scrollable frame.
|
||||
Objects are also able to ignore the offset by using :ignoreOffset() (For example, you may want to ignore the offset on the scrollbar itself)
|
||||
Objects are also able to ignore the offset by using ':ignoreOffset()' (For example, you may want to ignore the offset on the scrollbar itself).
|
||||
|
||||
The function can also be supplied with negative values
|
||||
The function can also be supplied with negative values.
|
||||
|
||||
### Parameters
|
||||
|
||||
#### Parameters:
|
||||
1. `number` The x direction offset (+/-)
|
||||
|
||||
2. `number` The y direction offset (+/-)
|
||||
|
||||
#### Returns:
|
||||
### Returns
|
||||
|
||||
1. `frame` The frame being used
|
||||
|
||||
#### Usage:
|
||||
### Usage
|
||||
|
||||
* Creates a new base frame with x offset of 5 and a y offset of 3
|
||||
|
||||
```lua
|
||||
local myFrame = basalt.createFrame():setOffset(5, 3)
|
||||
```
|
||||
* Creates with x offset of 5 and a y offset of -5 (Meaning if you added a button with y position 5, it would be at y position 0)
|
||||
|
||||
* Creates a base frame with x offset of 5 and a y offset of -5 (Meaning if you added a button with y position 5, it would be at y position 0)
|
||||
|
||||
```lua
|
||||
local myFrame = basalt.createFrame():setOffset(5, -5)
|
||||
```
|
||||
|
||||
```xml
|
||||
<frame xOffset="5" yOffset="-5"></frame>
|
||||
```
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user