mirror of
https://github.com/jimathy/jim_bridge.git
synced 2026-08-17 05:56:02 +01:00
better documentation layout
- seperated the 2000+ lines in ReadMe.md into seperate files. - useful if things expand - better readability for users - more organised layout
This commit is contained in:
25
documentation/main_functions/drawtext.md
Normal file
25
documentation/main_functions/drawtext.md
Normal file
@@ -0,0 +1,25 @@
|
||||
### drawText.lua
|
||||
|
||||
These functions handle drawing and hiding styled on-screen prompts or UI overlays, compatible with different styling frameworks such as OX Lib.
|
||||
|
||||
- **drawText(image, input, style, oxStyleTable)**
|
||||
|
||||
- Displays styled text or prompts on screen.
|
||||
- Designed to adapt styling depending on which UI system (e.g., OX) is in use.
|
||||
- **Parameters:**
|
||||
- `image` (`string`): Optional icon or image path.
|
||||
- `input` (`string`): The main text to display.
|
||||
- `style` (`string|table`): Preset or custom styling.
|
||||
- `oxStyleTable` (`table`, optional): Extended style options if using OX UI.
|
||||
- **Example:**
|
||||
```lua
|
||||
drawText("img_link", { "Test line 1", "Test Line 2" }, "~g~")
|
||||
```
|
||||
|
||||
- **hideText()**
|
||||
|
||||
- Hides any active text or UI element previously drawn with `drawText()`.
|
||||
- **Example:**
|
||||
```lua
|
||||
hideText()
|
||||
```
|
||||
Reference in New Issue
Block a user