@ringozz/godot 0.1.0

package/gen/classes/BaseButton.ts

@@ -0,0 +1,164 @@
+// Auto-generated from extension_api.json - DO NOT EDIT
+// Generated by dev/codegen.ts
+
+import { _C, _R, _G } from '../../src/runtime.ts';
+import { Control } from './Control.ts';
+import type { MouseButtonMask } from '../global-enums.ts';
+import type { Signal } from '../heap-types/index.ts';
+import type { ButtonGroup } from './ButtonGroup.ts';
+import type { Shortcut } from './Shortcut.ts';
+
+/**
+ * {@link BaseButton} is an abstract base class for GUI buttons. It doesn't display anything by itself.
+ */
+export class BaseButton extends Control {
+    constructor(name = 146) { super(name); }
+
+    /**
+     * Changes the {@link buttonPressed} state of the button, without emitting {@link toggled}. Use when you just want to change the state of the button without sending the pressed event (e.g. when initializing scene). Only works if {@link toggleMode} is `true`.
+     * **Note:** This method doesn't unpress other buttons in {@link buttonGroup}.
+     */
+    setPressedNoSignal(pressed: boolean): void { _C(this, 12405, pressed); }
+
+    /**
+     * Returns `true` if the mouse has entered the button and has not left it yet.
+     */
+    isHovered(): boolean { return _C(this, 8001) as boolean; }
+
+    /**
+     * Returns the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the {@link DrawMode} enum.
+     */
+    getDrawMode(): DrawMode { return _C(this, 4567) as DrawMode; }
+
+    /**
+     * If `true`, the button is in disabled state and can't be clicked or toggled.
+     * **Note:** If the button is disabled while held down, {@link button_up} will be emitted.
+     */
+    get disabled(): boolean { return _C(this, 7883) as boolean; }
+    set disabled(v: boolean) { _C(this, 11122, v); }
+
+    /**
+     * If `true`, the button is in toggle mode. Makes the button flip state between pressed and unpressed each time its area is clicked.
+     */
+    get toggleMode(): boolean { return _C(this, 8366) as boolean; }
+    set toggleMode(v: boolean) { _C(this, 13106, v); }
+
+    /**
+     * If `true`, the button's state is pressed. Means the button is pressed down or toggled (if {@link toggleMode} is active). Only works if {@link toggleMode} is `true`.
+     * **Note:** Changing the value of {@link buttonPressed} will result in {@link toggled} to be emitted. If you want to change the pressed state without emitting that signal, use {@link setPressedNoSignal}.
+     */
+    get buttonPressed(): boolean { return _C(this, 8199) as boolean; }
+    set buttonPressed(v: boolean) { _C(this, 12404, v); }
+
+    /**
+     * Determines when the button is considered clicked.
+     */
+    get actionMode(): ActionMode { return _C(this, 3681) as ActionMode; }
+    set actionMode(v: ActionMode) { _C(this, 10418, v); }
+
+    /**
+     * Binary mask to choose which mouse buttons this button will respond to.
+     * To allow both left-click and right-click, use `MOUSE_BUTTON_MASK_LEFT | MOUSE_BUTTON_MASK_RIGHT`.
+     */
+    get buttonMask(): MouseButtonMask { return _C(this, 4036) as MouseButtonMask; }
+    set buttonMask(v: MouseButtonMask) { _C(this, 10767, v); }
+
+    /**
+     * If `true`, the button stays pressed when moving the cursor outside the button while pressing it.
+     * **Note:** This property only affects the button's visual appearance. Signals will be emitted at the same moment regardless of this property's value.
+     */
+    get keepPressedOutside(): boolean { return _C(this, 8056) as boolean; }
+    set keepPressedOutside(v: boolean) { _C(this, 11861, v); }
+
+    /**
+     * The {@link ButtonGroup} associated with the button. Not to be confused with node groups.
+     * **Note:** The button will be configured as a radio button if a {@link ButtonGroup} is assigned to it.
+     */
+    get buttonGroup(): ButtonGroup { return _C(this, 4031) as ButtonGroup; }
+    set buttonGroup(v: ButtonGroup) { _C(this, 10764, v); }
+
+    /**
+     * {@link Shortcut} associated to the button.
+     */
+    get shortcut(): Shortcut { return _C(this, 6377) as Shortcut; }
+    set shortcut(v: Shortcut) { _C(this, 12724, v); }
+
+    /**
+     * If `true`, the button will highlight for a short amount of time when its shortcut is activated. If `false` and {@link toggleMode} is `false`, the shortcut will activate without any visual feedback.
+     */
+    get shortcutFeedback(): boolean { return _C(this, 8303) as boolean; }
+    set shortcutFeedback(v: boolean) { _C(this, 12726, v); }
+
+    /**
+     * If `true`, the button will add information about its shortcut in the tooltip. This includes the shortcut's events and its {@link Resource.resourceName}. If both events and name are empty, the shortcut will not be included.
+     * **Note:** This property does nothing when the tooltip control is customized using {@link Control.MakeCustomTooltip}.
+     */
+    get shortcutInTooltip(): boolean { return _C(this, 8304) as boolean; }
+    set shortcutInTooltip(v: boolean) { _C(this, 12727, v); }
+
+    /**
+     * Emitted when the button is toggled or pressed. This is on {@link button_down} if {@link actionMode} is {@link ACTION_MODE_BUTTON_PRESS} and on {@link button_up} otherwise.
+     * If you need to know the button's pressed state (and {@link toggleMode} is active), use {@link toggled} instead.
+     */
+    get pressed(): Signal<() => void> { return _G(this, 9542) as Signal<() => void>; }
+    set pressed(v: (() => void) | null) { _G(this, 9542, v); }
+
+    /**
+     * Emitted when the button stops being held down.
+     */
+    get buttonUp(): Signal<() => void> { return _G(this, 1949) as Signal<() => void>; }
+    set buttonUp(v: (() => void) | null) { _G(this, 1949, v); }
+
+    /**
+     * Emitted when the button starts being held down.
+     */
+    get buttonDown(): Signal<() => void> { return _G(this, 1943) as Signal<() => void>; }
+    set buttonDown(v: (() => void) | null) { _G(this, 1943, v); }
+
+    /**
+     * Emitted when the button was just toggled between pressed and normal states (only if {@link toggleMode} is active). The new state is contained in the `toggledOn` argument.
+     */
+    get toggled(): Signal<(toggledOn: boolean) => void> { return _G(this, 14326) as Signal<(toggledOn: boolean) => void>; }
+    set toggled(v: ((toggledOn: boolean) => void) | null) { _G(this, 14326, v); }
+
+    static readonly name = _R(146, BaseButton);
+}
+
+export const DrawMode = {
+    /**
+     * The normal state (i.e. not pressed, not hovered, not toggled and enabled) of buttons.
+     */
+    DRAW_NORMAL: 0,
+    /**
+     * The state of buttons are pressed.
+     */
+    DRAW_PRESSED: 1,
+    /**
+     * The state of buttons are hovered.
+     */
+    DRAW_HOVER: 2,
+    /**
+     * The state of buttons are disabled.
+     */
+    DRAW_DISABLED: 3,
+    /**
+     * The state of buttons are both hovered and pressed.
+     */
+    DRAW_HOVER_PRESSED: 4,
+} as const;
+
+export type DrawMode = (typeof DrawMode)[keyof typeof DrawMode];
+
+export const ActionMode = {
+    /**
+     * Require just a press to consider the button clicked.
+     */
+    ACTION_MODE_BUTTON_PRESS: 0,
+    /**
+     * Require a press and a subsequent release before considering the button clicked.
+     */
+    ACTION_MODE_BUTTON_RELEASE: 1,
+} as const;
+
+export type ActionMode = (typeof ActionMode)[keyof typeof ActionMode];
+