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

deploy: fc44bc4d8b

Browse Source
This commit is contained in:
NoryiE
2025-09-13 20:28:52 +00:00
parent 9e1112f3bd
commit 4ccefcac9f
48 changed files with 3036 additions and 1565 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
docs/references/elements/Display.md
View File

@@ -1,36 +1,36 @@
# Display : VisualElement
The Display is a special element where you can use the window (term) API to draw on the display, useful when you need to use external APIs.
### Usage
```lua
local display = main:addDisplay() -- Create a display element
local displayWindow = display:getWindow() -- Get the window object of the display
displayWindow.write("Hello World!") -- Write "Hello World!" to the display
```
# Display
_The Display is a special element where you can use the window (term) API to draw on the display, useful when you need to use external APIs._
Extends: `VisualElement`
## Functions
|Method|Returns|Description|
|---|---|---|
|[Display:getWindow](#display-getwindow)|table|Returns the current window object
|[Display:write](#display-write)|Display|Writes text to the display
|[Display.new](#display-new)|table|Creates a new Display instance|
|[Display:init](#display-init-props-basalt)|-|Initializes the Display instance|
|[Display:getWindow](#display-getwindow)|table|Returns the current window object|
|[Display:write](#display-write-x-y-text-fg-bg)|Display|Writes text to the display|
|[Display:render](#display-render)|-|Renders the Display|
## Display.new()
### Returns
* `table` `self` The created instance
## Protected Functions
|Method|Returns|Description|
|---|---|---|
|Display:init|-|Initializes the Display instance
|Display:render|-|Renders the Display
## Display:init(props, basalt)
### Parameters
* `props` `table` The properties to initialize the element with
* `basalt` `table` The basalt instance
## Display:getWindow()
Returns the current window object
### Returns
* `table` `window` The current window object
## Display:write(x, y, text, fg?, bg?)
Writes text to the display at the given position with the given foreground and background colors
### Parameters
@@ -43,4 +43,4 @@ Writes text to the display at the given position with the given foreground and b
### Returns
* `Display` `self` The display instance
## Display:render()