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

deploy: 80b66db325

Browse Source
This commit is contained in:
NoryiE
2025-09-29 18:10:10 +00:00
parent 4483e01c0f
commit 00d69ebc07
1 changed files with 28 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docs/references/elements/VisualElement.md
View File

@@ -18,6 +18,11 @@ Extends: `BaseElement`
|clicked|boolean|false|Whether the element is currently clicked| |clicked|boolean|false|Whether the element is currently clicked|
|hover|boolean|false|Whether the mouse is currently hover over the element (Craftos-PC only)| |hover|boolean|false|Whether the mouse is currently hover over the element (Craftos-PC only)|
|backgroundEnabled|boolean|true|Whether to render the background| |backgroundEnabled|boolean|true|Whether to render the background|
|borderTop|boolean|false|Draw top border|
|borderBottom|boolean|false|Draw bottom border|
|borderLeft|boolean|false|Draw left border|
|borderRight|boolean|false|Draw right border|
|borderColor|color|white|Border color|
|focused|boolean|false|Whether the element has input focus| |focused|boolean|false|Whether the element has input focus|
|visible|boolean|true|Whether the element is visible| |visible|boolean|true|Whether the element is visible|
|ignoreOffset|boolean|false|Whether to ignore the parent's offset| |ignoreOffset|boolean|false|Whether to ignore the parent's offset|
@@ -33,6 +38,10 @@ Extends: `BaseElement`
|Method|Returns|Description| |Method|Returns|Description|
|---|---|---| |---|---|---|
|[VisualElement:isInBounds](#visualelement-isinbounds-x-y)|boolean|Checks if point is within bounds| |[VisualElement:isInBounds](#visualelement-isinbounds-x-y)|boolean|Checks if point is within bounds|
|[VisualElement:addBorder](#visualelement-addborder-colororoptions)|VisualElement|Adds or updates a drawable character border around the element using the canvas plugin.
The border will automatically adapt to size/background changes because the command
reads current properties each render.|
|[VisualElement:removeBorder](#visualelement-removeborder)|VisualElement|Removes the previously added border (if any)|
|[VisualElement:calculatePosition](#visualelement-calculateposition)|number, number|Calculates the position of the element| |[VisualElement:calculatePosition](#visualelement-calculateposition)|number, number|Calculates the position of the element|
|[VisualElement:getAbsolutePosition](#visualelement-getabsoluteposition-x-y)|number, number|Returns the absolute position of the element| |[VisualElement:getAbsolutePosition](#visualelement-getabsoluteposition-x-y)|number, number|Returns the absolute position of the element|
|[VisualElement:getRelativePosition](#visualelement-getrelativeposition-x-y)|number, number|Returns the relative position of the element| |[VisualElement:getRelativePosition](#visualelement-getrelativeposition-x-y)|number, number|Returns the relative position of the element|
@@ -49,6 +58,25 @@ Checks if the specified coordinates are within the bounds of the element
### Returns ### Returns
* `boolean` `isInBounds` Whether the coordinates are within the bounds of the element * `boolean` `isInBounds` Whether the coordinates are within the bounds of the element
## VisualElement:addBorder(colorOrOptions)
Adds or updates a drawable character border around the element using the canvas plugin.
The border will automatically adapt to size/background changes because the command
reads current properties each render.
### Parameters
* `colorOrOptions` `any` Border color or options table
### Returns
* `VisualElement` self
## VisualElement:removeBorder()
Removes the previously added border (if any)
### Returns
* `VisualElement` self
## VisualElement:calculatePosition() ## VisualElement:calculatePosition()
Calculates the position of the element relative to its parent Calculates the position of the element relative to its parent