PLUG'N SCRIPT
rapid plugin development
Tutorial
DSP
KUIML
How-to
Scripts
  • Overview
  • Tutorial
  • Reference
Layout and positioning
  • CELL
  • TABLE
Language basics
  • SKIN
  • DUMMY
  • INCLUDE
  • INCLUDE_ONCE
  • DEFINE
  • UNDEFINE
  • VARIABLE
  • LOCAL_VARIABLE
  • TEMPLATE
  • TEMPLATE_INNER_CONTENT
  • TEMPLATE_UNLOAD
  • REPEAT
Text widgets
  • TEXT
  • TEXT_FIELD
  • TEXT_EDIT_BOX
  • TOOLTIP
  • PARAM_TEXT
  • PARAM_TEXT_CONTROL
  • PARAM_TEXT_EDIT_BOX
  • PARAM_TOOLTIP
Image widgets
  • IMAGE
  • IMAGE_ACTION_BUTTON
  • IMAGE_GROUP_BOX
  • IMAGE_PARAM_BUTTON
  • IMAGE_PARAM_KNOB
  • IMAGE_PARAM_LINEAR_METER
  • IMAGE_PARAM_MENU_BUTTON
  • IMAGE_PARAM_METER
  • IMAGE_PARAM_SLIDER
  • IMAGE_PARAM_TOGGLE_SWITCH
  • XYZ_IMAGE_PARAM_JOYSTICK
Invisible controls
  • INVISIBLE_ACTION_BUTTON
  • INVISIBLE_PARAM_BUTTON
  • INVISIBLE_PARAM_KNOB
  • INVISIBLE_PARAM_MENU_BUTTON
  • INVISIBLE_PARAM_SLIDER
  • INVISIBLE_PARAM_TOGGLE_SWITCH
  • XY_PARAM_PAD
  • XY_ZOOM_SELECT_PAD
  • XYZ_PARAM_SCRATCH_PAD
  • XYZ_PARAM_CLICK_PAD
Drawing, curves & 3D
  • CANVAS
    • Graphics API
  • svg
  • CURVE_GRAPH
  • XY_CURVES_GRAPH
  • GRID
  • RULER
  • COLOR_SCALE
  • VIEW_3D
  • COLOR_SURFACE_3D
  • GRID_3D
  • GL_OBJECT_3D
    • OpenGL Cheat Sheet
  • SURFACE_COLORMAP_2DPLOT
Miscellaneous
  • SCRIPT
  • WIDGET
  • KUIML_WIDGET
  • POPUP_MENU
  • MENU_ITEM
  • MENU_SEPARATOR
  • FILE_SELECT_MENU
  • SYSTEM_ACTION_BUTTON
  • SYSTEM_PARAM_CHECKBOX
  • SYSTEM_PARAM_DROPDOWN_LIST
  • WINDOW
  • LOAD_FONT
Data model
  • STRING
  • PARAM
  • FORMULA_PARAM
  • PARAM_ANIMATOR
  • ACTION
    • Built-in action types
  • TIMER
  • ACTION_TRIGGER
  • CURVE
  • FORMULA_CURVE
  • CURVE_FROM_PARAM_OVER_TIME
  • SURFACE
  • FORMULA_SURFACE
  • SURFACE_FROM_CURVE_OVER_TIME
  • GROUP
Links and commands
  • PARAM_LINK
  • PARAM_MULTI_LINK
  • PARAM_CONNECTION
  • PARAM_TO_STRING_LINK
  • STRING_LINK
  • STRING_MULTI_LINK
  • CURVE_LINK
  • CURVE_MULTI_LINK
  • SURFACE_LINK
  • REQUIRED_OBJECTS
  • EXPOSED_OBJECTS
  • PERSISTENT_OBJECTS
Common attrubutes
  • For all elements
  • Widgets
  • Param Widgets
  • Param Controls
  • Param Info Viewers
  • Text Widgets
  • Surface Viewers
  • Curve Viewers
  • Images
  • 3D Objects
Additional information
  • All attributes
  • Attribute types
  • Cursors
  • Math formulas
  • Scripting
    • Built-in addons
  • User experience
  • Errors and solutions
  • Built-in variables
  • Runtime model
  • Parameters mapping
  • Script converter
  • LetiMix
KUIMLReferenceACTION
September 01, 2025

ACTION

This element represents an action that can be triggered by the end user with an action button, or by other events, for example using the ACTION_TRIGGER element.

Attributes brief detailed show all inherited

