From 85c4742de344cb1c97486165b836f64498c9e2a0 Mon Sep 17 00:00:00 2001 From: NoryiE Date: Tue, 25 Feb 2025 11:22:51 +0000 Subject: [PATCH] deploy: 80a300ed094dee2b3fd4a97917fdac35bc12d6f2 --- docs/references/elements/BigFont.md | 24 +++++++++++++++++++ .../elements/BigFont_BigFontText.md | 11 +++++++++ docs/references/elements/Frame.md | 10 ++++++++ docs/references/elements/VisualElement.md | 8 +++++++ 4 files changed, 53 insertions(+) create mode 100644 docs/references/elements/BigFont.md create mode 100644 docs/references/elements/BigFont_BigFontText.md diff --git a/docs/references/elements/BigFont.md b/docs/references/elements/BigFont.md new file mode 100644 index 0000000..3efaee2 --- /dev/null +++ b/docs/references/elements/BigFont.md @@ -0,0 +1,24 @@ +# BigFont : VisualElement +The BigFont element is a text element that displays large text. + +## Properties + +|Property|Type|Default|Description| +|---|---|---|---| +|text|string|BigFont|BigFont text +|fontSize|number|1|The font size of the BigFont + +## Functions + +|Method|Returns|Description| +|---|---|---| + + +## Protected Functions + +|Method|Returns|Description| +|---|---|---| +|[BigFont:init](#BigFont:init)|-|Initializes the BigFont instance +|[BigFont:render](#BigFont:render)|-|Renders the BigFont + + diff --git a/docs/references/elements/BigFont_BigFontText.md b/docs/references/elements/BigFont_BigFontText.md new file mode 100644 index 0000000..20511d2 --- /dev/null +++ b/docs/references/elements/BigFont_BigFontText.md @@ -0,0 +1,11 @@ +# BigFontText +Basalt - Nyorie: Please don't copy paste this code to your projects, this code is slightly changed (to fit the way basalt draws stuff), if you want the original code, checkout this: +http://www.computercraft.info/forums2/index.php?/topic/25367-bigfont-api-write-bigger-letters-v10/ + +## Functions + +|Method|Returns|Description| +|---|---|---| + + + diff --git a/docs/references/elements/Frame.md b/docs/references/elements/Frame.md index ab359c7..85fae66 100644 --- a/docs/references/elements/Frame.md +++ b/docs/references/elements/Frame.md @@ -1,6 +1,13 @@ # 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|{{x=1,|y=1, width="width", height=1}} The map of dragging positions + ## Functions |Method|Returns|Description| @@ -12,5 +19,8 @@ This is the frame class. It serves as a grouping container for other elements. |Method|Returns|Description| |---|---|---| |[Frame:init](#Frame:init)|Frame|Initializes the Frame instance +|[Frame:mouse_click](#Frame:mouse_click)|boolean|Handles mouse click events +|[Frame:mouse_drag](#Frame:mouse_drag)|boolean|Handles mouse drag events +|[Frame:mouse_release](#Frame:mouse_release)|boolean|Handles mouse release events diff --git a/docs/references/elements/VisualElement.md b/docs/references/elements/VisualElement.md index 923ff0e..e929923 100644 --- a/docs/references/elements/VisualElement.md +++ b/docs/references/elements/VisualElement.md @@ -53,6 +53,7 @@ and provides core functionality for positioning, sizing, colors, and rendering. |[VisualElement:getAbsolutePosition](#VisualElement:getAbsolutePosition)|number|Returns the absolute position of the element |[VisualElement:getRelativePosition](#VisualElement:getRelativePosition)|number|Returns the relative position of the element |[VisualElement:isInBounds](#VisualElement:isInBounds)|boolean|Checks if point is within bounds +|[VisualElement:prioritize](#VisualElement:prioritize)|VisualElement|Prioritizes the element by moving it to the top of its parent's children ## Protected Functions @@ -114,4 +115,11 @@ Checks if the specified coordinates are within the bounds of the element ### Returns * `boolean` `isInBounds` Whether the coordinates are within the bounds of the element +## VisualElement:prioritize() +This function is used to prioritize the element by moving it to the top of its parent's children. +It removes the element from its parent and adds it back, effectively changing its order. + +### Returns +* `VisualElement` `self` The VisualElement instance +