PLUG'N SCRIPT
rapid plugin development
Tutorial
DSP
KUIML
How-to
Scripts
  • Tutorial
  • Element Reference
Language basics
  • SKIN
  • DUMMY
  • INCLUDE
  • INCLUDE_ONCE
  • DEFINE
  • UNDEFINE
  • VARIABLE
  • LOCAL_VARIABLE
  • TEMPLATE
  • TEMPLATE_INNER_CONTENT
  • REPEAT
Data model
  • PARAM
  • ACTION
    • Action types
  • ACTION_TRIGGER
UI Layout and positioning
  • CELL
  • TABLE
UI Widgets
  • TEXT
  • TEXT_FIELD
  • TEXT_EDIT_BOX
  • CANVAS
    • Graphics API
  • svg
Common attrubutes
  • For all elements
  • Widgets
  • Param Widgets
  • Param Controls
  • Param Info Viewers
  • Text Widgets
  • Surface Viewers
  • Curve Viewers
  • 3D Objects
  • Parameters mapping
KUIMLElement Reference
December 21, 2020

SCRIPT

Page is not ready

This article contains information from the official Blue Cat Audio KUIML reference that was not yet verified and edited.

This element includes an external script file into the KUIML application. The script file is loaded and compiled so that all definitions (classes, variables, functions) are made available to the scripting engine at runtime. See Scripting Reference for more information.

Attributes brief detailed show all inherited

Name DescriptionDefault
srcPath to the script file to includeempty
scriptif defined, overrides the src attribute. The script included in the attribute should be xml-encodedempty
requiresList of objects expected by the scriptForces the KUIML engine to expose the listed objects to the scripting engine. for example: 'my_object.*;my_string'empty
preprocessset to true if the script file should be preprocessed before being compiledPreprocessing a script consists in replacing build time variables ($var$) by their values before compiling the script. Preprocessing is always applied to inline script content, regardless of the value of this attributefalse
Name Value type Default Description Comment
srcpath to script fileemptyPath to the script file to include
scriptinline script contentemptyif defined, overrides the src attribute. The script included in the attribute should be xml-encoded
requireslist of ';' separated identifiers or wildcardsemptyList of objects expected by the scriptForces the KUIML engine to expose the listed objects to the scripting engine. for example: 'my_object.*;my_string'
preprocessbooleanfalseset to true if the script file should be preprocessed before being compiledPreprocessing a script consists in replacing build time variables ($var$) by their values before compiling the script. Preprocessing is always applied to inline script content, regardless of the value of this attribute

None.

Specific Attributes


2020 © Plug'n Script and KUIML by Blue Cat Audio  |  Site by LetiMix