Classes - General Notes
6.15 Classes - General Notes:
Common Properties:
name: Name of the element.
z: The layer to place the element on.
x: The left of the element relative to the project window (workspace).
y: The top of the element relative to the project window (workspace).
w: The width of the element.
h: The height of the element.
Note: The width and/or height of some elements are auto-calculated based on other criteria.
caption: If not nil or an empty string then a caption will be shown. The caption will use 'font_caption' for its font, and 'col_cap_text' for its color. The caption's background color will generally be specified by 'col_backdrop'.
shadow: If true the element will be displayed with a shadow. Buttons and Slider thumbs shadows are always on. The text elements probably should not use shadows unless they are using non-highlighted frames.
col_backdrop: This should be set to the background color where the element is placed: "wnd_bg" if placed directly on the script window, or "panel_bg" if placed on a panel. This is used in calculating highlight colors, and to improve drawing of shadows.
frame_use_outline: The text elements, slider track, and knob and slider display boxes as a default use highlighted outlines. Set this to true (default is false) to use solid outlines instead. Solid outlines will use the color specified in the element's 'col_frame' property ("elm_frame" by default). Themes have a false color "metadata", which if the alpha value is 0, will cause the element to be drawn with a solid outline regardless of the 'frame_use_outline' setting. Whether to use outlines can be set in script's preferences.
frame_thk: Specify the thickness of the element frames (see above). You can set the thickness in a script's preferences. As of 03-14-2026 there are are only two valid values: 1 or 2.
allow_sel_outline: Most of the classes have this property. If set to true then the element will be displayed with an outlined when it is selected by clicking on it, or by tabbing to it. It uses the dedicated GUI color "elm_active" for drawing the outline. This property is set to false by default, except for textbox and text editor, which benefit from the visual cue. As of 03-15-2026 tabbing isn't implemented, although the Lokasenna GUI does have provisions for tabbing.
Notes:
Almost all of the color properties' use default colors that correspond to a theme. Notable exceptions are panel colors. An element's backdrop color also needs to correspond to the background color of where it is placed. Although almost all of an element's colors can be set individually, it is best to use the default's otherwise it breaks theming.
Menubox popup menus, and system dialog use system fonts for their display. These cannot be controlled by the script.