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

added missing methods

Florian Nücke 2014-03-05 12:23:08 -08:00
parent 2058f1741a
commit 740e87e97b
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
API-Component.md

@ -1,6 +1,19 @@
The component API is used to access and interact with components available to a computer. Also see [[the page on component interaction|ComponentAccess]].
- `component.get(address: string, componentType: string): string | (nil, string)`
- `component.doc(address:string, method:string): string`
Returns the documentation string for the method with the specified name of the component with the specified address, if any. Note that you can also get this string by using `tostring` on a method in a proxy, for example `tostring(component.screen.isOn)`.
- `component.invoke(address:string, method:string[, ...]): ...`
Calls the method with the specified name on the component with the specified address, passing the remaining arguments as arguments to that method. Returns the result of the method call, i.e. the values returned by the method. Depending on the called method's implementation this may throw.
- `component.list([filter:string]):function`
Returns an iterator over all components currently attached to the computer, providing tuples of address and component type. Use it like so: `for address, componentType in component.list() do ... end`
If `filter` is set this will only return components that contain the filter string (this is *not* a pattern/regular expression). For example, `component.list("red")` will return `redstone` components.
- `component.proxy(address:string):table`
Gets a 'proxy' object for a component that provides all methods the component provides as fields, so they can be called more directly (instead of via `invoke`). This is what's used to generate 'primaries' of the individual component types, i.e. what you get via `component.blah`.
For example, you can use it like so: `component.proxy(component.list("redstone")()).getInput(sides.north)`, which gets you a proxy for the first `redstone` component returned by the `component.list` iterator, and then calls `getInput` on it.
Note that proxies will always have at least two fields, `type` with the component's type name, and `address` with the component's address.
- `component.type(address:string):string`
Get the component type of the component with the specified address.
- `component.get(address: string[, componentType: string]): string | (nil, string)`
Tries to resolve an abbreviated address to a full address. Returns the full address on success, or `nil` and an error message otherwise. Optionally filters by component type.
- `component.isAvailable(componentType: string): boolean`
Checks if there is a primary component of the specified component type.