mirrors/Create
0
0
Fork 0
mirror of https://github.com/Creators-of-Create/Create.git synced 2024-09-20 20:52:25 +02:00
Code Issues Packages Projects Releases Wiki Activity
fac1ebcd3f
Create/wiki/Lua-Display-Link.md
caelwarner fac1ebcd3f
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
2023-03-11 16:12:58 -08:00

3.1 KiB
Raw Blame History

Method Description
setCursorPos(x, y) Sets the cursor position
getCursorPos() Gets the current cursor position
getSize() Gets the display size of the connected target
isColor() Whether the connected display target colors
isColour() Whether the connected display target supports colours
write(text) Writes text at the current cursor position
clearLine() Clears the line at the current cursor position
clear() Clears the whole display
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() 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() To push the changes to the display target.

clearLine()

Clears the line at the current cursor position.

See also

  • update() To push the changes to the display target.

clear()

Clears the whole display.

See also

  • 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) calls and then one update() call.

See also