Tutorial
DSP
KUIML
How-to
Scripts
KUIMLReferenceACTIONBuilt-in action types
September 04, 2025

Action types

The KUIML engine exposes the following built-in actions, to be used with the ACTION element.

General purpose

Script brief detailed show all inherited

Name Description
scriptThe script to be executed.
requiresList of objects expected by the script.

When triggered, executes a script. Useful to make your GUI more dynamic: with the script you can change many KUIML attributes on the fly, display and hide widgets, track keyboard and mouse state, etc.

Action type Script

  1. <!-- action that runs a script -->
  2. <ACTION id="run_my_script" type="Script"
  3. name="Run a demo script"
  4. script=" 
  5. string s = &quot;Script executed &quot;;
  6. run_count++;
  7. out_string = s + run_count + &quot; times&quot;; "
  8. requires="out_string;run_count" />

  10. <!-- add a script variable that action can access -->
  11. <SCRIPT script="int run_count = 0;" />

  13. <!-- string to output results -->
  14. <STRING id="out_string" default="Not executed" />
  15. <TEXT_FIELD width="300" string_id="out_string" />
  16. <CELL height="7" /> <!-- adds some vertical space -->

  18. <!-- a simple 'button' -->
  19. <WIDGET id="demo_button" background_color="#000088" text_color="#FFFFFF" >
  20. <TEXT value="Click me" width="100" height="40">
  21. <INVISIBLE_ACTION_BUTTON id="demo_inv_act_button" action_id="run_my_script" width="100%" height="100%" />
  22. </TEXT>
  23. </WIDGET>

  25. <!-- trick to make the button move slighly when the mouse is down -->
  26. <PARAM_MULTI_LINK from="demo_inv_act_button.mouse_down" to="demo_button.v_offset;demo_button.h_offset" />

We can use a SCRIPT element to add functions or variables that will be "global", or more precisely available to all ACTIONs within the current scope (current skin or current KUIML_WIDGET subskin).

Sequence brief detailed show all inherited

Name Description
action_idsList of actions to execute. The actions will be executed in order. Example: "DoStuff1;DoStuff2"

Executes a sequence of actions defined as a list of action identifiers.

  1. <!-- action to run a sequence of actions -->
  2. <ACTION id="sequence_action" type="Sequence" action_ids="action_1;action_2" name="Run a sequence" />

  4. <!-- actions that run a script -->
  5. <ACTION id="action_1" type="Script" name="Run a script 1"
  6. script="out_string = &quot;Script 1 executed. &quot;;" />
  7. <ACTION id="action_2" type="Script" name="Run a script 2"
  8. script="out_string += &quot;Script 2 executed. &quot;;" />

  10. <!-- string to output results -->
  11. <STRING id="out_string" default="Not executed" exposed="true" />
  12. <TEXT_FIELD width="300" string_id="out_string" />
  13. <CELL height="7" /> <!-- adds some vertical space -->

  15. <!-- button to execute an action -->
  16. <SYSTEM_ACTION_BUTTON action_id="sequence_action" width="200" />

System

CopyObject brief detailed show all inherited

Name Description
object_idIdentifier of the object to be stored into the clipboard.
applicative_typeOptional string to qualify the applicative use of the object.
copy_contextOptional string to define the serialization context used for the copy operation.

Copies the selected object into the system cliboard.

PasteObject brief detailed show all inherited

Name Description
object_idIdentifier of the object to be pasted from the clipboard.
applicative_typeOptional string to qualify the applicative use of the object.
paste_contextOptional string to define the serialization context used for the paste operation.

Pastes the contents of the system clipboard into the selected object.

Copying text to clipboard

  1. <!-- actions to copy/paste to clipboard-->
  2. <ACTION type="CopyObject"
  3. id="demo_CopyObject"
  4. object_id="demo_string"
  5. applicative_type="system::text"
  6. name="Copy to clipboard"
  7. />
  8. <ACTION type="PasteObject"
  9. id="demo_PasteObject"
  10. object_id="demo_string"
  11. applicative_type="system::text"
  12. name="Paste from clipboard"
  13. />

  15. <!-- add a demo string-->
  16. <STRING id="demo_string" default="Some text"/>
  17. <ROW margin="20">
  18. <TEXT_EDIT_BOX string_id="demo_string" width="300" />
  19. </ROW>

  21. <!-- display built-in system buttons -->
  22. <ROW>
  23. <SYSTEM_ACTION_BUTTON action_id="demo_CopyObject" width="150" />
  24. <SYSTEM_ACTION_BUTTON action_id="demo_PasteObject" width="170" />
  25. </ROW>

