GitHub/Basalt
1
0
Fork 0
Code Issues 28 Pull Requests 3 Actions Packages Projects Releases 9 Wiki Activity

updated param and return headers

Browse Source
This commit is contained in:
Samuel Pizette
2022-06-09 11:43:59 -04:00
parent 4b8f3c2d5c
commit b6ee09636b
14 changed files with 188 additions and 188 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
docs/objects/Program.md
View File

@@ -10,8 +10,8 @@ local mainFrame = basalt.createFrame("myFirstFrame"):show()
local aProgram = mainFrame:addProgram("myFirstProgram"):show()
basalt.debug(aProgram:getStatus()) -- returns "running", "normal", "suspended" or "dead"
```
**parameters:**-<br>
**returns:** string "running" - if its running, "normal" - is active but not running (waiting for a event), "suspended" - is suspended or not started, "dead" - has finished or stopped with an error<br>
#### Parameters:-<br>
#### Returns: string "running" - if its running, "normal" - is active but not running (waiting for a event), "suspended" - is suspended or not started, "dead" - has finished or stopped with an error<br>
## execute
executes the given path (-program)
@@ -20,8 +20,8 @@ local mainFrame = basalt.createFrame("myFirstFrame"):show()
local aProgram = mainFrame:addProgram("myFirstProgram"):show()
aProgram:execute("rom/programs/fun/worm.lua") -- executes worm
```
**parameters:** string filepath - (the path to the program you want to execute)<br>
**returns:** self<br>
#### Parameters: string filepath - (the path to the program you want to execute)<br>
#### Returns: self<br>
## stop
gives a terminate event to the program, which means if you are running a shell, and the shell executes a program by itself you have to call stop 2 times to entirely close the running program
@@ -31,8 +31,8 @@ local aProgram = mainFrame:addProgram("myFirstProgram"):execute("rom/programs/sh
mainFrame:addButton("myFirstButton"):setText("close"):onClick(function() aProgram:stop() end):show()
```
**parameters:**-<br>
**returns:** self<br>
#### Parameters:-<br>
#### Returns: self<br>
## pause
pauses the program (prevents the program from receiving events)
@@ -42,8 +42,8 @@ local aProgram = mainFrame:addProgram("myFirstProgram"):execute("rom/programs/sh
mainFrame:addButton("myFirstButton"):setText("close"):onClick(function() aProgram:pause(true) end):show()
```
**parameters:** boolean pause<br>
**returns:** self<br>
#### Parameters: boolean pause<br>
#### Returns: self<br>
## isPaused
returns if the program is currently paused
@@ -53,8 +53,8 @@ local aProgram = mainFrame:addProgram("myFirstProgram"):execute("rom/programs/sh
mainFrame:addButton("myFirstButton"):setText("pause"):onClick(function() basalt.debug(aProgram:isPaused()) end):show()
```
**parameters:** -<br>
**returns:** boolean isPaused<br>
#### Parameters: -<br>
#### Returns: boolean isPaused<br>
## injectEvent
injects a event into the program manually
@@ -64,8 +64,8 @@ local aProgram = mainFrame:addProgram("myFirstProgram"):execute("rom/programs/sh
mainFrame:addButton("myFirstButton"):setText("inject"):onClick(function() aProgram:injectEvent("char", "w") end):show()
```
**parameters:** string event, any parameter, any parameter, any parameter, any parameter, boolean ignorePause<br>
**returns:** self<br>
#### Parameters: string event, any parameter, any parameter, any parameter, any parameter, boolean ignorePause<br>
#### Returns: self<br>
## injectEvents
injects a event table into the program manually
@@ -75,8 +75,8 @@ local aProgram = mainFrame:addProgram("myFirstProgram"):execute("rom/programs/sh
--example will follow
```
**parameters:** string event, any parameter, any parameter, any parameter, any parameter, boolean ignorePause<br>
**returns:** self<br>
#### Parameters: string event, any parameter, any parameter, any parameter, any parameter, boolean ignorePause<br>
#### Returns: self<br>
## getQueuedEvents
returns a table of all currently queued events (while pause is active incomming events will go into a queueEvents table) as soon as the program gets unpaused
@@ -87,8 +87,8 @@ local aProgram = mainFrame:addProgram("myFirstProgram"):execute("rom/programs/sh
mainFrame:addButton("myFirstButton"):setText("inject"):onClick(function() basalt.debug(aProgram:getQueuedEvents()) end):show()
```
**parameters:** -<br>
**returns:** table queuedEvents<br>
#### Parameters: -<br>
#### Returns: table queuedEvents<br>
## updateQueuedEvents
here you can manipulate the queuedEvents table with your own events table
@@ -98,6 +98,6 @@ local aProgram = mainFrame:addProgram("myFirstProgram"):execute("rom/programs/sh
--example will follow
```
**parameters:** table queuedEvents<br>
**returns:** self<br>
#### Parameters: table queuedEvents<br>
#### Returns: self<br>