diff --git a/docs/references/elements/Display.md b/docs/references/elements/Display.md index 34a12d2..3a06066 100644 --- a/docs/references/elements/Display.md +++ b/docs/references/elements/Display.md @@ -5,7 +5,7 @@ The Display is a special element where you can use the window (term) API to draw |Method|Returns|Description| |---|---|---| -|[Display:getWindow](#Display:getWindow)|-| +|[Display:getWindow](#Display:getWindow)|table|Returns the current window object ## Protected Functions @@ -16,5 +16,9 @@ The Display is a special element where you can use the window (term) API to draw |[Display:render](#Display:render)|-|Renders the Display ## Display:getWindow() +Returns the current window object + +### Returns +* `table` `window` The current window object diff --git a/docs/references/elements/Image.md b/docs/references/elements/Image.md index 2fa3965..ca03b01 100644 --- a/docs/references/elements/Image.md +++ b/docs/references/elements/Image.md @@ -26,7 +26,7 @@ See: https://github.com/SkyTheCodeMaster/bimg |[Image:addFrame](#Image:addFrame)|Image|Adds a new frame to the image |[Image:getBg](#Image:getBg)|-| |[Image:getFg](#Image:getFg)|-| -|[Image:getFrame](#Image:getFrame)|-| +|[Image:getFrame](#Image:getFrame)|table|Gets the specified frame |[Image:getImageSize](#Image:getImageSize)|number|Gets the size of the image |[Image:getMetadata](#Image:getMetadata)|-| |[Image:getPixelData](#Image:getPixelData)|number?|Gets pixel information at position @@ -38,7 +38,7 @@ See: https://github.com/SkyTheCodeMaster/bimg |[Image:setMetadata](#Image:setMetadata)|-| |[Image:setPixel](#Image:setPixel)|Image|Sets the pixel at the specified position |[Image:setText](#Image:setText)|Image|Sets the text at the specified position -|[Image:updateFrame](#Image:updateFrame)|-| +|[Image:updateFrame](#Image:updateFrame)|Image|Updates the specified frame with the provided data ## Protected Functions @@ -58,7 +58,14 @@ Adds a new frame to the image ## Image:getFg() -## Image:getFrame() +## Image:getFrame(frameIndex) +Gets the specified frame + +### Parameters +* `frameIndex` `number` The index of the frame to get + +### Returns +* `table` `frame` The frame data ## Image:getImageSize() Gets the size of the image @@ -147,6 +154,14 @@ Sets the text at the specified position ### Returns * `Image` `self` The Image instance -## Image:updateFrame() +## Image:updateFrame(frameIndex, frame) +Updates the specified frame with the provided data + +### Parameters +* `frameIndex` `number` The index of the frame to update +* `frame` `table` The new frame data + +### Returns +* `Image` `self` The Image instance diff --git a/docs/references/elements/VisualElement.md b/docs/references/elements/VisualElement.md index 9db2f3f..ef3c275 100644 --- a/docs/references/elements/VisualElement.md +++ b/docs/references/elements/VisualElement.md @@ -119,8 +119,7 @@ Checks if the specified coordinates are within the bounds of the element * `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. +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 diff --git a/docs/references/plugins/theme.md b/docs/references/plugins/theme.md index 79d8357..c6bdb16 100644 --- a/docs/references/plugins/theme.md +++ b/docs/references/plugins/theme.md @@ -39,24 +39,24 @@ The Theme API provides methods for managing themes globally |Method|Returns|Description| |---|---|---| -|[themeAPI.getTheme](#themeAPI.getTheme)|table|Gets the current theme -|[themeAPI.loadTheme](#themeAPI.loadTheme)|-|Loads theme from JSON file -|[themeAPI.setTheme](#themeAPI.setTheme)|-|Sets a new theme +|[ThemeAPI.getTheme](#ThemeAPI.getTheme)|table|Gets the current theme +|[ThemeAPI.loadTheme](#ThemeAPI.loadTheme)|-|Loads theme from JSON file +|[ThemeAPI.setTheme](#ThemeAPI.setTheme)|-|Sets a new theme -## themeAPI.getTheme() +## ThemeAPI.getTheme() Gets the current theme configuration ### Returns * `table` `theme` The current theme configuration -## themeAPI.loadTheme(path) +## ThemeAPI.loadTheme(path) Loads a theme from a JSON file ### Parameters * `path` `string` Path to the theme JSON file -## themeAPI.setTheme(newTheme) +## ThemeAPI.setTheme(newTheme) Sets the current theme ### Parameters diff --git a/docs/references/propertySystem.md b/docs/references/propertySystem.md index 03364e3..b147c17 100644 --- a/docs/references/propertySystem.md +++ b/docs/references/propertySystem.md @@ -27,7 +27,7 @@ It also allows for properties to have custom getters and setters. This is the ba |[PropertySystem:instanceProperty](#PropertySystem:instanceProperty)|table|Adds a property to the PropertySystem on instance level |[PropertySystem:observe](#PropertySystem:observe)|table|Observers a property |[PropertySystem:removeAllObservers](#PropertySystem:removeAllObservers)|table|Removes all observers from a property -|[PropertySystem:removeObserver](#PropertySystem:removeObserver)|table| +|[PropertySystem:removeObserver](#PropertySystem:removeObserver)|table|Removes an observer from a property |[PropertySystem:removeProperty](#PropertySystem:removeProperty)|table|Removes a property from the PropertySystem @@ -128,7 +128,6 @@ Removes all observers from a property ## PropertySystem:removeObserver(name, callback) Removes an observer from a property -@NshortDescription Removes an observer from a property ### Parameters * `name` `string` The name of the property