LoadObject brief detailed show all inherited

Name Description
object_idIdentifier of the object to be loaded.
file_path_string_idThe identifier of the string object where the path to the file is stored.
root_pathList of root directories for all paths, separated by ';'. Relative paths will be "absolutized" using these root paths until the file is found.
root_path_index_param_idundocumented
applicative_typeOptional string to qualify the applicative use of the object.
load_contextOptional string to define the serialization context used for the load operation.

Loads the content of a file into the selected object.

SaveObject brief detailed show all inherited

Name Description
object_idIdentifier of the object to be saved.
file_path_string_idThe identifier of the string object where the path to the file is stored.
root_pathList of root directories for all paths, separated by ';'. Relative paths will be "absolutized" using these root paths until the file can be saved.
applicative_typeOptional string to qualify the applicative use of the object.
save_contextOptional string to define the serialization context used for the save operation.

Saves the content of an object into a file.

Examples of saving and loading objects

With these four action types you can copy/paste or save/load values of parameters, strings and other objects (for example a "preset" within a section of a plugin). By combining string and parameters into a GROUP you can operate with all of them at once.

  1. <!-- actions to copy/paste, load/save objects -->
  2. <ACTION type="CopyObject"
  3. id="demo_CopyObject"
  4. object_id="demo_group"
  5. applicative_type=""
  6. copy_context=""
  7. name="Copy Object"
  8. />
  9. <ACTION type="PasteObject"
  10. id="demo_PasteObject"
  11. object_id="demo_group"
  12. applicative_type=""
  13. paste_context=""
  14. name="Paste Object"
  15. />
  16. <ACTION type="SaveObject"
  17. id="demo_SaveObject"
  18. object_id="demo_group"
  19. applicative_type=""
  20. file_path_string_id="demo_string_path"
  21. root_path=""
  22. root_path_index_param=""
  23. save_context=""
  24. name="Save Object"
  25. />
  26. <ACTION type="LoadObject"
  27. id="demo_LoadObject"
  28. object_id="demo_group"
  29. applicative_type=""
  30. file_path_string_id="demo_string_path"
  31. root_path=""
  32. load_context=""
  33. name="Load Object"
  34. />

  36. <!-- add some demo strings and parameters -->
  37. <STRING id="class" default="AmpSimulator"/>
  38. <STRING id="name" default="JCM-800" />
  39. <PARAM id="gain" min="0" max="12" default="10" />

  41. <!-- and put them into a group for easy save/load operation -->
  42. <!-- object_aliases attribute is optional -->
  43. <GROUP id="demo_group"
  44. object_ids="class;name;gain"
  45. object_aliases="the_class;the_name;the_gain"
  46. />

  48. <!-- now add some widgets to display data and buttons -->
  49. <WIDGET layout_type="row" spacing="10" background_color="#DDEEFF" margin="20" >
  50. <TEXT_EDIT_BOX string_id="class" width="110" />
  51. <TEXT_EDIT_BOX string_id="name" width="110" />
  52. <PARAM_TEXT_CONTROL param_id="gain"/>
  53. </WIDGET>

  55. <CELL height="20" /> <!-- add some vertical space -->

  57. <!-- display built-in system buttons -->
  58. <ROW>
  59. <SYSTEM_ACTION_BUTTON action_id="demo_CopyObject" width="150" />
  60. <SYSTEM_ACTION_BUTTON action_id="demo_PasteObject" width="150" />
  61. </ROW>
  62. <CELL height="10" /> <!-- add some vertical space -->
  63. <ROW>
  64. <SYSTEM_ACTION_BUTTON action_id="demo_SaveObject" width="150" />
  65. <SYSTEM_ACTION_BUTTON action_id="demo_LoadObject" width="150" />
  66. </ROW>

  68. <CELL height="10" /> <!-- add some vertical space -->

  70. <!-- string with filename to save object to -->
  71. <STRING id="demo_string_path" default="$_DIR_$test_SaveObject.txt" />
  72. <TEXT_FIELD string_id="demo_string_path" width="300" text_h_align="right" />

