Docs: basalt.update()

This commit is contained in:
Erb3
2022-09-17 14:33:10 +02:00
parent 9acf7d5345
commit bd61da9593

View File

@@ -1,18 +1,23 @@
## basalt.update
# basalt.update
Calls the draw and event handler once - this gives more flexibility about which events basalt should process. For example you could filter the terminate event.
Which means you have to pass the events into basalt.update.
#### Parameters:
1. `string` The event to be received
## Parameters
1. `string` The event to be received
2. `...` Additional event variables to capture
#### Usage:
## Usage
* Creates and starts a custom update cycle
```lua
local mainFrame = basalt.createFrame()
local aButton = mainFrame:addButton():setPosition(2,2)
mainFrame:addButton():setPosition(2,2)
while true do
local ev = table.pack(os.pullEventRaw())
basalt.update(table.unpack(ev))
end
```
```