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
KUIMLReferenceAttribute types
July 19, 2025

Attribute data types

Type Syntax Examples and details
identifier Any alphanumeric or '_' character, without space. 'myControl', 'slider1','param_slider'
'my Control' or 'my-control' are invalid identifiers.
For compatibility with scripting, start id with a letter (not with a digit).
string Any character or string 'Hello!'
color RGB hex value with '#' '#ffffff' for white, '#ff0000' for red. / This is the same syntax as HTML colors.
boolean 'true' or 'false'  
real number digits.digits '5.3' '10' '3.02' '0.4'
The language only supports English notation with '.' for the delimiter.
parameter type 'real', 'boolean', 'integer' or 'enumeration' Real stands for real number in floating point notation (5.3)
number of pixels Any positive integer value 145
percentage Real number followed by '%' '20%' '33.3%'
position in pixels Any integer value -5
vertical alignment 'top' or 'bottom' or 'center'  
horizontal alignment 'left' or 'right' or 'center'  
orientation 'vertical' or 'horizontal'  
graph style 'curve' or 'bargraph' The bargraph style displays bars from the origin of the graph to the value of the curve, whereas the curve style draws curve points connected by segments in the case of non continuous curves.
file path Relative file path. The root of all paths is the skin file directory. 'xxx.bmp', or 'images/xxx.bmp'
image file path See file path Supported formats: bmp (8,16 or 24 bits), png, svg, jpg files.
cursor 'system::xxx' where xxx is a valid cursor type, or (Windows only) valid cursor file path. System::hand or 'mycursor.cur'
event Events are fired when something happens and can be used to trigger actions. Events are exposed by the data model and can be used to perform specific actions when fired.
script script code. Inside the script attribute you must replace " with &quot;, < with &lt; and some other chars.
param id see identifier The identifier of a PARAM
curve id see identifier The identifier of a CURVE
string id see identifier The identifier of a STRING
action id see identifier The identifier of an ACTION
group id see identifier The identifier of a GROUP
string with param fields String containing parameter fields enclosed into brackets 'value is: {value} {unit}'
Valid fields are: {value}, {unit}, {name}, {default}, {min}, {max}, {comment}, {text_value}, {as_string}
param value formatting flagmax_char.digits (all fields are optional), where:

flag values (can be mixed):
'+' to show a '+' when the value is positive
blank (' ') : positive values start with a blank
'0' : value is padded with 0s. Valid only if followed by the max_char field.

max_char is the maximum number of characters to use for the text (sign and '.' included)

'.' followed by digits: number of characters reserved for the decimal part

'+8.2' will show a number with its sign, with a maximum of 8 characters (including '.') and 2 characters reserved for the digits

'.0' will show a number without decimal part.

'+05.0' will show a value with 5 characters without any decimal part, padded with '0' if needed.

Using the max_char field avoids the text to move on the screen when the value changes if you used a monotype font such as 'Courier New'.

For programmers, the syntax is very similar to the formatting options of 'printf' standard c function.
response curve 'linear' 'log' 'exp' 'log1' 'exp1' 'log2' 'exp2' 'log3' 'exp3' 'square_root' 'square' See the Response Curves graphes below for an overview of available curves.

Response curves visualization


Comments

Please, authorize to view and post comments.

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