@types/gorilla-engine 1.1.30 → 1.1.31

gorilla-engine/interfaces/Font.d.ts

@@ -1,9 +1,28 @@
 declare namespace GorillaEngine.UI {
     interface Font {
+        /**
+         * Specifies the font family to be used for text rendering (e.g., "Arial", "Helvetica Neue", "Roboto").
+         * The system will attempt to use this font, falling back to a default if it's unavailable.
+         */
         font: string;
+        /**
+         * Defines the size of the font in a numeric unit, typically pixels (px) or points (pt).
+         * Larger values result in larger text.
+         */
         fontSize: number;
+        /**
+         * Adjusts the spacing between individual characters (kerning) in the text.
+         * Positive values increase the space, while negative values decrease it, allowing for fine-tuned text appearance.
+         */
         fontKerning: number;
+        /**
+         * 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;
+        /**
+         * Controls the alignment of the text within its bounding box.
+         * This can include horizontal (left, center, right) and vertical (top, center, bottom) alignments.
+         */
         textAlign:
             | "centered left"
             | "centered right"

gorilla-engine/interfaces/Highlight.d.ts

@@ -1,11 +1,34 @@
 declare namespace GorillaEngine.UI {
+    /**
+     * Highlight interface for Gorilla Engine UI.
+     * This draws an automation highlight on knobs, Combobox, Toggle and listbox controls. Currently only works for AAX plugins.
+     * Note you will have to turn on this feature by setting AAXEnableParameterHighlighting in the .ugep file
+     */
     interface Highlight {
         highlight: {
+            /**
+             * If this is set to true the highlight will be a filled circle else it will be a rectangle boundary
+             */
             drawFilledCircle: boolean;
+            /**
+             * This determines the width of the line used to draw the highlight
+             */
             lineWidth: number;
+            /**
+             * The x coordinate on where to draw the highlight within the control
+             */
             x: number;
+            /**
+             * The y coordinate on where to draw the highlight within the control
+             */
             y: number;
+            /**
+             * The highlight width. Note if this is zero or less the bounds used to draw the highlight will be the control bounds
+             */
             width: number;
+            /**
+             * The highlight height. Note if this is zero or less the bounds used to draw the highlight will be the control bounds
+             */
             height: number;
         };
     }

gorilla-engine/interfaces/Keyable.d.ts

@@ -1,5 +1,12 @@
 declare namespace GorillaEngine.UI {
+    /**
+     * Key Event interface for Gorilla Engine UI.
+     * This interface handles key press actions and event consumption.
+     */
     interface Keyable {
+        /**
+         *  String that represents an action in a view model.
+         */
         keyPressAction: string;
         consumeEvent: boolean;
     }

gorilla-engine/interfaces/KeyboardFocus.d.ts

@@ -1,8 +1,21 @@
 declare namespace GorillaEngine.UI {
+    /**
+     * KeyboardFocus interface for Gorilla Engine UI.
+     * Defines how a cotrol appears when it has the keyboard focus
+     */
     interface KeyboardFocus {
         keyboardFocus: {
+            /**
+             * Defines the color of the focus border.
+             */
             color?: string;
+            /**
+             * Defines the line width of the focus border.
+             */
             lineWidth?: number;
+            /**
+             * Defines the corner radius of the focus border.
+             */
             cornerRadius?: number;
         };
     }

gorilla-engine/interfaces/MIDILearn.d.ts

@@ -1,5 +1,11 @@
 declare namespace GorillaEngine.UI {
+    /** MIDILearn interface for Gorilla Engine UI.
+     * This interface is used to define the properties related to MIDI learning functionality.
+     */
     interface MIDILearn {
+        /**
+         * Determines if MIDI learn is enabled or not
+         */
         midiLearn: {
             enabled: boolean;
         };

gorilla-engine/interfaces/Margin.d.ts

@@ -1,10 +1,22 @@
 declare namespace GorillaEngine.UI {
+    /**
+     * Margin interface for Gorilla Engine UI.
+     * Configures the positioning of the text element inside the components container. Provides more precise text alignment than the `textAlign` property.
+     */
     interface Margin {
+        /**
+         * Defines the margin properties that can be applied to UI elements.
+         */
         margin: number | {
+            /**The default margin for sides not explicitly set. */
             other: number;
+            /** The margin on the left side.*/
             left: number;
+            /** The margin on the top side.*/
             top: number;
+            /** The margin on the right side.*/
             right: number;
+            /** The margin on the bottom side.*/
             bottom: number;
         };
     }

gorilla-engine/interfaces/Scrollable.d.ts

@@ -1,5 +1,8 @@
 declare namespace GorillaEngine.UI {
     interface Scrollable {
+        /**
+         * Defines the color of the background, thumb and track of the scrollbar.
+         */
         scrollbar?: {
             background?: string;
             track?: string;

gorilla-engine/interfaces/Skinnable.d.ts

@@ -1,10 +1,27 @@
 declare namespace GorillaEngine.UI {
     interface Skinnable {
+        /**
+         * Defines properties for a filmstrip-based animation or visual sequence.
+         */
         filmstrip: {
+            /**
+             * The file path to the filmstrip image, which contains a series of animation frames.
+             */
             path: string;
+            /**
+             * The total number of individual frames contained within the filmstrip image.
+             */
             count: number;
+            /**
+             * Optional. Specifies the direction in which frames are arranged within the filmstrip (e.g., "horizontal", "vertical").
+             * If omitted, a default or inferred direction may be used.
+             */
             direction?: string;
         };
+        /**
+         * Reference to a LottieAnimation instance
+         * that this control is linked to.
+         */
         animation: LottieAnimation;
     }
 }

gorilla-engine/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/gorilla-engine",
-    "version": "1.1.30",
+    "version": "1.1.31",
     "description": "TypeScript definitions for gorilla-engine",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gorilla-engine",
     "license": "MIT",
@@ -46,7 +46,7 @@
     "scripts": {},
     "dependencies": {},
     "peerDependencies": {},
-    "typesPublisherContentHash": "d74b7b06a6e8240c4e1de8c898c82e44354e83cd90c3e8432d336a0386d2ed54",
+    "typesPublisherContentHash": "5e39daa6bc0c9e33f26203cfad41d9b1dcb89e4e943ed427f70e0dbdc2a11b29",
     "typeScriptVersion": "5.2",
     "nonNpm": true
 }