GitHub/Basalt
1
0
Fork 0
Code Issues 28 Pull Requests 3 Actions Packages Projects Releases 9 Wiki Activity
Files
9b0af8fcb33c62739f97f584099ecdb2655be1af
Basalt/docs/objects/VisualObject/addPreDraw.md
Robert Jelic bb1b1beb79 Basalt 1.7 Update 
- New Objects (Flexbox, Graph, Treeview)
- Pluginsystem to add/remove functionality
- Reworked the entire Object system, instead of one big Object Class we have multiple classes: Object, VisualObject, ChangeableObject
- Instead of one big Frame Class we have multiple Frame Classes: BaseFrame, Frame, MovableFrame, ScrollableFrame, MonitorFrame, Flexbox
- Removed the Animation Object, and added a animation plugin instead
- Removed the Graphic Object and merged it's functionality with the image object
- Updated currently existing objects
2023-04-30 17:05:34 +02:00

1.1 KiB
Raw Blame History

addPreDraw

Description

Adds a custom drawing function to the object's preDrawQueue. Functions in the preDrawQueue are executed before the main drawing functions. This allows users to create custom graphical representations that will be drawn behind the main elements.

Parameters

  1. string Name (ID) - must be unique
  2. function The function to be executed, containing the custom drawing code
  3. number Optional - Position, determines the order or priority of the drawing
  4. boolean Optional - Whether the drawing should be rendered immediately or not, default is true

Returns

  1. object The object in use

Usage

local basalt = require("basalt")

local mainFrame = basalt.createFrame()

local function customPreDrawing()
  -- Custom drawing code goes here
end

mainFrame:addPreDraw("uniqueID", customPreDrawing)

In this example, a custom drawing function is added to the main frame's preDrawQueue. The custom drawing code should be placed inside the customPreDrawing function. The drawing is given a unique ID, a position of 1, and rendered immediately.