Skip to main content

Display

The display is like a monitor but in Scrap Mechanic. Allows you to draw anything on it with a computer.

Structures​

TouchData​

This contains the latest touch data that the screen has recieved from any player, this is what it is formatted like:

{
    x = 1, -- The position of the touch x coordinate
    y = 1, -- The position of the touch y coordinate
    state = 2 -- The press state. 1: pressed | 2: drag | 3: released
}

TouchTable​

This is a table that contains all touch data from every player interacting with the screen, this is what it is formatted like:

{
    ["Ben Bingo"] = { -- The touch data's index is the players name
        x = 12, -- The position of the touch x coordinate
        y = 29, -- The position of the touch y coordinate
        state = 1 -- The press state. 1: pressed | 2: drag | 3: released
    },

    ["VeraDev"] = {
        x = 37,
        y = 69,
        state = 3
    }
}

PixelTable​

Pixel table's are tables of pixel information used for drawing on the display, they are in a format that the display can understand.

{
    x = 1, -- The position of the pixel on the X-axis
    y = 1, -- The position of the pixel on the Y-axis
    color = sm.color.new("ff0000") -- The color of the pixel
}

This one above draws a singular red pixel on coordinates (1, 1).

Functions​

drawPixel​

Display.drawPixel( x, y, color )

Draws a single pixel at the specified coordinates with the given color.

Arguments:

  • x [ number ] The x-coordinate of the pixel.
  • y [ number ] The y-coordinate of the pixel.
  • color [ Color|string ] The color of the pixel in hexadecimal format.

drawFromTable​

Display.drawFromTable( tbl )

Draws shapes and text based on data provided in a table.

Arguments:

  • tbl [ PixelTable[] ] All instructions to run through.

drawLine​

Display.drawLine( x, y, x1, y1, color )

Draw a line between two points with the specified color.

Arguments:

  • x [ number ] The x-coordinate of the starting point.
  • y [ number ] The y-coordinate of the starting point.
  • x1 [ number ] The x-coordinate of the ending point.
  • y1 [ number ] The y-coordinate of the ending point.
  • color [ Color|string ] The color of the line in hexadecimal format.

drawCircle​

Display.drawCircle( x, y, radius, color )

Draws a circle with the specified center coordinates, radius, and color.

Arguments:

  • x [ number ] The x-coordinate of the center of the circle.
  • y [ number ] The y-coordinate of the center of the circle.
  • radius [ number ] The radius of the circle.
  • color [ Color|string ] The color of the circle in hexadecimal format.

drawFilledCircle​

Display.drawFilledCircle( x, y, radius, color )

Draws a filled circle with the specified center coordinates, radius, and color.

Arguments:

  • x [ number ] The x-coordinate of the center of the circle.
  • y [ number ] The y-coordinate of the center of the circle.
  • radius [ number ] The radius of the circle.
  • color [ Color|string ] The color of the circle in hexadecimal format.

drawTriangle​

Display.drawTriangle( x1, y1, x2, y2, x3, y3, color )

Draws a triangle with the specified vertices and color. Arguments:

Arguments"

  • x1 [ number ] The x-coordinate of the first vertex.
  • y1 [ number ] The y-coordinate of the first vertex.
  • x2 [ number ] The x-coordinate of the second vertex.
  • y2 [ number ] The y-coordinate of the second vertex.
  • x3 [ number ] The x-coordinate of the third vertex.
  • y3 [ number ] The y-coordinate of the third vertex.
  • color [ Color|string ] The color of the triangle in hexadecimal format.

drawFilledTriangle​

Display.drawFilledTriangle( x1, y1, x2, y2, x3, y3, color )

Draws a filled triangle with the specified vertices and color. Arguments:

Arguments"

  • x1 [ number ] The x-coordinate of the first vertex.
  • y1 [ number ] The y-coordinate of the first vertex.
  • x2 [ number ] The x-coordinate of the second vertex.
  • y2 [ number ] The y-coordinate of the second vertex.
  • x3 [ number ] The x-coordinate of the third vertex.
  • y3 [ number ] The y-coordinate of the third vertex.
  • color [ Color|string ] The color of the triangle in hexadecimal format.

drawRect​

Display.drawRect( x, y, width, height, color )

Draws a rectangle with the specified position, width, height, and color.

Arguments:

  • x [ number ] The x-coordinate of the top-left corner of the rectangle.
  • y [ number ] The y-coordinate of the top-left corner of the rectangle.
  • width [ number ] The width of the rectangle.
  • height [ number ] The height of the rectangle.
  • color [ Color|string ] The color of the rectangle in hexadecimal format.

drawFilledRect​

Display.drawFilledRect( x, y, width, height, color )

Draws a filled rectangle with the specified position, width, height, and color.

Arguments:

  • x [ number ] The x-coordinate of the top-left corner of the rectangle.
  • y [ number ] The y-coordinate of the top-left corner of the rectangle.
  • width [ number ] The width of the rectangle.
  • height [ number ] The height of the rectangle.
  • color [ Color|string ] The color of the rectangle in hexadecimal format.

drawText​

Display.drawText( x, y, string, color, fontName )

Draws text at the specified position with the specified color.

