mirror of
https://github.com/Creators-of-Create/Create.git
synced 2024-12-26 06:57:51 +01:00
Added documentation for most peripherals
- Lua documentation has been added for all peripherals except the train station (not looking forward to writing that one) - This documentation will be added to the GitHub wiki pages
This commit is contained in:
parent
3e21996984
commit
fac1ebcd3f
6 changed files with 165 additions and 0 deletions
88
wiki/Lua-Display-Link.md
Normal file
88
wiki/Lua-Display-Link.md
Normal file
|
@ -0,0 +1,88 @@
|
|||
| Method | Description |
|
||||
|---------------------------------------|------------------------------------------------------|
|
||||
| [`setCursorPos(x, y)`](#setCursorPos) | Sets the cursor position |
|
||||
| [`getCursorPos()`](#getCursorPos) | Gets the current cursor position |
|
||||
| [`getSize()`](#getSize) | Gets the display size of the connected target |
|
||||
| [`isColor()`](#isColor) | Whether the connected display target colors |
|
||||
| [`isColour()`](#isColour) | Whether the connected display target supports colours |
|
||||
| [`write(text)`](#writetext) | Writes text at the current cursor position |
|
||||
| [`clearLine()`](#clearLine) | Clears the line at the current cursor position |
|
||||
| [`clear()`](#clear) | Clears the whole display |
|
||||
| [`update()`](#update) | Pushes an update to the display target |
|
||||
|
||||
---
|
||||
### `setCursorPos(x, y)`
|
||||
Sets the cursor position. Can be outside the bounds of the connected display.
|
||||
|
||||
**Parameters**
|
||||
- _x:_ `number` The cursor x position
|
||||
- _y:_ `number` The cursor y position
|
||||
|
||||
---
|
||||
### `getCursorPos()`
|
||||
Gets the current cursor position.
|
||||
|
||||
**Returns**
|
||||
- `number` The cursor x position
|
||||
- `number` The cursor y position
|
||||
|
||||
---
|
||||
### `getSize()`
|
||||
Gets the size of the connected display target
|
||||
|
||||
**Returns**
|
||||
- `number` The width of the display
|
||||
- `number` The height of the display
|
||||
|
||||
---
|
||||
### `isColor()`
|
||||
Checks whether the connected display target supports color
|
||||
|
||||
**Returns**
|
||||
- `boolean` Whether the display support color
|
||||
|
||||
---
|
||||
### `isColour()`
|
||||
Checks whether the connected display target supports colour
|
||||
|
||||
**Returns**
|
||||
- `boolean` Whether the display support colour
|
||||
|
||||
---
|
||||
### `write(text)`
|
||||
Writes text at the current cursor position, moving the cursor to the end of the text.
|
||||
This only writes to an internal buffer. For the changes to show up on the display [`update()`](#update) must be used.
|
||||
If the cursor is outside the bounds of the connected display the text will not show up on the display.
|
||||
|
||||
This will overwrite any text currently at cursor position.
|
||||
|
||||
**Parameters**
|
||||
- _text:_ `string` Text to write.
|
||||
|
||||
**See also**
|
||||
- [`update()`](#update) To push the changes to the display target.
|
||||
|
||||
---
|
||||
### `clearLine()`
|
||||
Clears the line at the current cursor position.
|
||||
|
||||
**See also**
|
||||
- [`update()`](#update) To push the changes to the display target.
|
||||
|
||||
---
|
||||
### `clear()`
|
||||
Clears the whole display.
|
||||
|
||||
**See also**
|
||||
- [`update()`](#update) To push the changes to the display target.
|
||||
|
||||
---
|
||||
### `update()`
|
||||
Pushes any changes to the connected display target.
|
||||
Any changes made are only made to an internal buffer.
|
||||
For them to show up on the display they must be pushed to the display using this function.
|
||||
This allows for this peripheral to be better multithreaded and for users to be able to change multiple lines at once by
|
||||
using multiple [`write(text)`](#writetext) calls and then one [`update()`](#update) call.
|
||||
|
||||
**See also**
|
||||
- [`write(text)`](#writetext) To write text to the display target.
|
18
wiki/Lua-Rotation-Speed-Controller.md
Normal file
18
wiki/Lua-Rotation-Speed-Controller.md
Normal file
|
@ -0,0 +1,18 @@
|
|||
| Method | Description |
|
||||
|:-----------------------------------------------:|----------------------------------------|
|
||||
| [`setTargetSpeed(speed)`](#setTargetSpeedspeed) | Sets the target rotation speed |
|
||||
| [`getTargetSpeed()`](#getTargetSpeed) | Gets the current target rotation speed |
|
||||
|
||||
---
|
||||
### `setTargetSpeed(speed)`
|
||||
Sets the rotation speed controller's target speed.
|
||||
|
||||
**Parameters**
|
||||
- _speed:_ `number` Target speed. Must be an integer within range of [-256..256]. Values outside of this range will be clamped.
|
||||
|
||||
---
|
||||
### `getTargetSpeed()`
|
||||
Gets the rotation speed controller's current target speed.
|
||||
|
||||
**Returns**
|
||||
- `number` Current target rotation speed.
|
29
wiki/Lua-Sequenced-Gearshift.md
Normal file
29
wiki/Lua-Sequenced-Gearshift.md
Normal file
|
@ -0,0 +1,29 @@
|
|||
| Method | Description |
|
||||
|------------------------------------------------------|--------------------------------------------------------------|
|
||||
| [`rotate(angle, [modifier])`](#rotateangle-modifier) | Rotates shaft by a set angle |
|
||||
| [`move(distance, [modifier])`](#moveangle-modifier) | Rotates shaft to move Piston/Pulley/Gantry by a set distance |
|
||||
| [`isRunning()`](#isRunning) | Checks if the gearshift is spinning |
|
||||
|
||||
---
|
||||
### `rotate(angle, [modifier])`
|
||||
|
||||
Rotates connected components by a set angle.
|
||||
|
||||
**Parameters**
|
||||
- _angle:_ `number` Angle to rotate shaft by. Must be a positive integer.
|
||||
- _modifier?:_ `number = 1` Speed modifier which can be used to reverse rotation. Must be an integer within range of [-2..2]. Values out of this range will cause the modifier to revert to its default of 1.
|
||||
|
||||
---
|
||||
### `move(distance, [modifier])`
|
||||
Rotates connected components to move connected piston, pulley or gantry contractions by a set distance.
|
||||
|
||||
**Parameters**
|
||||
- _distance:_ `number` Distance to move connected piston, pulley or gantry contraptions by. Must be a positive integer.
|
||||
- _modifier?:_ `number = 1` Speed modifier which can be used to reverse rotation. Must be an integer within range of [-2..2]. Values out of this range will cause the modifier to revert to its default of 1.
|
||||
|
||||
---
|
||||
### `isRunning()`
|
||||
Checks if the sequenced gearshift is currently spinning.
|
||||
|
||||
**Returns**
|
||||
- `boolean` Whether the sequenced gearshift is currently spinning.
|
10
wiki/Lua-Speedometer.md
Normal file
10
wiki/Lua-Speedometer.md
Normal file
|
@ -0,0 +1,10 @@
|
|||
| Method | Description |
|
||||
|---------------------------|---------------------------------|
|
||||
| [`getSpeed()`](#getSpeed) | Gets the current rotation speed |
|
||||
|
||||
---
|
||||
### `getSpeed()`
|
||||
Gets the current rotation speed of the attached components
|
||||
|
||||
**Returns**
|
||||
- `number` The current rotation speed
|
18
wiki/Lua-Stressometer.md
Normal file
18
wiki/Lua-Stressometer.md
Normal file
|
@ -0,0 +1,18 @@
|
|||
| Method | Description |
|
||||
|---------------------------------------------|--------------------------------|
|
||||
| [`getStress()`](#getStress) | Gets the current stress level |
|
||||
| [`getStressCapacity()`](#getStressCapacity) | Gets the total stress capacity |
|
||||
|
||||
---
|
||||
### `getStress()`
|
||||
Gets the connected network's current stress level
|
||||
|
||||
**Returns**
|
||||
- `number` The current stress level
|
||||
|
||||
---
|
||||
### `getStressCapacity()`
|
||||
Gets the connected network's total stress capacity
|
||||
|
||||
**Returns**
|
||||
- `number` The total stress capacity
|
2
wiki/README.md
Normal file
2
wiki/README.md
Normal file
|
@ -0,0 +1,2 @@
|
|||
Just before this PR is about to be merged this /wiki folder will be removed from the PR and the pages will be added to
|
||||
the wiki section of the Create GitHub under API Reference
|
Loading…
Reference in a new issue