If you open the file where the object was saved to, you'll see something like this:

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <Export applicative_type="" data_type="{0779F8E6-34E0-4DA5-9307-ECC37BE0FA8A}">
  3. <content the_gain="10" the_name="JCM-900" the_class="AmpSim"/>
  4. </Export>

Note on "_context" attribute

It may have the same values as the persistence_context (see PARAM), or custom values, but that's not used yet. The idea is to make sure of what is saved. So if you have for example some data that has persistence_context="-Init" and in the copy_context you put "Init" then this data will not be saved. It just defines the saving/loading context. You could use your own keywords on both sides in fact.

OpenDirectory brief detailed show all inherited

Name Description
urlThe location of the file to open.
url_string_idIdentifier of the string object containing the file to open.

Open the directory containing the selected file in the file explorer of the system (Explorer on Windows and the Finder Mac).

  1. <!-- open directory -->
  2. <ACTION type="OpenDirectory"
  3. id="demo_OpenDirectory"
  4. url="$PLUGIN_DATA_PATH$"
  5. _url_string_id="can_use_string_id_instead_of_static_url"
  6. name="Open directory"
  7. />

  9. <!-- display a button -->
  10. <SYSTEM_ACTION_BUTTON action_id="demo_OpenDirectory" width="150" />

OpenUrl brief detailed show all inherited

Name Description
urlThe location of the resource to open.
url_string_idIdentifier of the string object containing the file url to open.
applicationName of the application to use to open the file.
application_string_idIdentifier of the string object containing the name of the application to use.
root_pathList of root directories for all paths, separated by ';'. Relative paths will be "absolutized" using these root paths until the file is found.

Open the selected url (may be a local file path or a web url) using the system shell.

  1. <!-- open URL in browser -->
  2. <ACTION type="OpenUrl" id="demo_OpenURL"
  3. url="https://www.letimix.com/"
  4. name="Open url"
  5. />

  7. <!-- open current file in Finder -->
  8. <ACTION type="OpenUrl" id="demo_OpenFileInFinder"
  9. url="$_FILE_$"
  10. _url_string_id="can_use_string_id_instead"
  11. application="Finder"
  12. _application_string_id="can_use_string_id_instead"
  13. name="Open file in Finder"
  14. />

  16. <!-- run a batch file on Windows -->
  17. <ACTION type="OpenUrl" id="demo_RunBatchFileOnWin"
  18. application="C:/Scripts/file.bat"
  19. url='"param 1" param2 "param 3"'
  20. name="Run batch file on Windows"
  21. />

  23. <!-- run bash script in Mac terminal -->
  24. <ACTION type="OpenUrl" id="demo_RunScriptInMacTerminal"
  25. url='/path/to/bash_script.sh" --env MY_VAR1="value123" -n -F --args "'
  26. application="Terminal"
  27. name="Run script in Mac Terminal"
  28. />

  30. <!-- display buttons -->
  31. <SYSTEM_ACTION_BUTTON action_id="demo_OpenURL" width="150" />
  32. <SYSTEM_ACTION_BUTTON action_id="demo_OpenFileInFinder" width="150" />
  33. <SYSTEM_ACTION_BUTTON action_id="demo_RunBatchFileOnWin" width="250" />
  34. <SYSTEM_ACTION_BUTTON action_id="demo_RunScriptInMacTerminal" width="250" />

As you can see this OpenURL action type is quite powerful. You can open documents and run various apps with it. On Windows you can execute a .bat file by simply passing it as an "application" name, and parameters in "url".

On Mac we have to use a trick to run a script in the Terminal. Here OpenURL seems to be executed like: open -a "application" "url". Using extra double quotes we can inject attributes to the command and add environmental variable to pass data to the bash script.

LoadUrl (experimental) brief detailed show all inherited