Name Description
typeThe type of action to execute. See the available Action Types for more informationEach action type may use specific attributes.
nameDisplayed named of the action
commentComment about the action
Exposed: v. 1.9.1enabledactivation status of the actionIf disabled, the action will not execute
Common attributesRead about `common`
idIdentifier of the elementThe id of an element has to be globally unique. Don't start with a digit for AngelScript compatibility.
Name Value type Default Description Comment
typeaction typeemptyThe type of action to execute. See the available Action Types for more informationEach action type may use specific attributes.
namestringemptyDisplayed named of the action
commentstringemptyComment about the action
Exposed: v. 1.9.1enabledbooleanemptyactivation status of the actionIf disabled, the action will not execute
Common attributesRead about `common`
ididentifieremptyIdentifier of the elementThe id of an element has to be globally unique. Don't start with a digit for AngelScript compatibility.

Examples

The following action runs a script that increases the variable each time it is executed and updates a string.

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

  8. <!-- add a script variable -->
  9. <SCRIPT script="int run_count = 0;" />

  10. <!-- string to output results -->
  11. <STRING id="out_string" default="" />
  12. <TEXT_FIELD width="300" string_id="out_string" />

  13. <!-- a simple button -->
  14. <SYSTEM_ACTION_BUTTON action_id="run_my_script" width="180" />

Different action types allow you to open file dialogs, open URLs in browser, open files with standalone apps (including running batch/bash/misc scripts with terminal or command line), open folder dialogs in Finder/Explorer, display message boxes, save and open data (objects) to files, copy and paste data to/from clipboard, and certainly run AngelScript code in the GUI.

Check out a full list of action types and examples.

Built-in actions

KUIML exposes several built-in actions that can be helpful if you're developing your own skin from scratch.

Some of built-in actions

Name Description
OpenMenuOpens the main plug-in menu.
OpenPresetsMenuOpens the plug-in presets menu.
DisplayAboutDisplays the "About Box" window.
OpenManualOpens the plug-in manual.
UndoTriggers Undo.
RedoTriggers Redo.
Name Description
OpenMenuOpens the main plug-in menu.
OpenPresetsMenuOpens the plug-in presets menu.
DisplayAboutDisplays the "About Box" window.
OpenManualOpens the plug-in manual.
UndoTriggers Undo.
RedoTriggers Redo.

See the full list of available built-in actions. 

These actions can be used to make your own skin from scratch. You can run them via ACTION_TRIGGER, via IMAGE_ACTION_BUTTON, via SYSTEM_ACTION_BUTTON or via script. 

Simple example

  1. <!-- open main menu -->
  2. <SYSTEM_ACTION_BUTTON action_id="OpenMenu" width="180" />

Built-in action types

These action types can help you create various actions:

  1. <!-- run a script -->
  2. <ACTION id="my_action" type="Script" script="..." />

  3. <!-- run a sequence of actions -->
  4. <ACTION id="my_action" type="Sequence" action_ids="action1;action2" />

  5. <!-- copy object to/from clipboard or file -->
  6. <ACTION id="my_action" type="CopyObject" object_id="..." ... />
  7. <ACTION id="my_action" type="PasteObject" object_id="..." ... />
  8. <ACTION id="my_action" type="LoadObject" object_id="..." ... />
  9. <ACTION id="my_action" type="SaveObject" object_id="..." ... />

  10. <!-- open file and folder dialogs -->
  11. <ACTION id="my_action" type="OpenDirectory" url="..." ... />
  12. <ACTION id="my_action" type="DisplayFileOpenDialog" ... />
  13. <ACTION id="my_action" type="DisplayFileSaveDialog" ... />
  14. <ACTION id="my_action" type="DisplayFolderSelectDialog" ... />

  15. <!-- open url or a file, run an app -->
  16. <ACTION id="my_action" type="OpenUrl" url="..." ... />

  17. <!-- load url or a file via http or https -->
  18. <ACTION id="my_action" type="LoadUrl" ... />

  19. <!-- display message box -->
  20. <ACTION id="my_action" type="DisplayMessageBox" message="..." ... />

  21. <!-- related to making a custom skin -->
  22. <ACTION id="my_action" type="DisplayPlugNScriptMenu" ... />
  23. <ACTION id="my_action" type="ExportPlugNScriptPlugin" ... />
  24. <ACTION id="my_action" type="GeneratePlugNScriptGUID" ... />

Check out the page about Action types with examples.


Comments

Please, authorize to view and post comments.

2020 - 2025 © Site by LetiMix · Donate  |  Plug'n Script and KUIML by Blue Cat Audio