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

docs fix

Browse Source
This commit is contained in:
Robert Jelic
2025-09-13 12:54:15 +02:00
parent 3504d8a3aa 8e64ba97bf
commit 9e1112f3bd
42 changed files with 1582 additions and 2507 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
docs/references/elements/Frame.md
View File

@@ -1,63 +1,21 @@
# Frame
_This is the frame class. It serves as a grouping container for other elements._
Extends: `Container`
# Frame : Container
This is the frame class. It serves as a grouping container for other elements.
## Properties
|Property|Type|Default|Description|
|---|---|---|---|
|draggable|boolean|false|Whether the frame is draggable|
|draggingMap|table|{}|The map of dragging positions|
|draggable|boolean|false|Whether the frame is draggable
|draggingMap|table|{}|The map of dragging positions
## Functions
## Protected Functions
|Method|Returns|Description|
|---|---|---|
|[Frame.new](#frame-new)|Frame|Creates a new Frame instance|
|[Frame:Frame](#frame-frame-props-basalt)|Frame|Initializes the Frame instance|
|[Frame:Frame](#frame-frame-button-x-y)|boolean|Handles mouse click events|
|[Frame:Frame](#frame-frame-button-x-y)|boolean|Handles mouse release events|
|[Frame:Frame](#frame-frame-button-x-y)|boolean|Handles mouse drag events|
|Frame:init|Frame|Initializes the Frame instance
|Frame:mouse_click|boolean|Handles mouse click events
|Frame:mouse_drag|boolean|Handles mouse drag events
|Frame:mouse_up|boolean|Handles mouse release events
## Frame.new()
Creates a new Frame instance
### Returns
* `Frame` `self` The newly created Frame instance
## Frame:Frame(props, basalt)
### Parameters
* `props` `table` The properties to initialize the element with
* `basalt` `table` The basalt instance
### Returns
* `Frame` `self` The initialized instance
## Frame:Frame(button, x, y)
### Parameters
* `button` `number` The button that was clicked
* `x` `number` The x position of the click
* `y` `number` The y position of the click
### Returns
* `boolean` `handled` Whether the event was handled
## Frame:Frame(button, x, y)
### Parameters
* `button` `number` The button that was released
* `x` `number` The x position of the release
* `y` `number` The y position of the release
### Returns
* `boolean` `handled` Whether the event was handled
## Frame:Frame(button, x, y)
### Parameters
* `button` `number` The button that was clicked
* `x` `number` The x position of the drag position
* `y` `number` The y position of the drag position
### Returns
* `boolean` `handled` Whether the event was handled