Skip to content

Commit

Permalink
- Removed redundant file that was kept as the wiki landing page
Browse files Browse the repository at this point in the history
> Rewrote preview scripts blurb
  • Loading branch information
jbunke committed Sep 2, 2024
1 parent 91459b3 commit 756bc18
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 9 deletions.
7 changes: 0 additions & 7 deletions Home.md

This file was deleted.

4 changes: 2 additions & 2 deletions scripting.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Type signature for automation scripts: `()` - (no parameters and void return)

### Preview scripts

[Preview scripts](preview-scripts.md) allow for the transformation of the contents of the preview window. By default, the preview window merely previews the contents of the project as they are. This can already be used in a variety of ways, but it is made exponentially more powerful with scripting.
[Preview scripts](preview-scripts.md) allow for creation of complex custom previews by transforming the flattened contents of the project that acts as input into original output. Since preview scripts are essentially a __*mapping*__, the contents of the preview window will change dynamically as the project that defines its input is modified, without having to reload the script.

Valid type signatures for preview scripts:
* `(image -> image)`
Expand All @@ -41,7 +41,7 @@ Type signature for color scripts: `(color -> color)`

### Child scripts

[Child scripts](child-scripts.md) are merely scripts that are run from within another script. Child scripts can have any file signature, but will trigger a runtime error if they are passed arguments that do not match the types of the parameters of their [header function](#syntax).
[Child scripts](child-scripts.md) are merely scripts that are run from within another script. Child scripts can have any type signature, but will trigger a runtime error if they are passed arguments that do not match the types of the parameters of their [header function](#syntax).

You may run scripts from within any script, but it is recommended *NOT to run child scripts from within preview or color scripts* for the sake of performance. Also in the interest of performance, it is optimal to declare any child scripts used in a script as `final` (also `~`) `script` variables outside any loops. This way, the child script will only be loaded once per its parent script's execution.

Expand Down

0 comments on commit 756bc18

Please sign in to comment.