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
  • TIMER
UI Layout and positioning
  • CELL
  • TABLE
UI Widgets
  • CANVAS
    • Graphics API
  • COLOR_SCALE
  • FILE_SELECT_MENU
  • GRID
  • INVISIBLE_PARAM_MENU_BUTTON
  • MENU_ITEM
  • MENU_SEPARATOR
  • POPUP_MENU
  • svg
  • RULER
  • TEXT
  • TEXT_FIELD
  • TEXT_EDIT_BOX
  • XY_PARAM_PAD
  • XY_ZOOM_SELECT_PAD
  • XYZ_PARAM_SCRATCH_PAD
  • XYZ_PARAM_CLICK_PAD
  • XYZ_IMAGE_PARAM_JOYSTICK
UI 3D Objects
  • COLOR_SURFACE_3D
  • GRID_3D
  • GL_OBJECT_3D
Data model commands
  • 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
  • 3D Objects
  • Parameters mapping
  • LetiMix
KUIMLElement ReferenceREQUIRED_OBJECTS
March 25, 2024

REQUIRED_OBJECTS

This element contains a list of objects that should not be stripped at build time even if they are not used by the current skin. Can be used for testing purposes, or when using a KUIML_WIDGET. Multiple instances of this element are allowed: any new object identifier will be added to the list of required objects.

Attributes brief detailed show all inherited

Name Description
object_idsList of identifiers of objects to be declared as required
Name Value type Default Description Comment
object_ids';' separated identifiersemptyList of identifiers of objects to be declared as required

Examples

  1. <REQUIRED_OBJECTS object_ids="dsp.input1.BeginCapture;dsp.input1.EndCapture" />

Explanation

Say you've declared a param in the main skin (.xml) file:

  1. <PARAM id="my_param" min="0" max="100" default="0" />

You plan to use this parameter inside the KUIML_WIDGET. If you've never used this parameter inside the main skin (where it was declared), then it will be stripped (not created) by the KUIML engine, and so inside KUIML_WIDGET you'll get an error saying that this parameter is missing. To prevent this, you can use REQUIRED_OBJECTS in the main skin (where my_param is declared):

  1. <REQUIRED_OBJECTS object_ids="my_param" />

Now that parameter is created in the data model and not stripped even if it's not used in the current skin.

To make this parameter accessible in other data models (say in KUIML_WIDGET) and scripts see EXPOSED_OBJECTS.

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