Files
Basalt/docs/objects/Image/getOffset.md
Robert Jelic bb1b1beb79 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
2023-04-30 17:05:34 +02:00

24 lines
651 B
Markdown

## getOffset
### Description
Gets the image's current coordinate offset. The offset values represent the distance the image has been moved relative to its original position.
### Returns
1. `number` offsetX - The x direction offset (+/-)
2. `number` offsetY - The y direction offset (+/-)
### Usage
* Creates a new image object, loads the image, sets an offset, and retrieves the current offset values.
```lua
local mainFrame = basalt.createFrame()
local aImage = mainFrame:addImage():loadImage("test.bimg"):setOffset(5, 3)
local offsetX, offsetY = aImage:getOffset()
basalt.debug("Offset X: ", offsetX)
basalt.debug("Offset Y: ", offsetY)
```