Files
Basalt/docs/objects/Program/stop.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

35 lines
851 B
Markdown

## stop
### Description
Stops a currently running program
### Returns
1. `object` The object in use
### Usage
* Stops a running program by clicking a button:
```lua
local basalt = require("basalt")
local mainFrame = basalt.createFrame()
local aProgram = mainFrame:addProgram()
aProgram:execute("rom/programs/fun/worm.lua") -- Executes the worm program
local stopButton = mainFrame:addButton()
:setText("Stop")
:setPosition(5, 5)
:setSize(10, 3)
:onClick(function()
aProgram:stop() -- Stop the program when the button is clicked
end)
basalt.autoUpdate()
```
In this example, a Program object is created and added to the mainFrame. The worm program is executed using the `execute` method. A button with the text "Stop" is added to the mainFrame, and when clicked, it will stop the running worm program using the `stop` method.