From 2b7aad681f8c82f5385fdd616af75881b70c2cff Mon Sep 17 00:00:00 2001 From: Robert Jelic <36573031+NoryiE@users.noreply.github.com> Date: Sun, 14 Sep 2025 12:23:59 +0200 Subject: [PATCH] Updated Reference Links --- docs/.vitepress/config.mts | 1 + .../elements/BigFont_BigFontText.md | 6 -- .../plugins/animation_AnimationInstance.md | 58 --------------- .../plugins/animation_VisualElement.md | 17 ----- .../plugins/benchmark_BaseElement.md | 74 ------------------- .../references/plugins/benchmark_Container.md | 45 ----------- .../benchmark_Container_VisualElement.md | 44 ----------- 7 files changed, 1 insertion(+), 244 deletions(-) delete mode 100644 docs/references/elements/BigFont_BigFontText.md delete mode 100644 docs/references/plugins/animation_AnimationInstance.md delete mode 100644 docs/references/plugins/animation_VisualElement.md delete mode 100644 docs/references/plugins/benchmark_BaseElement.md delete mode 100644 docs/references/plugins/benchmark_Container.md delete mode 100644 docs/references/plugins/benchmark_Container_VisualElement.md diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index cc16f23..a314d3d 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -145,6 +145,7 @@ export default defineConfig({ { text: 'Program', link: 'references/elements/Program' }, { text: 'ScrollBar', link: 'references/elements/ScrollBar' }, { text: 'Slider', link: 'references/elements/Slider' }, + { text: 'Switch', link: 'references/elements/Switch' }, { text: 'Table', link: 'references/elements/Table' }, { text: 'TextBox', link: 'references/elements/TextBox' }, { text: 'Tree', link: 'references/elements/Tree' }, diff --git a/docs/references/elements/BigFont_BigFontText.md b/docs/references/elements/BigFont_BigFontText.md deleted file mode 100644 index e607957..0000000 --- a/docs/references/elements/BigFont_BigFontText.md +++ /dev/null @@ -1,6 +0,0 @@ -# BigFontText -Basalt - Nyorie: Please don't copy paste this code to your projects, this code is slightly changed (to fit the way basalt draws elements), if you want the original code, checkout this: -http://www.computercraft.info/forums2/index.php?/topic/25367-bigfont-api-write-bigger-letters-v10/ - - - diff --git a/docs/references/plugins/animation_AnimationInstance.md b/docs/references/plugins/animation_AnimationInstance.md deleted file mode 100644 index 44bc8d6..0000000 --- a/docs/references/plugins/animation_AnimationInstance.md +++ /dev/null @@ -1,58 +0,0 @@ -# AnimationInstance -This is the AnimationInstance class. It represents a single animation instance - -## Fields - -|Field|Type|Description| -|---|---|---| -|element|`VisualElement`|The element being animated| -|type|`string`|The type of animation| -|args|`table`|The animation arguments| -|duration|`number`|The duration in seconds| -|startTime|`number`|The animation start time| -|isPaused|`boolean`|Whether the animation is paused| -|handlers|`table`|The animation handlers| -|easing|`string`|The easing function name| - -## Functions - -|Method|Returns|Description| -|---|---|---| -|[AnimationInstance.new](#animationinstance-new)|AnimationInstance|Creates a new animation instance -|[AnimationInstance:complete](#animationinstance-complete)|-|Called when the animation is completed -|[AnimationInstance:start](#animationinstance-start)|AnimationInstance|Starts the animation -|[AnimationInstance:update](#animationinstance-update)|boolean|Updates the animation - - -## AnimationInstance.new(element, animType, args, duration, easing) -Creates a new AnimationInstance - -### Parameters -* `element` `VisualElement` The element to animate -* `animType` `string` The type of animation -* `args` `table` The animation arguments -* `duration` `number` Duration in seconds -* `easing` `string` The easing function name - -### Returns -* `AnimationInstance` `The` new animation instance - -## AnimationInstance:complete() -Gets called when the animation is completed - -## AnimationInstance:start() -Starts the animation - -### Returns -* `AnimationInstance` `self` The animation instance - -## AnimationInstance:update(elapsed) -Updates the animation - -### Parameters -* `elapsed` `number` The elapsed time in seconds - -### Returns -* `boolean` `Whether` the animation is finished - - diff --git a/docs/references/plugins/animation_VisualElement.md b/docs/references/plugins/animation_VisualElement.md deleted file mode 100644 index 78b30ca..0000000 --- a/docs/references/plugins/animation_VisualElement.md +++ /dev/null @@ -1,17 +0,0 @@ -# VisualElement -Adds additional methods for VisualElement when adding animation plugin - -## Functions - -|Method|Returns|Description| -|---|---|---| -|[VisualElement:animate](#visualelement-animate)|Animation|Creates a new animation - - -## VisualElement:animate() -Creates a new Animation Object - -### Returns -* `Animation` `animation` The new animation - - diff --git a/docs/references/plugins/benchmark_BaseElement.md b/docs/references/plugins/benchmark_BaseElement.md deleted file mode 100644 index 2add632..0000000 --- a/docs/references/plugins/benchmark_BaseElement.md +++ /dev/null @@ -1,74 +0,0 @@ -# BaseElement - -## Functions - -|Method|Returns|Description| -|---|---|---| -|[BaseElement:benchmark](#baseelement-benchmark)|BaseElement|Enables performance measurement for a method -|[BaseElement:endProfile](#baseelement-endprofile)|BaseElement|Ends timing a method call and records statistics -|[BaseElement:getBenchmarkStats](#baseelement-getbenchmarkstats)|table?|Retrieves benchmark statistics for a method -|[BaseElement:logBenchmark](#baseelement-logbenchmark)|BaseElement|Logs benchmark statistics for a method -|[BaseElement:startProfile](#baseelement-startprofile)|BaseElement|Starts timing a method call -|[BaseElement:stopBenchmark](#baseelement-stopbenchmark)|BaseElement|Disables performance measurement for a method - - -## BaseElement:benchmark(methodName) -Enables benchmarking for a method - -### Parameters -* `methodName` `string` The name of the method to benchmark - -### Returns -* `BaseElement` `self` The element instance - -### Usage - ```lua -element:benchmark("render") -``` - -## BaseElement:endProfile(methodName) -Ends profiling a method - -### Parameters -* `methodName` `string` The name of the method to stop profiling - -### Returns -* `BaseElement` `self` The element instance - -## BaseElement:getBenchmarkStats(methodName) -Gets benchmark statistics for a method - -### Parameters -* `methodName` `string` The name of the method to get statistics for - -### Returns -* `table?` `stats` The benchmark statistics or nil - -## BaseElement:logBenchmark(methodName) -Logs benchmark statistics for a method - -### Parameters -* `methodName` `string` The name of the method to log - -### Returns -* `BaseElement` `self` The element instance - -## BaseElement:startProfile(methodName) -Starts profiling a method - -### Parameters -* `methodName` `string` The name of the method to profile - -### Returns -* `BaseElement` `self` The element instance - -## BaseElement:stopBenchmark(methodName) -Stops benchmarking for a method - -### Parameters -* `methodName` `string` The name of the method to stop benchmarking - -### Returns -* `BaseElement` `self` The element instance - - diff --git a/docs/references/plugins/benchmark_Container.md b/docs/references/plugins/benchmark_Container.md deleted file mode 100644 index 6657f65..0000000 --- a/docs/references/plugins/benchmark_Container.md +++ /dev/null @@ -1,45 +0,0 @@ -# Container -Container benchmarking methods - -## Functions - -|Method|Returns|Description| -|---|---|---| -|[Container:benchmarkContainer](#Container:benchmarkContainer)|Container|Recursively enables benchmarking -|[Container:logContainerBenchmarks](#Container:logContainerBenchmarks)|Container|Recursively logs benchmark statistics -|[Container:stopContainerBenchmark](#Container:stopContainerBenchmark)|Container|Recursively stops benchmarking - - -## Container:benchmarkContainer(methodName) -Enables benchmarking for a container and all its children - -### Parameters -* `methodName` `string` The method to benchmark - -### Returns -* `Container` `self` The container instance - -### Usage - ```lua -container:benchmarkContainer("render") -``` - -## Container:logContainerBenchmarks(methodName) -Logs benchmark statistics for a container and all its children - -### Parameters -* `methodName` `string` The method to log - -### Returns -* `Container` `self` The container instance - -## Container:stopContainerBenchmark(methodName) -Stops benchmarking for a container and all its children - -### Parameters -* `methodName` `string` The method to stop benchmarking - -### Returns -* `Container` `self` The container instance - - diff --git a/docs/references/plugins/benchmark_Container_VisualElement.md b/docs/references/plugins/benchmark_Container_VisualElement.md deleted file mode 100644 index 587ab66..0000000 --- a/docs/references/plugins/benchmark_Container_VisualElement.md +++ /dev/null @@ -1,44 +0,0 @@ -# Container : VisualElement - -## Functions - -|Method|Returns|Description| -|---|---|---| -|[Container:benchmarkContainer](#container-benchmarkcontainer)|Container|Recursively enables benchmarking -|[Container:logContainerBenchmarks](#container-logcontainerbenchmarks)|Container|Recursively logs benchmark statistics -|[Container:stopContainerBenchmark](#container-stopcontainerbenchmark)|Container|Recursively stops benchmarking - - -## Container:benchmarkContainer(methodName) -Enables benchmarking for a container and all its children - -### Parameters -* `methodName` `string` The method to benchmark - -### Returns -* `Container` `self` The container instance - -### Usage - ```lua -container:benchmarkContainer("render") -``` - -## Container:logContainerBenchmarks(methodName) -Logs benchmark statistics for a container and all its children - -### Parameters -* `methodName` `string` The method to log - -### Returns -* `Container` `self` The container instance - -## Container:stopContainerBenchmark(methodName) -Stops benchmarking for a container and all its children - -### Parameters -* `methodName` `string` The method to stop benchmarking - -### Returns -* `Container` `self` The container instance - -