Component Module
The Component Module contains the component Library.
Dependencies |
Globals
component
The component library contains functions that allow interaction with the component network.
component.findComponent ((string query | Class type)…) → string[]…
Searches the component network for components with the given query or have the given type.
You can pass multiple parameters and each parameter will be handled separately and returns a corresponding return value.
Details
| Name | Type | Description |
|---|---|---|
Query |
string | Object-Class |
A nick/group query as string or a class for the components in the network you try to find. |
| Name | Type | Description |
|---|---|---|
UUIDs |
string[] |
List of network component UUIDs which pass the given nick query or are of the given type. |
component.proxy ((id: string | ids: string[])…) → (Object | Object[])…
Generates and returns instances of the network components with the given UUIDs.
You can pass any amount of parameters and each parameter will then have a corresponding return value.
Each parameter can be either a string, or an array of strings.
These strings should then contain just the UUID of a network component.
If a network component cannot be found for a given string, nil will be used for the return.
Otherwise, an instance of the network component will be returned.
If a parameter is a string array, the return value will be an array of network component instances.