@types/gorilla-engine 1.1.30 → 1.1.32

gorilla-engine/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for gorilla-engine (https://gorilla-engin
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gorilla-engine.
 
 ### Additional Details
- * Last updated: Thu, 14 Aug 2025 09:04:13 GMT
+ * Last updated: Fri, 17 Apr 2026 09:57:54 GMT
  * Dependencies: none
 
 # Credits

gorilla-engine/components/AmpEnv.d.ts

@@ -1,21 +1,65 @@
 declare namespace GorillaEngine.UI {
     interface AmpItem {
+        /**
+         * Sets the color of the respective envelope handle.
+         * This can be a named color (e.g., "red") or a hexadecimal value (e.g., "FF0000"). To specify an RGBA color set the hex alpha as a prefix (e.g., "80FF0000").
+         */
         color: string;
+        /**
+         * Sets the thickness of the respective envelope handle.
+         */
         size: number;
+        /**
+         * Sets the corner radius for the respective envelope handle.
+         */
         cornerRadius: number;
+        /**
+         * Sets the default value for the respective
+         */
         value: number;
+        /**
+         * Sets a value binding for the respective envelope handle.
+         */
         "value&": any;
+        /**
+         * Sets the visibility of the respective envelope handle.
+         * If set to `false`, the handle will not be rendered.
+         */
         visible: boolean;
+        /**
+         * Sets the path to the image used for the respective envelope handle.
+         */
         imagePath: string;
+        /**
+         * Sets the text displayed on the respective envelope handle.
+         */
         text: string;
+        /**
+         * Sets the color of the text. This can be a named color (e.g., "red") or a hexadecimal value (e.g., "FF0000"). To specify an RGBA color set the hex alpha as a prefix (e.g., "80FF0000").
+         */
         textColor: string;
     }
 
     interface AmpEnvProps extends Common, Bounds, Background, Font {
+        /**
+         * Configures the visual properties for the **attack** envelope handle.
+         */
         attack: Partial<AmpItem>;
+        /**
+         * Configures the visual properties for the **decay** envelope handle.
+         */
         decay: Partial<AmpItem>;
+        /**
+         * Configures the visual properties for the **sustain** envelope handle.
+         */
         sustain: Partial<AmpItem>;
+        /**
+         * Configures the visual properties for the **release** envelope handle.
+         */
         release: Partial<AmpItem>;
+        /**
+         * Configures the visual properties for the envelope curve.
+         */
         curve: Partial<{
             color: string;
             thickness: number;

gorilla-engine/components/BarStepEditor.d.ts

@@ -1,22 +1,61 @@
 declare namespace GorillaEngine.UI {
     interface BarStepEditorProps extends Common, Bounds, Background, Clickable {
-        value: any;
+        /**
+         * The spacing between the bars.
+         */
         divSize: number;
         min: number;
         max: number;
+        /**
+         * The path to the respective script in the instrument.
+         */
         paramPath: string;
+        /**
+         * Index of the first
+         */
         startIndex: number;
         endIndex: number;
+        /**
+         * The dimension of the step
+         */
         step: Partial<{
+            /**
+             * The horizontal offset of the step relative to its default position
+             */
             x: number;
+            /**
+             * The vertical offset of the step relative to its default position
+             */
             y: number;
+            /**
+             * The width of a step.
+             */
             width: number;
+            /**
+             * The height of a step.
+             */
             height: number;
+            /**
+             * The corner radius of the step.
+             */
             cornerRadius: number;
+            borderSizeX: number;
+            borderSizeY: number;
+            /**
+             * The color of the step when it is active.
+             */
+            activeColor: string;
+
+            markDefault: boolean;
             incrementHeight: number;
             backgroundColor: string;
-            markDefault: boolean;
+            /**
+             * The color of the step when it is on.
+             */
             onColor: string;
+            /**
+             * The color of the step when it is off.
+             */
             offColor: string;
         }>;
     }

gorilla-engine/components/ComboBox.d.ts

@@ -6,33 +6,93 @@ declare namespace GorillaEngine.UI {
         bottom: number;
     }
     interface ComboBoxPopupStyles extends Font {
+        /**
+         * The background color of the dropdown popup itself.
+         */
         backgroundColor: string;
+        /**
+         * The text color for standard, unselected items within the popup list.
+         */
         itemTextColor: string;
+        /**
+         * The text color for the **single selected item** in the popup list.
+         */
         itemSelectedTextColor: string;
+        /**
+         * The background color for the **single selected item** in the popup list.
+         */
         itemSelectedBackgroundColor: string;
+        /**
+         * The text color for items that are currently highlighted (e.g., by mouse hover or keyboard navigation)
+         * but not yet selected.
+         */
         itemHighlightedTextColor: string;
+        /**
+         * The background color for items that are currently highlighted (e.g., by mouse hover or keyboard navigation)
+         * but not yet selected.
+         */
         itemHighlightedBackgroundColor: string;
+        /**
+         * Specifies the alignment of the checkmark icon, indicating the selected item, within the popup.
+         * It can be positioned either to the `left` or `right` of the item's text.
+         */
         checkmarkFloat: "left" | "right";
+        /**
+         * The radius for the corners of the popup, providing rounded edges.
+         * A value of `0` results in sharp, square corners.
+         */
         cornerRadius: number;
-        padding: ComboBoxPadding | number;
-        checkmarkPadding: ComboBoxPadding;
+        /**
+         * Defines the padding space around the items within the popup.
+         * This can be a uniform `number` (applying to all sides) or a `ComboBoxPadding` object
+         * for more granular control over top, right, bottom, and left padding.
+         */
+        padding: ComboBoxPadding | number; // Assuming ComboBoxPadding is defined elsewhere as { top, right, bottom, left }
+        /**
+         * Defines the padding specifically for the checkmark icon relative to its containing item.
+         * This allows for fine-tuning the spacing around the checkmark.
+         */
+        checkmarkPadding: ComboBoxPadding; // Assuming ComboBoxPadding is defined elsewhere as { top, right, bottom, left }
     }
 
     interface ComboBoxProps extends Common, Bounds, Background, Clickable, Font, Highlight {
+        /**
+         * The value of the combobox, which corresponds to the index of the initially selected item in the `items` array.
+         */
         value: number;
         /**
          * List of options
          */
         items: string[];
         /**
-         * The character that signifies heirarchy within the items array
+         * The character that signifies heirarchy within the items array, will open a submenu at the position of the character.
          */
         levelSeperator: string;
+        /**
+         * If `true`, the text within the combobox will stretch to fit the available width.
+         */
         stretchText: boolean;
+        /**
+         * If `true`, the combobox will allow scrolling through items using the mouse wheel.
+         */
         scrollWheelEnabled: boolean;
+        /**
+         * If true, the combobox will apply a specific style to submenus, which may include different background colors, fonts, or other visual elements.
+         */
         styleSubmenu: boolean;
+
+        /**
+         * The background color of the combobox trigger in its clicked state (i.e., with its popup open).
+         */
         backgroundColorClicked: string;
+        /**
+         * The background color of the combobox trigger on mouse hover.
+         */
         backgroundColorHover: string;
+
+        /** TODO:: THIS has to be a callback function rather than a string for a view model
+         * The action to perform when the selected item is selected again from the combobox.
+         */
         itemReselectedAction: string;
         padding: Partial<ComboBoxPadding> | number;
         images: Partial<{

gorilla-engine/components/Curve.d.ts

@@ -1,20 +1,72 @@
 declare namespace GorillaEngine.UI {
+    /**
+     * TODO:: Is this control even exposed to the user? Or is it part of AmpEnv
+     */
     interface CurveProps extends Common, Bounds, Background, Font, Clickable {
+        /**
+         * The value of the curve.
+         */
         value: any;
+        /**
+         * The path to the parameter that the curve is bound to.
+         */
         paramPath: string;
+        /**
+         * The color of the curve.
+         */
         color: string;
+        /**
+         * The thickness of the curve.
+         */
         thickness: number;
+        /**
+         * The handle configuration.
+         */
         handle: Partial<{
+            /**
+             * The value of the handle.
+             */
+            value: any;
+            /**
+             * The color of the handle.
+             */
             color: string;
+            /**
+             * The corner radius of the handle.
+             */
             cornerRadius: number;
+            /**
+             * The width of the handle.
+             */
             width: number;
+            /**
+             * The height of the handle.
+             */
             height: number;
+            /**
+             * Whether the handle is visible.
+             */
             visible: boolean;
         }>;
+        /**
+         * The marking configuration.
+         */
         marking: Partial<{
+            /**
+             * The color of the marking.
+             */
             color: string;
+            /**
+             * The text color of the marking.
+             */
             textColor: string;
+            /**
+             * The thickness of the marking.
+             */
             thickness: number;
+            /**
+             * Whether the marking is visible.
+             */
             visible: boolean;
         }>;
     }

gorilla-engine/components/Knob.d.ts

@@ -1,15 +1,45 @@
 declare namespace GorillaEngine.UI {
     interface KnobProps extends Common, Bounds, Clickable, Background, Skinnable, MIDILearn, Highlight {
+        /**
+         * The text displayed for component
+         */
         text: string;
+        /**
+         * The minimum value of the knob.
+         */
         min: number;
+        /**
+         * The maximum value of the knob.
+         */
         max: number;
+        /**
+         * The initial value of the knob, which should be between `min` and `max`.
+         */
         value: number;
+        /**
+         * The step size for the knob, which determines how much the value changes with each interaction.
+         */
         stepSize: number;
+
         inverted: boolean;
+        /**
+         * If `true`, the knob's value can be adjusted using the mouse scroll wheel.
+         */
         scrollWheelEnabled: boolean;
+        /**
+         * The path to a single image used for the knob's appearance.
+         */
         image: string;
+        /** TODO:: this is rather a slider prop than a knob prop
+         */
         snapsToMousePosition: boolean;
+        /**
+         * Sets the minimum rotation angle for the knob image in degrees. Only relevant if `image` is set.
+         */
         minRotation: number;
+        /**
+         * Sets the maximum rotation angle for the knob image in degrees. Only relevant if `image` is set.
+         */
         maxRotation: number;
     }
 

gorilla-engine/components/Label.d.ts

@@ -1,6 +1,12 @@
 declare namespace GorillaEngine.UI {
     interface LabelProps extends Common, Bounds, Background, Font, Clickable, Margin, Keyable {
+        /**
+         * The initial text to display in the label. Doesn't update at runtime.
+         */
         value: any;
+        /**
+         * The text to display in the label. Updates at runtime.
+         */
         text: string | number;
         format: string;
         multiLine: boolean;

gorilla-engine/components/LevelMeter.d.ts

@@ -1,22 +1,82 @@
 declare namespace GorillaEngine.UI {
     interface LevelMeterProps extends Common, Bounds, Background, Skinnable {
+        /**
+         * If `true`, the level meter will display and hold the highest peak level reached
+         * for a defined duration.
+         */
         peakHold: boolean;
+        /**
+         * If `true`, the level meter's scale will be displayed logarithmically.
+         */
         logScale: boolean;
+        /**
+         * If `true`, the level meter will fill the area below the current level peak.
+         */
         fillArea: boolean;
+        /**
+         * If `true`, the level meter will be vertically inverted.
+         */
         inverted: boolean;
+        /**
+         * If `true`, the level meter will display both the left and right channel levels.
+         */
         stereo: boolean;
+        /**
+         * If `true`, the level meter won't fill the area below the current level peak.
+         */
         positionIndicator: boolean;
+        /**
+         * Defines a **threshold** on the logarithmic scale. Below this value,
+         * a specific logarithmic mapping is applied to `normalizedValue` for detailed display.
+         * At or above this threshold, the display behavior may change (e.g., clamp to full).
+         */
         rampUpFactor: number;
+        /**
+         * Controls the **scaling factor** for the logarithmic mapping when `normalizedValue`
+         * is below the `rampUpFactor` threshold. It influences how "stretched" or
+         * compressed the lower portion of the logarithmic scale appears.
+         */
         rampDownFactor: number;
+        /**
+         * Specifies the **maximum speed** at which the level meter's visual indicator
+         * can decrease or "fall back" from a peak.
+         */
         maxRampDownSpeed: number;
+        /**
+         * The minimum bound of the level meter's scale.
+         */
         min: number;
+        /**
+         * The maximum bound of the level meter's scale.
+         */
         max: number;
+        /**
+         * The color of the level meter's fill area.
+         */
         levelColor: string;
+        /**
+         * The color of the level meter's peak indicator.
+         */
         peakColor: string;
+        /**
+         * The thickness of the level meter's indicator.
+         */
         indicatorThickness: number;
+        /** TODO::
+         * I have no idea that this does
+         */
         visibleSectionStart: number;
+        /** TODO::
+         * I have no idea that this does
+         */
         visibleSectionEnd: number;
+        /**
+         * The direction of the level meter. This can be "horizontal" or "vertical".
+         */
         direction: string;
+        /**
+         * The current value of the level meter.
+         */
         value: any;
     }
 

gorilla-engine/components/ListBox.d.ts

@@ -1,12 +1,36 @@
 declare namespace GorillaEngine.UI {
     interface ListBoxProps extends Common, Bounds, Font, Clickable, Background, Scrollable, Highlight, MIDILearn {
+        /**
+         * The items displayed in the list box.
+         */
         items?: string[];
+        /**
+         * The horizontal margin of the item inside the list box.
+         */
         horizontalMargin?: number;
+        /**
+         * The bakcground color of the items in the list box.
+         */
         cellColor?: string;
+        /**
+         * The background color of the selected item in the list box.
+         */
         cellColorSelected?: string;
+        /**
+         * The text color of the item in the list box.
+         */
         textColorSelected?: string;
+        /**
+         * The action to perform when a row is double clicked.
+         */
         rowDoubleClickedAction?: string;
+        /**
+         * The action to perform when the return key is clicked.
+         */
         returnKeyAction?: string;
+        /**
+         * The action to perform when a row is clicked.
+         */
         rowClickedAction?: string;
     }
 

gorilla-engine/components/LottieAnimation.d.ts

@@ -1,16 +1,53 @@
 declare namespace GorillaEngine.UI {
     interface LottieAnimationProps extends Common, Bounds {
+        /**
+         * The file path to the Lottie animation JSON file.
+         */
         filePath: string;
+        /**
+         * If set to true, the animation will start playing automatically.
+         */
         autoplay: boolean;
+        /** If set to true, the animation will loop indefinitely. */
         loop: boolean;
+        /**
+         * Returns the total number of frames in the animation
+         */
         readonly totalFrames?: number;
+        /**
+         * The duration of the animation in seconds.
+         */
         readonly duration?: number;
+        /**
+         * The currently displayed frame of the animation.
+         */
         readonly currentFrame?: number;
+        /**
+         * Starts the animation playback at the current position.
+         */
         play(): void;
+        /**
+         * Stops the animation playback and resets the position.
+         */
         stop(): void;
+        /**
+         * Pauses the animation playback.
+         */
         pause(): void;
+        /**
+         * Sets the animation to a specific frame.
+         * @param frame The frame number to set the animation to.
+         */
         setFrame(frame: number): void;
+        /**
+         * TODO:: No idea what this does
+         * @param frame the target frame to set the animation to.
+         */
         setTargetFrame(frame: number): void;
+        /**
+         * TODO:: No idea what this does
+         * @param frame the target frame to set the animation to.
+         */
         setFrameFromLinearTransform(value: number, min: number, max: number): void;
         setProperties(
             selector: string,

gorilla-engine/components/MidiKeyboard.d.ts

@@ -1,31 +1,101 @@
 declare namespace GorillaEngine.UI {
     interface MidiKeyboardKeys {
+        /**
+         * The color of the black keys.
+         */
         blackColor: string;
+        /**
+         * The color of the black keys when hovered.
+         */
         blackHoverColor: string;
+        /**
+         * The color of the black keys when pressed.
+         */
         blackPressedColor: string;
+        /**
+         * The outline color of the black keys.
+         */
         blackOutlineColor: string;
+        /**
+         * The outline color of the black keys when hovered.
+         */
         blackOutlineHoverColor: string;
+        /**
+         * The outline color of the black keys when pressed.
+         */
         blackOutlinePressedColor: string;
+        /**
+         * The color of the white keys.
+         */
         whiteColor: string;
+        /**
+         * The color of the white keys when hovered.
+         */
         whiteHoverColor: string;
+        /**
+         * The color of the white keys when pressed.
+         */
         whitePressedColor: string;
+        /**
+         * The outline color of the white keys.
+         */
         whiteOutlineColor: string;
+        /**
+         * The outline color of the white keys when hovered.
+         */
         whiteOutlineHoverColor: string;
+        /**
+         * The outline color of the white keys when pressed.
+         */
         whiteOutlinePressedColor: string;
+        /**
+         * The height of the white keys.
+         */
         whiteHeight: number;
+        /**
+         * The height of the black keys.
+         */
         blackHeight: number;
+        /**
+         * TODO::Doesnt work, The width of the white keys.
+         */
         whiteWidth: number;
+        /**
+         * TODO:: The width of the black keys.
+         */
         blackWidth: number;
+        /**
+         * TODO:: The width of the black keys apparently.
+         */
         width: number;
+        /**
+         * The spacing between the keys
+         */
         spacing: number;
+        /**
+         * The width of the outline around the keys.
+         */
         outlineWidth: number;
+        /**
+         * The corner radius of the keys.
+         */
         cornerRadius: number;
     }
 
     interface MidiKeyboardProps extends Common, Bounds, Background {
+        /**
+         * The first key to display on the keyboard, value derived from midi mapping.
+         */
         lowKey: number;
+        /**
+         * The last key to display on the keyboard, value derived from midi mapping.
+         */
         highKey: number;
+
         disableNKSColors: boolean;
+        /**
+         * The configuration for the keys of the keyboard.
+         */
         keys: Partial<MidiKeyboardKeys>;
     }
 

gorilla-engine/components/Pad.d.ts

@@ -1,8 +1,21 @@
 declare namespace GorillaEngine.UI {
     interface PadProps extends Common, Bounds, Background, KeyboardFocus, Clickable, Skinnable, Font {
+        /**
+         * The midi note index for the pad
+         */
         midiNote: number;
+        /**
+         * The veloctiy of the pad when pressed and not controlled by midi
+         */
         velocity: number;
+        /**
+         * Sets the visual state of the pad.
+         * If true, the pad is in a pressed/playing state.
+         */
         padState: boolean;
+        /**
+         * The paths for the images used for displaying the pad.
+         */
         images: Partial<{
             normal: string;
             hover: string;

gorilla-engine/components/Rubberband.d.ts

@@ -1,6 +1,9 @@
 declare namespace GorillaEngine.UI {
     interface RubberbandProps extends Common, Bounds {
     }
+    /**
+     * A container that forwards mouse down events to its children as if they were individually clicked.
+     */
 
     class Rubberband extends Component {
         constructor(options: Partial<RubberbandProps>);