docs fix
This commit is contained in:
Robert Jelic
@@ -1,96 +1,56 @@
|
||||
# BaseFrame
|
||||
_This is the base frame class. It is the root element of all elements and the only element without a parent._
|
||||
# BaseFrame : Container
|
||||
This is the base frame class. It is the root element of all elements and the only element without a parent.
|
||||
|
||||
Extends: `Container`
|
||||
## Fields
|
||||
|
||||
|Field|Type|Description|
|
||||
|---|---|---|
|
||||
|_render|`Render`|The render object|
|
||||
|_renderUpdate|`boolean`|Whether the render object needs to be updated|
|
||||
|_peripheralName|`string`|The name of a peripheral|
|
||||
|
||||
## Properties
|
||||
|
||||
|Property|Type|Default|Description|
|
||||
|---|---|---|---|
|
||||
|term|term|peripheral|term.current()|The terminal or (monitor) peripheral object to render to|
|
||||
|term|term|peripheral|term.current()|The terminal or (monitor) peripheral object to render to
|
||||
|
||||
## Functions
|
||||
|
||||
|Method|Returns|Description|
|
||||
|---|---|---|
|
||||
|[BaseFrame.new](#baseframe-new)|BaseFrame|Creates a new Frame instance|
|
||||
|[BaseFrame:BaseFrame](#baseframe-baseframe-props-basalt)|table|Initializes the Frame instance|
|
||||
|[BaseFrame:BaseFrame](#baseframe-baseframe-x-y-width-height-text-fg-bg)|-|Renders a multiBlit to the render Object|
|
||||
|[BaseFrame:BaseFrame](#baseframe-baseframe-x-y-text-fg)|-|Renders a text with a foreground color to the render Object|
|
||||
|[BaseFrame:BaseFrame](#baseframe-baseframe-x-y-text-bg)|-|Renders a text with a background color to the render Object|
|
||||
|[BaseFrame:BaseFrame](#baseframe-baseframe-x-y-text-bg)|-|Renders a text with a background color to the render Object|
|
||||
|[BaseFrame:BaseFrame](#baseframe-baseframe-x-y-text-fg-bg)|-|Renders a text with a foreground and background color to the render Object|
|
||||
|[BaseFrame:BaseFrame](#baseframe-baseframe-x-y-blink)|-|Sets the cursor position|
|
||||
|[BaseFrame:BaseFrame](#baseframe-baseframe-name-x-y)|-|Handles monitor touch events|
|
||||
|[BaseFrame:BaseFrame](#baseframe-baseframe-button-x-y)|-|Handles mouse click events|
|
||||
|[BaseFrame:BaseFrame](#baseframe-baseframe-button-x-y)|-|Handles mouse up events|
|
||||
|[BaseFrame:BaseFrame](#baseframe-baseframe)|-|Resizes the Frame|
|
||||
|[BaseFrame:BaseFrame](#baseframe-baseframe-key)|-|Handles key events|
|
||||
|[BaseFrame:BaseFrame](#baseframe-baseframe-key)|-|Handles key up events|
|
||||
|[BaseFrame:BaseFrame](#baseframe-baseframe-char)|-|Handles character events|
|
||||
|[BaseFrame:BaseFrame](#baseframe-baseframe)|-|Renders the Frame|
|
||||
|[BaseFrame:dispatchEvent](#baseframe-dispatchevent)|-|
|
||||
|[BaseFrame:drawBg](#baseframe-drawbg)|-|
|
||||
|[BaseFrame:drawFg](#baseframe-drawfg)|-|
|
||||
|[BaseFrame:setCursor](#baseframe-setcursor)|-|Sets the cursor position
|
||||
|
||||
## BaseFrame.new()
|
||||
|
||||
Creates a new Frame instance
|
||||
## Protected Functions
|
||||
|
||||
### Returns
|
||||
* `BaseFrame` `object` The newly created Frame instance
|
||||
|Method|Returns|Description|
|
||||
|---|---|---|
|
||||
|BaseFrame:blit|-|Renders a text with a foreground and background color to the render Object
|
||||
|BaseFrame:char|-|Handles character events
|
||||
|BaseFrame:drawText|-|Renders a text with a background color to the render Object
|
||||
|BaseFrame:init|table|Initializes the Frame instance
|
||||
|BaseFrame:key|-|Handles key events
|
||||
|BaseFrame:key_up|-|Handles key up events
|
||||
|BaseFrame:monitor_touch|-|Handles monitor touch events
|
||||
|BaseFrame:mouse_click|-|Handles mouse click events
|
||||
|BaseFrame:mouse_up|-|Handles mouse up events
|
||||
|BaseFrame:multiBlit|-|Renders a multiBlit to the render Object
|
||||
|BaseFrame:render|-|Renders the Frame
|
||||
|BaseFrame:term_resize|-|Resizes the Frame
|
||||
|BaseFrame:textBg|-|Renders a text with a background color to the render Object
|
||||
|BaseFrame:textFg|-|Renders a text with a foreground color to the render Object
|
||||
|
||||
### Usage
|
||||
```lua
|
||||
local element = BaseFrame.new()
|
||||
```
|
||||
## BaseFrame:dispatchEvent()
|
||||
|
||||
## BaseFrame:BaseFrame(props, basalt)
|
||||
### Parameters
|
||||
* `props` `table` The properties to initialize the element with
|
||||
* `basalt` `table` The basalt instance
|
||||
## BaseFrame:drawBg()
|
||||
|
||||
### Returns
|
||||
* `table` `self` The initialized instance
|
||||
|
||||
## BaseFrame:BaseFrame(x, y, width, height, text, fg, bg)
|
||||
### Parameters
|
||||
* `x` `number` The x position to render to
|
||||
* `y` `number` The y position to render to
|
||||
* `width` `number` The width of the text
|
||||
* `height` `number` The height of the text
|
||||
* `text` `string` The text to render
|
||||
* `fg` `string` The foreground color
|
||||
* `bg` `string` The background color
|
||||
|
||||
## BaseFrame:BaseFrame(x, y, text, fg)
|
||||
### Parameters
|
||||
* `x` `number` The x position to render to
|
||||
* `y` `number` The y position to render to
|
||||
* `text` `string` The text to render
|
||||
* `fg` `colors` The foreground color
|
||||
|
||||
## BaseFrame:BaseFrame(x, y, text, bg)
|
||||
### Parameters
|
||||
* `x` `number` The x position to render to
|
||||
* `y` `number` The y position to render to
|
||||
* `text` `string` The text to render
|
||||
* `bg` `colors` The background color
|
||||
|
||||
## BaseFrame:BaseFrame(x, y, text, bg)
|
||||
### Parameters
|
||||
* `x` `number` The x position to render to
|
||||
* `y` `number` The y position to render to
|
||||
* `text` `string` The text to render
|
||||
* `bg` `colors` The background color
|
||||
|
||||
## BaseFrame:BaseFrame(x, y, text, fg, bg)
|
||||
### Parameters
|
||||
* `x` `number` The x position to render to
|
||||
* `y` `number` The y position to render to
|
||||
* `text` `string` The text to render
|
||||
* `fg` `string` The foreground color
|
||||
* `bg` `string` The background color
|
||||
|
||||
## BaseFrame:BaseFrame(x, y, blink)
|
||||
## BaseFrame:drawFg()
|
||||
|
||||
## BaseFrame:setCursor(x, y, blink)
|
||||
Sets the cursor position
|
||||
|
||||
### Parameters
|
||||
@@ -98,35 +58,4 @@ Sets the cursor position
|
||||
* `y` `number` The y position to set the cursor to
|
||||
* `blink` `boolean` Whether the cursor should blink
|
||||
|
||||
## BaseFrame:BaseFrame(name, x, y)
|
||||
### Parameters
|
||||
* `name` `string` The name of the monitor that was touched
|
||||
* `x` `number` The x position of the mouse
|
||||
* `y` `number` The y position of the mouse
|
||||
|
||||
## BaseFrame:BaseFrame(button, x, y)
|
||||
### Parameters
|
||||
* `button` `number` The button that was clicked
|
||||
* `x` `number` The x position of the mouse
|
||||
* `y` `number` The y position of the mouse
|
||||
|
||||
## BaseFrame:BaseFrame(button, x, y)
|
||||
### Parameters
|
||||
* `button` `number` The button that was released
|
||||
* `x` `number` The x position of the mouse
|
||||
* `y` `number` The y position of the mouse
|
||||
|
||||
## BaseFrame:BaseFrame()
|
||||
## BaseFrame:BaseFrame(key)
|
||||
### Parameters
|
||||
* `key` `number` The key that was pressed
|
||||
|
||||
## BaseFrame:BaseFrame(key)
|
||||
### Parameters
|
||||
* `key` `number` The key that was released
|
||||
|
||||
## BaseFrame:BaseFrame(char)
|
||||
### Parameters
|
||||
* `char` `string` The character that was pressed
|
||||
|
||||
## BaseFrame:BaseFrame()
|
||||
Reference in New Issue
Block a user