Name DescriptionDefault
url_string_idIdentifier of the string object containing the file url to open.empty
response_body_string_idOptional identifier of the string object to receive the content of the url.empty
response_headers_string_idOptional identifier of the string object to receive the http headers returned by the server.empty
response_file_path_idOptional identifier of the string object containing the file path to receive the content returned by the server (file download).empty
response_url_string_idOptional identifier of the string object to get the actual url (that may be different from the original url in case of redirects).empty
response_status_param_idOptional identifier of the parameter object to receive the http status returned by the server.empty
cancel_event_idOptional identifier of the event that cancels the request when fired.empty
follow_redirectsCan be used to disable redirections - redirect may be handled manually by inspecting the received headers.true
progress_param_idOptional id of param to hold progress valueempty
max_progress_param_idOptional id of param to hold progress max valueempty
threadedSet to 'false' to make action not threaded (meaning the GUI will freeze till it's finished)true
timeout_secondsHow much to wait for the action to finish
Read-only
runningYou can check this param (.value_changed event) to see if action was finished

Download the selected url (web url only) into a string or file asynchronously (not blocking). Supports http and https protocols. Currently experimental and may be modified in the future. Error handling is currently minimal.

  1. <!-- LoadURL action -->
  2. <ACTION id="TestLoadUrl" type="LoadURL" name="Do LoadURL"
  3. url_string_id="request_url"
  4. response_url_string_id="response_url"
  5. response_headers_string_id="response_headers"
  6. response_body_string_id="response_body"
  7. response_status_param_id="response_code"
  8. response_file_path_id="response_file_save_to"
  9. cancel_event_id="cancel_loadurl.value_changed"
  10. progress_param_id="progress_loadurl"
  11. max_progress_param_id="progress_loadurl.max"
  12. follow_redirects="true"
  13. threaded="true"
  14. timeout_seconds="30" />

  16. <!-- strings and params used in LoadURL -->
  17. <STRING id="request_url" default="https://bluecataudio.com/"/>
  18. <STRING id="response_url" />
  19. <STRING id="response_headers" />
  20. <STRING id="response_body" />
  21. <STRING id="response_file_save_to" default="$_USER_DOCUMENTS_PATH_$/tempfile.bin" />
  22. <PARAM id="response_code" max="1000" />
  23. <PARAM id="progress_loadurl" max="0" />
  24. <PARAM id="cancel_loadurl" max="$_PARAM_MAX_$" />
  25. <ACTION id="do_cancel_loadurl" name="Cancel" type="Script" script="cancel_loadurl+=rand(-10,10);" requires="cancel_loadurl" />

  27. <!-- now start the layout -->

  29. <!-- include textwidget to output multiline data (LM Skin only) -->
  30. <INCLUDE file="$EXTENSIONS_DIR$tw.inc" />

  32. <COLUMN width="700">
  33. <!-- first line with url and load/cancel buttons -->
  34. <ROW width="100%" spacing="10" v_margin="4">
  35. <!-- text input for url -->
  36. <TW_INPUT string_id="request_url" multiline="false" width="50%" h_align="left" string_update_mode="always" />
  37. <!-- buttons and "running" status -->
  38. <ROW flex="1" spacing="10" h_align="left" internal_h_align="left" font_size="11">
  39. <SYSTEM_ACTION_BUTTON action_id="TestLoadUrl" width="120" />
  40. <SYSTEM_ACTION_BUTTON action_id="do_cancel_loadurl" width="90" />
  41. <PARAM_TEXT param_id="TestLoadUrl.running" content="Running: {value}" value_format="0.0" />
  42. </ROW>
  43. </ROW>
  44. <!-- second line with response url, response code and progress info -->
  45. <ROW width="100%" spacing="10" v_margin="4">
  46. <!-- text input for response url (in case of auto-redirects) -->
  47. <TW_INPUT string_id="response_url" multiline="false" width="50%" h_align="left" edit="false" select="true" style="bg_color: #EEEEEE;" />
  48. <!-- additional info (response code, progress) -->
  49. <ROW flex="1" spacing="10" h_align="left" internal_h_align="left" font_size="11">
  50. <PARAM_TEXT param_id="response_code" content="Response code: {value}" value_format="0.0" />
  51. <PARAM_TEXT param_id="progress_loadurl" content="Progress: {value} of {max}" value_format="0.0" />
  52. </ROW>
  53. </ROW>
  54. <!-- text area with response headers (light blue background) -->
  55. <TW_LOG string_id="response_headers" height="100" style="bg_color: #EEFFFF;" />
  56. <!-- text area with main body response (yellow background) -->
  57. <TW_LOG string_id="response_body" height="150" style="bg_color: #FFFFEE;"/>
  58. <!-- text input to set filepath for saving binary/img/non-text data -->
  59. <TW_INPUT string_id="response_file_save_to" multiline="false" width="100%" h_align="left" string_update_mode="always" />
  60. </COLUMN>

User interface

DisplayFileOpenDialog brief detailed show all inherited

Name DescriptionDefault
titleTitle of the dialog box.empty
file_path_string_idThe identifier of the string object where the chosen file path should be stored.empty
file_name_string_idString_id to get base file name without the extension and pathempty
file_typeswildcards list (semi-column separated) for file types accepted by the open dialog.*.*
open_bundleson Mac, when set to true, the end user can browse inside bundles.false
default_pathdefault path (directory or file) to open if no file is already selected in the string pointed by file_path_string_id.empty
root_pathList of root directories for all paths, separated by ';'. Paths relative to one of these directories will be truncated and stored as relative sub-paths.empty
root_path_index_param_idParam_id to receive index of the root_path that was used.empty
applicative_typeOptional string to qualify the applicative use of the object.empty
result_param_idParam_id to keep the result of operation: 0 - not opened, 1 - openedempty

Opens a standard system "file open" dialog box.

Simple example

  1. <!-- action to execute file open dialog -->
  2. <ACTION type="DisplayFileOpenDialog"
  3. id="demo_DisplayFileOpenDialog"
  4. title="Select *.txt file"
  5. file_path_string_id="path_to_selected_file"
  6. file_types="*.txt"
  7. open_bundles="false"
  8. default_path=""
  9. name="Open file (dialog)"
  10. />

  12. <!-- string to receive file path -->
  13. <STRING id="path_to_selected_file" />

  15. <!-- display a button -->
  16. <SYSTEM_ACTION_BUTTON action_id="demo_DisplayFileOpenDialog" width="150" />

  18. <!-- display result -->
  19. <TEXT_FIELD string_id="path_to_selected_file" width="200" />

Complex example

  1. <!-- action to execute file open dialog -->
  2. <ACTION type="DisplayFileOpenDialog"
  3. id="demo_DisplayFileOpenDialog"
  4. title="Select *.txt or *.pdf file"
  5. file_path_string_id="file_path"
  6. file_name_string_id="file_basename"
  7. file_types="*.txt;*.pdf"
  8. open_bundles="true"
  9. default_path=""
  10. root_path="/Volumes/A2/1;/Volumes/A2/2"
  11. root_path_index_param_id="selected_root_index"
  12. result_param_id="result"
  13. name="Open file (dialog)"
  14. />

  16. <!-- strings to receive file path and base name -->
  17. <STRING id="file_path" />
  18. <STRING id="file_basename" />

  20. <!-- params to receive selected root path index and result -->
  21. <PARAM id="selected_root_index" max="100" min="-1" default="-1" />
  22. <PARAM id="result" max="1" min="-1" default="-1" />

  24. <!-- display a button -->
  25. <SYSTEM_ACTION_BUTTON action_id="demo_DisplayFileOpenDialog" width="150" />

  27. <!-- display result strings and params -->
  28. <TEXT_FIELD string_id="file_path" width="200" />
  29. <TEXT_FIELD string_id="file_basename" width="200" />
  30. <PARAM_TEXT param_id="result" content="result: {value}"/>
  31. <PARAM_TEXT param_id="selected_root_index" content="root_index: {value}"/>

DisplayFileSaveDialog

Opens a standard system "file save" dialog box. Same as DisplayFileOpenDialog, except that the selected file path is not required to exist.

  1. <!-- action to execute file save dialog -->
  2. <ACTION type="DisplayFileSaveDialog"
  3. id="demo_DisplayFileSaveDialog"
  4. title="Choose file to save"
  5. file_path_string_id="file_path"
  6. file_name_string_id="file_basename"
  7. file_types="*.txt"
  8. open_bundles="true"
  9. default_path="$PLUGIN_DATA_PATH$/Skins"
  10. result_param_id="result"
  11. name="Save file (dialog)"
  12. />

  14. <!-- strings to receive file path and base name -->
  15. <STRING id="file_path" />
  16. <STRING id="file_basename" />

  18. <!-- param to receive result (1 - ok, 0 - not) -->
  19. <PARAM id="result" max="1" min="-1" default="-1" />

  21. <!-- display a button -->
  22. <SYSTEM_ACTION_BUTTON action_id="demo_DisplayFileSaveDialog" width="150" />

  24. <!-- display result strings and params -->
  25. <TEXT_FIELD string_id="file_path" width="200" />
  26. <TEXT_FIELD string_id="file_basename" width="200" />
  27. <PARAM_TEXT param_id="result" content="result: {value}"/>

DisplayFolderSelectDialog brief detailed show all inherited

Name Description
file_path_string_idThe identifier of the string object where the chosen file path should be stored.
root_pathList of root directories for all paths, separated by ';'. Paths relative to one of these directories will be truncated and stored as relative sub-paths.

Opens a standard system dialog to select a folder.

  1. <!-- action to execute folder select dialog -->
  2. <ACTION type="DisplayFolderSelectDialog"
  3. id="demo_DisplayFolderSelectDialog"
  4. file_path_string_id="file_path"
  5. root_path="/Volumes/A2/"
  6. name="Select folder (dialog)"
  7. />

  9. <!-- strings to receive file path and base name -->
  10. <STRING id="file_path" />

  12. <!-- display a button -->
  13. <SYSTEM_ACTION_BUTTON action_id="demo_DisplayFolderSelectDialog" width="180" />

  15. <!-- display result strings and params -->
  16. <TEXT_FIELD string_id="file_path" width="200" />

DisplayMessageBox brief detailed show all inherited

Name DescriptionDefault
titleTitle of the dialog box.empty
messagemessage to be displayed in the message box.empty
styletype of the system message box (info, warning, error, none)none
timeoutThe timeout specifies the number of milliseconds before the message box disappears.-1
button0Name of the first button.Ok
button1Name of the second button.empty
button2Name of the third button.empty
button3Name of the fourth button.empty
buttonX_action_idAction to be executed when the user clicks on button Xempty
close_buttonaction of the window close button (Windows only)empty
result_param_ididentifier of a parameter where the result (Clicked button number) should be storedempty

Opens a standard system message box.

Examples of message box

  1. <!-- a simple message box -->
  2. <ACTION type="DisplayMessageBox"
  3. id="demo_DisplayMessageBox"
  4. title="Hello there"
  5. message="This goes away in 2 seconds"
  6. name="Simple message"
  7. timeout="2"
  8. />

  10. <!-- a message box with options -->
  11. <ACTION type="DisplayMessageBox"
  12. id="demo_DisplayMessageBoxExtended"
  13. title="Hello there"
  14. message="There was an error. What to do?"
  15. style="error"
  16. timeout="-1"
  17. button0="Nothing"
  18. button1="Fix it"
  19. button2="Display simple one"
  20. button3="Ignore"
  21. close_button="button3"
  22. result_param_id="msg_box_result"
  23. button2_action_id="demo_DisplayMessageBox"
  24. name="With buttons"
  25. />

  27. <!-- display built-in system buttons -->
  28. <ROW>
  29. <SYSTEM_ACTION_BUTTON action_id="demo_DisplayMessageBox" width="150" />
  30. <SYSTEM_ACTION_BUTTON action_id="demo_DisplayMessageBoxExtended" width="150" />
  31. </ROW>

  33. <!-- add a parameter to keep chosen button -->
  34. <PARAM id="msg_box_result" min="-1" max="100" default="-1" />
  35. <ROW margin="20">
  36. <PARAM_TEXT param_id="msg_box_result" content="result: {value}" />
  37. </ROW>

As you see, there are some options can customize for the message box. Yet there's no option for string_id (to change the text on the fly), but it may be added in the future.

Plug'n Script related

These action types can be used for creating your own skin for Plug'n Script.

DisplayPlugNScriptMenu brief detailed show all inherited

Name Description
script_file_name_string_idThe identifier of the string object where the filename of the selected script is stored.

Displays script selection menu.

  1. <!-- open script selection menu -->
  2. <ACTION type="DisplayPlugNScriptMenu"
  3. id="demo_DisplayPlugNScriptMenu"
  4. script_file_name_string_id="filename"
  5. name="Script selection menu"
  6. />

  8. <!-- display a button -->
  9. <SYSTEM_ACTION_BUTTON action_id="demo_DisplayPlugNScriptMenu" width="180" />

  11. <!-- string to keep the filename -->
  12. <STRING id="filename" />

  14. <!-- display selected file -->
  15. <TEXT_FIELD string_id="filename" width="350" />

  17. <!-- where the full path is stored -->
  18. <TEXT string_id="$script_file_path$" width="350" text_h_align="right" />
  19. <TEXT value="$script_file_path$" width="350" />

ExportPlugNScriptPlugin brief detailed show all inherited

Name Description
plugin_id_string_idString holding unique 4-chars plugin id (eg. 'ab41'), used for AU and VST2.
plugin_guid_string_idString holding unique 32-chars plugin guid, used for VST3.
plugin_name_string_idString holding the name of the plugin.
plugin_manufacturer_string_idString holding the name of the manufacturer
plugin_manufacturer_id_string_idString holding the unique 4-chars manufacturer id (eg. 'sup1'), used for AU.
dsp_file_string_idString holding the script file path (AngelScript or C++).
dest_folder_string_idString holding the folder name where to export the plugin(s).
use_generic_params_param_idParam holding '1' to export with generic param names and ranges.
use_generic_skin_param_idParam holding '1' if you don't want to export the skin.
plugin_type_param_idParam holding the type of a plugin (0 - AudioEffect, 1 - Instrument, 2 - MidiEffect)
enable_meters_param_idParam holding '1' to enable meters in the exported plugin (0 to lower CPU).
enable_encryption_param_idParam holding '1' if you want to encrypt AngelScript upon export.
result_param_idParam receiving the result of the export operation.
io_config_path_string_idString holding the selected I/O config for the plugin.
io_config_root_pathPath to the folder with I/O configs.
log_path_string_idString holding the export log.
temp_path_string_idString holding the temporary folder.

Executes export of the script as a separate plugin. To get the better understanding of the plugin export process you can examine BCA Skin or LM Skin.

  1. <ACTION type="ExportPlugNScriptPlugin"
  2. id="do_ExportPlugin"
  3. name="Build the plugin!"
  4. plugin_id_string_id="plugin_id"
  5. plugin_guid_string_id="plugin_guid"
  6. plugin_name_string_id="plugin_name"
  7. plugin_manufacturer_string_id="plugin_manufacturer"
  8. plugin_manufacturer_id_string_id="plugin_manufacturer_id"
  9. dsp_file_string_id="$script_file_path$"
  10. dest_folder_string_id="dest_path"
  11. use_generic_params_param_id="use_generic_params"
  12. use_generic_skin_param_id="use_default_gui"
  13. plugin_type_param_id="plugin_type"
  14. enable_meters_param_id="enable_meters"
  15. enable_encryption_param_id="encrypt_dsp_script"
  16. result_param_id="export_result"
  17. io_config_path_string_id="selected_io_config"
  18. io_config_root_path="$PLUGIN_DATA_PATH$/Resources/Settings/ioconfig"
  19. log_path_string_id="export_log_path"
  20. temp_path_string_id="export_temp_path"
  21. />

GeneratePlugNScriptGUID brief detailed show all inherited

Name Description
string_idThe identifier of the string object where the generated string would be stored.

Generates unique GUID string. Used for generating a unique ID for plugin when exporting, you can use it for other purposes as well.

  1. <!-- action to generate unique ID -->
  2. <ACTION type="GeneratePlugNScriptGUID"
  3. id="demo_GeneratePlugNScriptGUID"
  4. string_id="new_id"
  5. name="Generate GUID"
  6. />

  8. <!-- string to keep the generated id -->
  9. <STRING id="new_id" />

  11. <!-- display result -->
  12. <PARAM_TEXT param_id="new_id.length" content="length: {value} chars" value_format="0.0" />
  13. <TEXT_FIELD string_id="new_id" width="350" />

  15. <!-- display a button -->
  16. <SYSTEM_ACTION_BUTTON action_id="demo_GeneratePlugNScriptGUID" width="180" />

Comments

Please, authorize to view and post comments.