AstralTransRocketries/OpenComputers
1
0
Fork 0
mirror of https://github.com/MightyPirates/OpenComputers.git synced 2025-09-12 16:57:32 -04:00
Code Issues Packages Projects Releases Wiki Activity

Created API/Process (markdown)

Florian Nücke 2014-03-06 01:25:39 -08:00
parent 58f313f6cc
commit a004571fba
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
API-Process.md Normal file

@ -0,0 +1,11 @@
This API provides rudimentary process management. It is used mainly by the `io` module to provide individual standard input and output to individual programs.
- `process.load(path:string[, env:table[, init:function[, name:string]]]):coroutine`
Loads a Lua script from the specified *absolute* path and sets it up as a process.
It will be loaded with a custom environment, to avoid cluttering the callers/global environment. This environment will have access to anything in the specified environment, or the default (top level) environment if none is given.
If an `init` function is specified, that method is called the first time the resulting coroutine is executed, and run before the actual program is started. This allows fine-tuning of the programs environment.
If a `name` is specified, that is the name the process will specify in `process.running`. It will be `nil` otherwise.
- `process.running([level: number]): string, table, string`
Returns the path to the currently running program (i.e. the last process created via `process.load`). The level can optionally be provided to get parent processes. It defaults to 1, the current program. 2 is the current program's parent (the one that called `process.load` to start the current program) and so on.
The second returned value is the environment of the process, i.e. the table created for it to use as one.
The third returned value is the 'name' of the process, i.e. the fourth parameter to `process.load`. For programs started via the shell this will ususally be the original command. E.g. for `ls -l`, the first returned value will be `ls`, while this value will be `ls -l`.