Arguments:

  • x [ number ] The x-coordinate of the text.
  • y [ number ] The y-coordinate of the text.
  • string [ string ] The text to draw.
  • color [ Color|string ] The color of the text in hexadecimal format.
  • fontName [ string? ] The font to use. (defaults to whatever the default font the font manager is using).

drawASCFText​

Display.drawASCFText( xOffset, yOffset, text, fontName, color, rotation, fontSize, colorToggled )

Draws ASCF text to a display.

Arguments:

  • xOffset [ number ] The x-coordinate.
  • yOffset [ number ] The y-coordinate.
  • text [ string ] The text to draw.
  • fontName [ string ] The name of the font.
  • color [ string|Color ] The color of the text to set.
  • rotation [ number? ] The rotation.
  • fontSize [ number ] The size of the font to use.
  • colorToggled [ boolean? ] If it should support colors or not in text.

loadImage​

Display.loadImage( width, height, path, customSearch )

Draws a image on the screen. Images are loaded from the DisplayImages folder in the mods directory, you can generate your own images with the use of our PNG to pixel data python conveter in the mod.

Arguments:

  • width [ integer ] The width of the image.
  • height [ integer ] The height of the image.
  • path [ string ] The path of the image. Put example.json here to load a example image (256x256 image).
  • customSearch [ boolean ] If the path searching is custom or not.
Note!

When customSearch is enabled, the path is now a standard file path and doesnt have the ScrapComputers DisplayImages folder path prefix. This means you will have to provide a full file path such as "$CONTENT_<contentid>/".

takeSnapshot​

Display.takeSnapshot()

Updates the buffer that getPixel indexes.

Note!

This needs to happen as pixel data is only stored on the client, and syncing the display every tick with the server would be very computationally expensive. This means that it takes 1 game tick to update the buffer that getPixel indexes.

getDimensions​

Display.getDimensions()

Retrieves the dimensions of the display.

Returns:

  • [ number ] The width of the display.
  • [ number ] The height of the display.

getTouchData​

Display.getTouchData()

Retrieves touch data from the display.

Returns:

  • [ TouchData ] A table containing the latest touch data from the display.

getTouchTable​

Display.getTouchTable()

Retrieves touch table from the display.

Returns:

  • [ TouchTable ] A table containing all of the touch data from every player interacting with the display.

getOptimizationThreshold​

Display.getOptimizationThreshold()

Returns the displays optimization threshold.

Returns:

  • [ number ] The displays optimization threshold.

getId​

Display.getId()

Returns the displays shape ID.

getPixel​

Display.getPixel(x, y)

Gets the color of a pixel from the buffer that takeSnapshot updates at the coordinates specified.

Arguments:

  • x [ integer ] The x-coordinate.
  • y [ integer ] The y-coordinate.

Returns:

  • [ Color ] The color of the pixel.

setRenderDistance​

Display.setRenderDistance( distance )

Sets the render distance of the display.

Arguments:

  • distance [ number ] The render distance to set.

setOptimizationThreshold​

Display.setOptimizationThreshold( int )

This function sets the optimization threshold of the display. Our displays optimize the effect count by grouping similar-colored pixels together into one larger effect. The integer (ranging between 0 and 1) dictates how similar the neighboring pixels' colors have to be, with 0 requiring them to be exactly the same RGB value and 1 allowing any RGB value.

Arguments:

  • int [ number ] The optimization threshold to set.

clear​

Display.clear( color )

Clears the display with the specified color.

Arguments:

  • color [ Color|string? ] The color to clear the display with, in hexadecimal format (If nil, It will clear the screen with the default color).

update​

Display.update()

Updates the display.

autoUpdate​

Display.autoUpdate( bool )

Sets whether the display should automatically update.

Peformance note!

If you let's say draw a lot of things like rectangles, text, etc with this enabled. Your game would lag a LOT! And the network would be spammed with network requests!

So please only use this when you're not going to draw a lot and your display doesn't get updated a lot!

Arguments:

  • bool [ boolean ] True to enable auto-update, false to disable.

calcTextSize​

Display.calcTextSize( text )

Calculate the text's bounding box.

Arguments:

  • text [ string ] The text to calculate its size.

Returns:

  • [ number ] The width that the text would consume.
  • [ number ] The height that the text would consume.

calcASCFTextSize​

Display.calcASCFTextSize( fontName, text, fontSize, rotation )

Calculates text size, No error handling provided.

Arguments:

  • fontName [ string ] The name of the font.
  • text [ string ] The text.
  • fontSize [ number ] The size of the font.
  • rotation [ number? ] The rotation.

Returns:

  • [ number ] width The width the font consumes.
  • [ number ] hegiht The height the font consumes.

enableTouchScreen​

Display.enableTouchScreen( bool )

Enables or disables the touchscreen functionality.

Arguments:

  • bool [ boolean ] True to enable touch screen, false to disable.

hide​

Display.hide()

Hides the display.

show​

Display.show()

Shows the display.

setMaxBuffer​

Display.setMaxBuffer( int )

Sets the maximum ammount of itterations the displays draw buffer can do per tick.

Arguments:

  • int [ number ] The buffer size to be set.
Note!

Function depreciated

optimize​

Display.optimize()

This optimizes the display but more at the extreme bound.
Note!

Function depreciated