@types/gorilla-engine 1.1.29 → 1.1.31

gorilla-engine/components/ScrollView.d.ts

@@ -1,10 +1,34 @@
 declare namespace GorillaEngine.UI {
     interface ScrollViewProps extends Common, Bounds, Scrollable {
+        /**
+         * The thickness of the scrollbar in pixels.
+         */
         scrollbarThickness: number;
+        /**
+         * Hides the vertical scrollbar.
+         * @default false
+         */
         hideVerticalScrollbar: boolean;
+        /**
+         * Hides the horizontal scrollbar.
+         * @default false
+         */
         hideHorizontalScrollbar: boolean;
+        /** TODO:: No idea if this is correct
+         * If true, the scroll view will ignore keypress events.
+         * @default false
+         */
         ignoreKeypressEvent: boolean;
+        /**
+         * Scrolls the child at the given index into view.
+         * @param childIndex The index of the child to scroll into view.
+         */
         scrollChildIntoView(childIndex: number): void;
+        /**
+         * Sets the scroll position of the view.
+         * @param xPos The horizontal scroll position in pixels.
+         * @param yPos The vertical scroll position in pixels.
+         */
         setScrollPositionProportionately(xPos: number, yPos: number): void;
     }
 

gorilla-engine/components/Slider.d.ts

@@ -1,7 +1,17 @@
 declare namespace GorillaEngine.UI {
     interface SliderProps extends KnobProps {
+        /**
+         * The direction of the slider.
+         */
         direction: "horizontal" | "vertical";
+        /**
+         * The path to the image used for the thumb of the slider.
+         */
         thumbImage: string;
+
+        /**
+         * TODO:: no idea what this does
+         */
         sliderBounds: {
             x: number;
             y: number;

gorilla-engine/components/StepEditor.d.ts

@@ -1,25 +1,62 @@
 declare namespace GorillaEngine.UI {
     interface StepEditorProps extends Common, Background, Bounds, 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;
+            /**
+             * 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/TextBox.d.ts

@@ -1,18 +1,62 @@
 declare namespace GorillaEngine.UI {
     interface TextBoxProps extends Font, Clickable, Bounds, Background, Margin, Keyable {
+        /**
+         * The initial text value of the text box.
+         */
         text: string;
-        palceholder: string;
+        /**
+         * The placeholder text of the text box.
+         */
+        placeholder: string;
+        /** TODO:: check if it works
+         * An additional suffix displayed in the textbox without alterting the text value.
+         */
         unit: string;
+        /**
+         * The textcolor of the placeholder
+         */
         placeHolderColor: string;
+        /**
+         * When highlighted via automation in AAX this is the color used to highlight the text.
+         */
         highlightTextColor: string;
+        /**
+         * When highlighted via automation in AAX this is the color used to highlight the background.
+         */
         highlightColor: string;
+        /**
+         * The color of the caret in the text box.
+         */
         caretColor: string;
+        /**
+         * The maximum length of the text in the text box.
+         */
         maxLength: number;
+        /**
+         * If set, the text box will display a password character instead of the actual text.
+         */
         passwordCharacter: string;
+        /**
+         * If true, the text box will allow multiple lines of text.
+         */
         multiLine: boolean;
+
+        /** TODO:: what is even the point of this?
+         * If true, the text box will not allow user input and will be read-only.
+         */
         readOnly: boolean;
+        /**
+         * The type of data that accepted by the text box.
+         */
         acceptedDataType: "integer" | "int" | "float" | "string";
+
+        /**
+         * If acceptedDataType is numeric, this is the minimum value allowed in the text box.
+         */
         minValue: number;
+        /**
+         * If acceptedDataType is numeric, this is the maximum value allowed in the text box.
+         */
         maxValue: number;
         highlightStart: number;
         highlightEnd: number;

gorilla-engine/components/Toggle.d.ts

@@ -1,26 +1,92 @@
 declare namespace GorillaEngine.UI {
     interface ToggleProps extends Common, Bounds, Font, Clickable, Background, Highlight, MIDILearn, Margin {
+        /**
+         * The text displayed next to the toggle.
+         */
         text: string;
+        /**
+         * The background color of the toggle when it is on.
+         */
         onColor: string;
+        /**
+         * The background color of the toggle when it is off.
+         */
         offColor: string;
+        /**
+         * The background color of the toggle when it is on and hovered.
+         */
         onColorHover: string;
+        /**
+         * The background color of the toggle when it is off and hovered.
+         */
         offColorHover: string;
+        /**
+         * The text color of the toggle when it is on.
+         */
         textColorOn: string;
+        /**
+         * The text color of the toggle when it is off.
+         */
         textColorOff: string;
+        /**
+         * The text color of the toggle when it is on and hovered.
+         */
         textColorOnHover: string;
+        /**
+         * The text color of the toggle when it is off and hovered.
+         */
         textColorOffHover: string;
+        /**
+         * The image of the toggle when it is on.
+         */
         onImage: string;
+        /**
+         * The image of the toggle when it is on and pressed.
+         */
         onImagePressed: string;
+        /**
+         * The image of the toggle when it is on and hovered.
+         */
         onImageHovered: string;
+        /**
+         * The image of the toggle when it is off.
+         */
         offImage: string;
+        /**
+         * The image of the toggle when it is off and pressed.
+         */
         offImagePressed: string;
+        /**
+         * The image of the toggle when it is off and hovered.
+         */
         offImageHovered: string;
+        /**
+         * The image of the toggle when it is disabled.
+         */
         disabledImage: string;
+        /**
+         * The radio index of the toggle
+         */
         radioIndex: number;
+        /**
+         * The radio value of the toggle. If it maches radioIndex, the toggle will be on.
+         */
         radioValue: number;
+        /**
+         * If true, the toggle will draw a tick box to toggle.
+         */
         drawTick: boolean;
+        /**
+         * Adjusts font size to fit the text within the toggle's bounds.
+         */
         fitToText: boolean;
+        /**
+         * The value of the toggle.
+         */
         value: boolean;
+        /**
+         * The lottie animation to play when the toggle is interacted with.
+         */
         animation: LottieAnimation;
     }
     // tslint:disable-next-line:no-empty-interface

gorilla-engine/components/Waveform.d.ts

@@ -4,51 +4,168 @@ declare namespace GorillaEngine.UI {
         y: number;
         x2: number;
         y2: number;
+        /**
+         * The path to the asset for the left handle.
+         */
         leftHandleImage: string;
+        /**
+         * The path to the asset for the right handle.
+         */
         rightHandleImage: string;
+        /**
+         * The background color of the Drag Zone
+         */
         backgroundColor: string;
+        /**
+         * The color of the overlay.
+         */
         overlayColor: string;
+        /**
+         * The width of the left handle.
+         */
         leftHandleWidth: number;
+        /**
+         * The height of the left handle.
+         */
         leftHandleHeight: number;
+        /**
+         * The width of the right handle.
+         */
         rightHandleWidth: number;
+        /**
+         * The height of the right handle.
+         */
         rightHandleHeight: number;
+        /**
+         * Whether the drag zone can be resized.
+         */
         canResize: boolean;
+        /**
+         * Whether the drag zone can be panned.
+         */
         canPan: boolean;
+        /**
+         * Whether the drag zone is enabled.
+         */
         enabled: boolean;
+        /**
+         * Value bindings for the drag zone properties.
+         */
         bindings: any;
     }
 
     interface WaveformMarker {
+        /**
+         * Whether the marker is enabled.
+         */
         enabled: boolean;
         x: number;
         y: number;
         x2: number;
         y2: number;
+        /**
+         * The path to the asset for the left handle.
+         */
         leftHandleImage: string;
+        /**
+         * The path to the asset for the right handle.
+         */
         rightHandleImage: string;
+        /**
+         * The background color of the marker.
+         */
         backgroundColor: string;
+        /**
+         * The width of the left handle.
+         */
         leftHandleWidth: number;
+        /**
+         * The height of the left handle.
+         */
         leftHandleHeight: number;
+        /**
+         * The width of the right handle.
+         */
         rightHandleWidth: number;
+        /**
+         * The height of the right handle.
+         */
         rightHandleHeight: number;
+        /**
+         * Whether the marker can be resized.
+         */
         canResize: boolean;
     }
 
     interface WaveformProps extends Common, Bounds, Background, Font, Clickable, Margin {
+        /**
+         * The color of the waveform.
+         */
         waveformColor: string;
+        /**
+         * The color of the gradient center.
+         */
         gradientCenterColor: string;
+        /**
+         * The color of the gradient end.
+         */
         gradientEndColor: string;
+        /**
+         * The color of the horizontal axis.
+         */
         horizontalAxisColor: string;
+        /**
+         * The text to display when the waveform is unavailable.
+         */
         waveformUnavailableText: string;
+        /**
+         * The width of the waveform.
+         */
         waveWidth: number;
+
+        /**
+         * The initial X offset of the waveform.
+         */
         initialXOffset: number;
+
+        /**
+         * The horizontal spacing between waves.
+         */
         waveHorizontalSapcing: number;
+
+        /**
+         * The vertical padding of the waveform.
+         */
         verticalPadding: number;
+
+        /**
+         * Whether to fit the waveform height.
+         */
         fitHeight: boolean;
+
+        /**
+         * Whether to paint the center line.
+         */
         paintCenterLine: boolean;
+
+        /**
+         * The value of the waveform.
+         */
         value: number;
+
+        /**
+         * Whether to draw using legacy mode.
+         */
         drawUsingLegacy: boolean;
+
+        /**
+         * The drag zone configuration.
+         */
         dragzone: Partial<WaveformDragZone>;
+
+        /**
+         * The marker configuration.
+         */
         markers: Partial<WaveformMarker>;
     }
 

gorilla-engine/components/Window.d.ts

@@ -1,9 +1,21 @@
 declare namespace GorillaEngine.UI {
     interface WindowProps extends Common, Background {
+        /**
+         * The width of the plugin window. */
         width: number;
+        /**
+         * The height of the plugin window. */
         height: number;
+        /**
+         * The initial scaling of the window's dimensions. */
         uiScale: number;
+        /**
+         * The minimum allowed scaling of the window's dimensions.
+         */
         uiScaleMin: number;
+        /**
+         * The maximum allowed scaling of the window's dimensions.
+         */
         uiScaleMax: number;
     }
     // tslint:disable-next-line:no-empty-interface

gorilla-engine/components/XYPad.d.ts

@@ -1,14 +1,44 @@
 declare namespace GorillaEngine.UI {
     interface XYPadProps extends Common, Bounds, Clickable, Background {
+        /**
+         * The x- value of the XYPad inthe range of [minX, maxX].
+         */
         valueX: number;
+        /**
+         * The y- value of the XYPad in the range of [minY, maxY].
+         */
         valueY: number;
+        /**
+         * The minimum x- value of the XYPad.
+         */
         minX: number;
+        /**
+         * The maximum x- value of the XYPad.
+         */
         maxX: number;
+        /**
+         * The minimum y- value of the XYPad.
+         */
         minY: number;
+        /**
+         * The maximum y- value of the XYPad.
+         */
         maxY: number;
+        /**
+         * The step size for the x- value.
+         */
         stepSizeX: number;
+        /**
+         * The step size for the y- value.
+         */
         stepSizeY: number;
+        /**
+         * If set to true, the XYPad will snap to the mouse position when clicked.
+         */
         snapsToMousePosition: boolean;
+        /**
+         * The path to the image used for the XYPad thumb.
+         */
         thumbImage: string;
     }
 

gorilla-engine/index.d.ts

@@ -174,6 +174,13 @@ declare namespace GorillaEngine {
          * @param module The serialised module to set as a string
          */
         setModuleAtPath(path: string, module: string): boolean;
+        /**
+         * Method used to replace a module in an instrument in a given path
+         * @param path The path to the module that should be retrieved.
+         * @param module The serialised module to replace as a string
+         */
+        replaceModuleAtPath(path: string, module: string): boolean;
+
         /**
          * Method used to determine if a value from the Gorilla Engine is a module.
          *
@@ -356,7 +363,9 @@ declare namespace GorillaEngine {
         /**
          * Method used to retrieve a string from the Gorilla Engine.
          * @param path The path to the string that should be retrieved.
-         * @returns the string found at the given `path` or `false` if nothing was found.
+         * @returns the string found at the given `path` or `false` if nothing was found. If a numeric
+         * value is found at the path it's string representation is returned - the same as if the value
+         * was passed to {@link valueToStringAtPath}.
          */
         getStringAtPath(path: string): string;
 
@@ -596,6 +605,7 @@ declare namespace GorillaEngine {
          * @param x  the x position to place the settings button
          * @param y  the y position to place the settings button
          */
+
         function setSettingsButtonPosition(x: number, y: number): void;
     }
 }

gorilla-engine/interfaces/Background.d.ts

@@ -1,11 +1,37 @@
 declare namespace GorillaEngine.UI {
     interface Background {
+        /**
+         * Specifies the URL or base64 encoded string of an image to be used as the background.
+         * This property takes precedence over `backgroundColor` if both are provided.
+         */
         backgroundImage: string;
+
+        /**
+         * Defines the solid color to be used for the background.
+         * This color will be visible if `backgroundImage` is not set or if the image has transparent areas.
+         */
         backgroundColor: string;
+
+        /**
+         * Sets the radius for the corners of the component, creating rounded edges.
+         */
         cornerRadius: number;
+
+        /**
+         * Defines the properties of the border surrounding the component.
+         */
         border: {
+            /**
+             * The thickness of the border in pixels.
+             */
             width?: number;
+            /**
+             * The color of the border when the component is not in focus.
+             */
             color?: string;
+            /**
+             * The color of the border when the component is in focus (e.g. on hover).
+             */
             focusColor?: string;
         };
     }

gorilla-engine/interfaces/Bounds.d.ts

@@ -1,11 +1,20 @@
 declare namespace GorillaEngine.UI {
     interface Bounds {
         /**
-         * The x position of the component
+         * The **x-coordinate** of the component's top-left corner, typically measured from the left edge of its containing element or viewport.
          */
         x: number;
+        /**
+         * The **y-coordinate** of the component's top-left corner, typically measured from the top edge of its containing element or viewport.
+         */
         y: number;
+        /**
+         * The **width** of the component in pixels.
+         */
         width: number;
+        /**
+         * The **height** of the component in pixels.
+         */
         height: number;
     }
 }

gorilla-engine/interfaces/Clickable.d.ts

@@ -1,12 +1,46 @@
 declare namespace GorillaEngine.UI {
+    /**
+     * Describes an element that can respond to mouse clicks and other pointer interactions.
+     */
     interface Clickable {
+        /**
+         * Indicates whether the component processes mouse events directly.
+         */
         interceptsMouseClicks: boolean;
+
+        /**
+         * Determines if child components can process mouse events.
+         */
         allowClicksOnChildren: boolean;
+
+        /**
+         * Defines the action to be triggered when a click occurs with a modifier key (e.g., Shift or Ctrl).
+         */
         modifiedClickAction: string;
+
+        /**
+         * Specifies the action to be executed on a double-click event. (Requires ViewModel support)
+         */
         doubleClickAction: string;
+
+        /**
+         * The action to be performed when the mouse pointer enters the control's area.
+         */
         mouseEnterAction: string;
+
+        /**
+         * The action to be performed when the mouse pointer exits the control's area.
+         */
         mouseExitAction: string;
+
+        /**
+         * An optional bitmask that defines the clickable region within the control.
+         */
         clickMask: string;
+
+        /**
+         * Specifies the type of mouse cursor displayed when the pointer hovers over the control.
+         */
         mouseCursorType:
             | "none"
             | "normal"

gorilla-engine/interfaces/Common.d.ts

@@ -1,11 +1,39 @@
 declare namespace GorillaEngine.UI {
     interface Common {
+        /**
+         * A unique identifier for the component. This ID is needed for referencing
+         * and managing the component within the application's hierarchy.
+         */
         id: string;
+        /**
+         * Controls the visibility of the component. If set to `false`, the component
+         * will not be rendered.
+         */
         visible: boolean;
+        /**
+         * Determines if the component is active. If `false`, the component
+         * will not respond to user input (e.g., clicks, keyboard events) but may still be visible.
+         */
         enabled: boolean;
+        /**
+         * Indicates whether the component requests keyboard focus when it becomes active or is
+         * programmatically highlighted. This is important for keyboard navigation and input.
+         */
         wantsKeyboardFocus: boolean;
+        /**
+         * If `true`, a mouse click on this component will automatically
+         * transfer keyboard focus to it, allowing for immediate keyboard interaction.
+         */
         clickGrabsKeyboardFocus: boolean;
+        /**
+         * Sets the opacity level of the component, ranging from `0.0` (fully transparent)
+         * to `1.0` (fully opaque).
+         */
         alpha: number;
+        /**
+         * If `true`, the component will always be rendered on top of other components
+         * within the same stacking context, regardless of their Z-order.
+         */
         alwaysOnTop: boolean;
     }
 }