Files
Basalt/docs/objects/Image/getFrameObject.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
656 B
Markdown

## getFrameObject
### Description
Retrieves a frame object from the image object at the specified index. This method works with bimg format images and can be used to access and manipulate individual frames.
### Parameters
1. `number` index - The index of the frame to retrieve.
### Returns
1. `object` The frame object at the specified index, with methods to interact and modify the frame.
### Usage
* Creates a new image object, loads a bimg image, and retrieves the frame object at index 2.
```lua
local mainFrame = basalt.createFrame()
local aImage = mainFrame:addImage():loadImage("test.bimg")
local frameObject = aImage:getFrameObject(2)
```