Skip to content

Source Block

Image title This peripheral is provided by the Source Block. It is used to display data on Create Display Targets.

The peripheral acts similar to a normal Terminal with some implementations from the Window API. It does not support formatted text.

Metadata
Peripheral v1.1
Attach name "create_source"
Attach side all

Events

The RedRouter can send the following event:

Name Description Parameter 1
"monitor_resize" Whenever the display targets size changes. string: attached_name

Functions

setCursorPos(x, y)

Sets the position of the cursor. write will begin at this position.

Parameters

  1. x: number The new x position of the cursor.
  2. y: number The new y position of the cursor.

write(text)

Will write the given input to the linked display.

Parameters

  1. text: string The string to write at the current cursor position.

scroll(y)

Scrolls the content of the display vertically for y lines.

Parameters

  1. y: number How many lines the display will scroll.

clear()

Clears the whole screen.

clearLine()

Clears the line at the current cursor position.

getLine(y)

Returns the line at the wanted display position.

Parameters

  1. y: number The y position on the display.

Returns

  1. string The line of the given position.

Throws

  • Whenever the given number is not in the range of 1 to <terminal height>.

getCursorPos()

Returns the current cursor position.

Returns

  1. number The x position of the cursor.
  2. number The y position of the cursor.

getSize()

Returns the current display size.

Returns

  1. number The width of the Create Display Target.
  2. number The height of the Create Display Target.