{"id":249,"date":"2017-12-23T21:18:28","date_gmt":"2017-12-23T21:18:28","guid":{"rendered":"http:\/\/www.wieringsoftware.com\/ts2\/?page_id=249"},"modified":"2022-09-19T15:35:13","modified_gmt":"2022-09-19T15:35:13","slug":"scripting","status":"publish","type":"page","link":"https:\/\/www.wieringsoftware.com\/ts2\/learn\/scripting\/","title":{"rendered":"Scripting"},"content":{"rendered":"

Tile Studio II has support for LUA scripting. You can add scripts to your project and set them up to run when you press a function key (F1 – F12). Here is a little example of a script:<\/p>\n

-- MENU_ITEM: PerlinNoise [F7]\r\n\r\nfunction PerlinNoise()\r\n  NoiseSeed(123);\r\n  ModifyBuffer(f);\r\nend\r\n\r\nfunction f(x, y, w, h, bp)\r\n  bp.Offset = 20 * Noise2(x\/5, y\/5) - 10;\r\n \u00a0bp.Alpha = 255;\r\n  return bp;\r\nend<\/pre>\n
The function ModifyBuffer<\/em> calls the given function f<\/em> for every pixel of the buffer, NoiseSeed<\/em> and Noise2<\/em> are functions provided by Tile Studio II. Running this function gives the following Perlin Noise pattern:<\/p>\n
\"\"<\/p>\n
Most functions will look similar to the one above. The function f provides a value for every pixel, which can depend on the position (x, y), the size of the tile (w, h) and the value of the original pixel in the buffer (bp).<\/p>\n
Pixels are represented as a Gradient (0 = first, 1 = second, etc), Offset (0 = center, -1 = one entry to the left, 1 = one entry to the right, etc., and Alpha (0 = fully transparent, 255 = fully opaque).<\/p>\n
You can use the log<\/em> function to show debug information, that will be shown on the console window, for example:<\/p>\n
log(\"a=\", a);<\/pre>\n
Here is another example script, this one creates a circular gradient:<\/p>\n
-- MENU_ITEM: CircularGradient [F4]\r\n\r\nfunction CircularGradient()\r\n  ModifyBuffer(CG);\r\nend\r\n\r\nfunction CG(x, y, w, h, bp)\r\n  bp.Alpha = 255;\r\n  local xx = 0.5*w-0.5-x;\r\n  local yy = 0.5*h-0.5-y;\r\n  local aa = 5*(xx\/w * xx\/w) + 3*(xx\/w * xx\/w);\r\n  local bb = 5*(yy\/h * yy\/h) + 3*(yy\/h * yy\/h);\r\n  bp.Offset = 5 - 2.5*(aa+bb);\r\n  if (bp.Offset < 0) then\r\n    bp.Offset = 0;\r\n  end\r\n  return bp;\r\nend<\/pre>\n
This produces the following result:<\/p>\n
\"\"
\n<\/p>\n
Export scripts use the function GetExportData()<\/em>, which generates a structure containing the bitmaps, maps and layers that can be exported. Here is an example of an export script:<\/p>\n
-- MENU_ITEM: Export [F10]\r\n\r\nfunction Export()\r\n\u00a0 local prj = GetExportData();\r\n\u00a0 for i = 0, prj.TilesheetCount - 1, 1 do\r\n    ts = prj.Tilesheets[i];\r\n    log(ts.Name);\r\n    prj.Tilesheets[i]:SaveImage(\"ts_\" .. ts.Name .. \".png\");\r\n  end;\r\n  for i = 0, prj.MapCount - 1 do\r\n    map = prj.Maps[i];\r\n    log(map.Name);\r\n    for j = 0, map.LayerCount - 1 do\r\n      layer = map.Layers[j];\r\n      layer:Export(\"lyr_\" .. layer.Name .. \".txt\", \"[[\", \",\", \"],\\n[\", \"]]\");\r\n    end;\r\n  end;\r\nend;<\/pre>\n
This script calls the Tilesheets.SaveImage<\/em> and Layers.Export<\/em> functions to save the bitmaps and the map data. The location where the files will be saved depends on your projects active configuration (OutputPath<\/em>).<\/p>\n
More examples and the complete structure of ExportData<\/em> should be available soon.<\/p>\n
The following is only available in the Indie and Pro version<\/em><\/span><\/p>\n
In the Tile Designer, you can use the Code<\/em> property to use scripting to modify your tiles. Here is an example, the following map only uses one tile and all edges are done by scripting:<\/p>\n
\"\"<\/p>\n
\"\"<\/p>\n
Here is the script:<\/p>\n
-- adjust these for amount of light\/shadow\r\n\r\nlocal amount_x = 1.0;\r\nlocal amount_y = -1.0;\r\n\r\n-- use with 3x3 tiles\r\n\r\nlocal corners = 0;\r\nfunction OuterEdges()\r\n  corners = 0;\r\n  ModifyBuffer(ChangeEdges);\r\nend;\r\n\r\n-- use with 2x2 tiles\r\n\r\nfunction InnerCorners()\r\n  corners = 1;\r\n  ModifyBuffer(ChangeEdges);\r\nend;\r\n\r\nfunction f(x, y, a, b)\r\n  r = (a + b) \/ 2;\r\n  if (x < y) then r = a; end;\r\n  if (x > y) then r = b; end;\r\n  return r;\r\nend;\r\n\r\nfunction ChangeEdges(x, y, w, h, bp)\r\n  top = 0;\r\n  left = 0;\r\n  right = 0;\r\n  bottom = 0;\r\n\r\n  if (group_y == 0) then top = 1; end;\r\n  if (group_x == 0) then left = 1; end;\r\n  if (group_x == group_w - 1) then right = 1; end;\r\n  if (group_y == group_h - 1) then bottom = 1; end;\r\n\r\n  dx = (x - w \/ 2) \/ 3;\r\n  dy = (y - h \/ 2) \/ 3;\r\n  ex = 0;\r\n  ey = 0;\r\n\r\n  if (corners == 1) then\r\n    if (top + left == 2) and (dx > 0) and (dy > 0) then\r\n      a = Math.Min(Math.Abs(dx), Math.Abs(dy));\r\n      bp.Offset = bp.Offset + f(x, y, amount_x * a, amount_y * a);\r\n    end;\r\n    if (top + right == 2) and (dx < 0) and (dy > 0) then\r\n      a = Math.Min(Math.Abs(dx), Math.Abs(dy));\r\n      bp.Offset = bp.Offset + f(w - 1 - x, y, amount_x * a, amount_y * a);\r\n    end;\r\n    if (bottom + left == 2) and (dx > 0) and (dy < 0) then\r\n      a = Math.Min(Math.Abs(dx), Math.Abs(dy));\r\n      bp.Offset = bp.Offset + f(x, h - 1 - y, amount_x * a, amount_y * a);\r\n    end;\r\n    if (bottom + right == 2) and (dx < 0) and (dy < 0) then\r\n      a = Math.Min(Math.Abs(dx), Math.Abs(dy));\r\n      bp.Offset = bp.Offset + f(w - 1 - x, h - 1 - y, amount_x * a, amount_y * a);\r\n    end;\r\n  else\r\n    if (top == 1) and (dy < 0) then\r\n      ey = h \/ (y + 1 + 1) - bp.Offset;\r\n      bp.Offset = bp.Offset - amount_y * (dy + ey \/ h);\r\n    end; \r\n    if (left == 1) and (dx < 0) then\r\n      ex = w \/ (x + 1 + 1) - bp.Offset;\r\n      bp.Offset = bp.Offset - amount_x * (dx + ex \/ w);\r\n    end; \r\n    if (right == 1) and (dx > 0) then\r\n      ex = w \/ (w - x + 1) - bp.Offset;\r\n      bp.Offset = bp.Offset + amount_x * (dx + ex \/ w);\r\n    end;\r\n    if (bottom == 1) and (dy > 0) then\r\n      ey = h \/ (h - y + 1) - bp.Offset;\r\n      bp.Offset = bp.Offset + amount_y * (dy + ey \/ h);\r\n    end;\r\n  end;\r\n\r\n  if (ex > w \/ 2 or ey > h \/ 2) then\r\n    bp.Alpha = 0;\r\n  end;\r\n\r\n  return bp;\r\nend<\/pre>\n
In the tilesheet we place our one tile everywhere, but after setting up the script it looks like this:<\/p>\n
\"\"<\/p>\n
The 3 x 3 selected tiles here have the property Code<\/em> set to OuterEdges();<\/strong>\u00a0and the 2 x 2 tiles at the right have InnerCorners();<\/strong><\/p>\n
To make it work properly, the code needs to know what the function is of each of the tiles. For that we have the GroupPos<\/em> and GroupSize<\/em> properties. The left part has 3×3 as size and the right part 2×2. Each tile has it’s own index (0,0), (0,1), … (2,2). This is automatically set up every time you make a selection like this and copy properties to all tiles in the designer.<\/p>\n
After having this set up, you can easily add new grounds by only drawing one new tile.<\/p>\n
 <\/p>\n","protected":false},"excerpt":{"rendered":"
Tile Studio II has support for LUA scripting. You can add scripts to your project and set them up to run when you press a function key (F1 – F12). Here is a little example of a script: — MENU_ITEM: … Continue reading →<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"parent":37,"menu_order":90,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"_links":{"self":[{"href":"https:\/\/www.wieringsoftware.com\/ts2\/wp-json\/wp\/v2\/pages\/249"}],"collection":[{"href":"https:\/\/www.wieringsoftware.com\/ts2\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.wieringsoftware.com\/ts2\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.wieringsoftware.com\/ts2\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.wieringsoftware.com\/ts2\/wp-json\/wp\/v2\/comments?post=249"}],"version-history":[{"count":15,"href":"https:\/\/www.wieringsoftware.com\/ts2\/wp-json\/wp\/v2\/pages\/249\/revisions"}],"predecessor-version":[{"id":423,"href":"https:\/\/www.wieringsoftware.com\/ts2\/wp-json\/wp\/v2\/pages\/249\/revisions\/423"}],"up":[{"embeddable":true,"href":"https:\/\/www.wieringsoftware.com\/ts2\/wp-json\/wp\/v2\/pages\/37"}],"wp:attachment":[{"href":"https:\/\/www.wieringsoftware.com\/ts2\/wp-json\/wp\/v2\/media?parent=249"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}