@nativewrappers/fivem 0.0.1

package/lib/client/ui/Timerbar.js

@@ -0,0 +1,241 @@
+import { HudComponent } from '../enums';
+import { Color, Point, Size } from '../utils';
+import { Hud } from './Hud';
+import { LoadingPrompt } from './LoadingPrompt';
+import { Screen } from './Screen';
+import { Sprite } from './Sprite';
+/** @internal */
+const activeTimerBars = [];
+/** @internal */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const drawText = (text, position, options) => {
+    options = {
+        ...{
+            align: 1,
+            color: [255, 255, 255, 255],
+            font: 4,
+            outline: true,
+            scale: 0.3,
+            shadow: true,
+        },
+        ...options,
+    };
+    const font = options.font;
+    const scale = options.scale;
+    const outline = options.outline;
+    const shadow = options.shadow;
+    const color = options.color;
+    const align = options.align;
+    SetTextEntry('CELL_EMAIL_BCON');
+    for (let i = 0; i < text.length; i += 99) {
+        const subStringText = text.substr(i, Math.min(99, text.length - i));
+        AddTextComponentSubstringPlayerName(subStringText);
+    }
+    SetTextFont(font);
+    SetTextScale(scale, scale);
+    SetTextColour(color[0], color[1], color[2], color[3]);
+    if (shadow) {
+        SetTextDropShadow();
+    }
+    if (outline) {
+        SetTextOutline();
+    }
+    switch (align) {
+        case 1: {
+            SetTextCentre(true);
+            break;
+        }
+        case 2: {
+            SetTextRightJustify(true);
+            SetTextWrap(0.0, position[0] || 0);
+            break;
+        }
+    }
+    DrawText(position[0] || 0, position[1] || 0);
+};
+/**
+ * Create a Timerbar. It's automatically added to the internal Timerbar array and drawn in a FIFO (first in, first out) way.
+ *
+ * ```typescript
+ * // Create simple Timerbar
+ * const myTimerbar = new Cfx.Timerbar("Hello");
+ * myTimerbar.Text = "World";
+ *
+ * // Disable Timerbar later on
+ * myTimerbar.Visible = false;
+ * ```
+ */
+export class Timerbar {
+    constructor(title, useProgressBar = false) {
+        this.title = '';
+        this.text = '';
+        this.useProgressBar = false;
+        this.usePlayerStyle = false;
+        this.isVisible = false;
+        this.pbarValue = 0.0;
+        this.textColor = [240, 240, 240, 255];
+        this.pbarBgColor = [155, 155, 155, 255];
+        this.pbarFgColor = [255, 255, 255, 255];
+        this.title = title;
+        this.useProgressBar = useProgressBar;
+        this.text = '';
+        this.pbarValue = 0.0;
+        this.textColor = [240, 240, 240, 255];
+        this.pbarBgColor = [155, 155, 155, 255];
+        this.pbarFgColor = [255, 255, 255, 255];
+        this.usePlayerStyle = false;
+        const safeZone = GetSafeZoneSize();
+        const safeZoneX = (1.0 - safeZone) * 0.5;
+        const safeZoneY = (1.0 - safeZone) * 0.5;
+        this.sprite = new Sprite('timerbars', 'all_black_bg', new Point(Screen.ScaledWidth * 0.918 - safeZoneX, Screen.Height * 0.984 - safeZoneY), new Size(Screen.ScaledWidth * 0.165, Screen.Height * 0.035), 0, new Color(160, 255, 255, 255));
+        if (!this.sprite.IsTextureDictionaryLoaded) {
+            this.sprite.loadTextureDictionary();
+        }
+        this.isVisible = true;
+        activeTimerBars.push(this);
+    }
+    get Title() {
+        return this.title;
+    }
+    set Title(value) {
+        this.title = value;
+    }
+    get Text() {
+        return this.text;
+    }
+    set Text(value) {
+        this.text = value;
+    }
+    get UseProgressBar() {
+        return this.useProgressBar;
+    }
+    get Progress() {
+        return this.pbarValue;
+    }
+    set Progress(value) {
+        this.pbarValue = value <= 0.0 ? 0.0 : value >= 1.0 ? 1.0 : value;
+    }
+    get Visible() {
+        return this.isVisible;
+    }
+    set Visible(value) {
+        const idx = activeTimerBars.indexOf(this);
+        if (value) {
+            if (idx !== -1) {
+                return;
+            }
+            activeTimerBars.push(this);
+        }
+        else {
+            if (idx === -1) {
+                return;
+            }
+            activeTimerBars.splice(idx, 1);
+        }
+        this.isVisible = value;
+    }
+    get TextColor() {
+        return this.textColor;
+    }
+    set TextColor(value) {
+        if (Array.isArray(value)) {
+            this.textColor = value;
+        }
+        else {
+            const result = GetHudColour(value);
+            this.textColor = [result[0], result[1], result[2], result[3]];
+        }
+    }
+    get ProgressbarBgColor() {
+        return this.pbarBgColor;
+    }
+    set ProgressbarBgColor(value) {
+        if (Array.isArray(value)) {
+            this.pbarBgColor = value;
+        }
+        else {
+            const result = GetHudColour(value);
+            this.pbarBgColor = [result[0], result[1], result[2], result[3]];
+        }
+    }
+    get ProgressbarFgColor() {
+        return this.pbarFgColor;
+    }
+    set ProgressbarFgColor(value) {
+        if (Array.isArray(value)) {
+            this.pbarFgColor = value;
+        }
+        else {
+            const result = GetHudColour(value);
+            this.pbarFgColor = [result[0], result[1], result[2], result[3]];
+        }
+    }
+    set PlayerStyle(value) {
+        this.usePlayerStyle = value;
+    }
+    get PlayerStyle() {
+        return this.usePlayerStyle;
+    }
+    get Sprite() {
+        return this.sprite;
+    }
+}
+setTick(() => {
+    if (activeTimerBars.length <= 0) {
+        return;
+    }
+    const safeZone = GetSafeZoneSize();
+    const safeZoneX = (1.0 - safeZone) * 0.5;
+    const safeZoneY = (1.0 - safeZone) * 0.5;
+    Hud.hideComponentThisFrame(HudComponent.AreaName);
+    Hud.hideComponentThisFrame(HudComponent.StreetName);
+    let loadingPromptOffset = 0;
+    if (LoadingPrompt.IsActive) {
+        loadingPromptOffset = 0.035 + 0.035 * 0.038 * 2;
+    }
+    activeTimerBars.forEach(timerbar => {
+        const drawY = 0.984 - loadingPromptOffset - safeZoneY - activeTimerBars.indexOf(timerbar) * 0.038;
+        DrawSprite('timerbars', 'all_black_bg', 0.918 - safeZoneX, drawY, 0.165, 0.035, 0.0, 255, 255, 255, 160);
+        drawText(timerbar.Title, [0.918 - safeZoneX + 0.012, drawY - 0.009 - (timerbar.PlayerStyle ? 0.00625 : 0)], {
+            align: 2,
+            color: timerbar.TextColor,
+            font: timerbar.PlayerStyle ? 4 : 0,
+            outline: false,
+            scale: timerbar.PlayerStyle ? 0.465 : 0.3,
+            shadow: timerbar.PlayerStyle,
+        });
+        if (timerbar.UseProgressBar) {
+            const pbarX = 0.918 - safeZoneX + 0.047;
+            const pbarY = drawY + 0.0015;
+            const width = 0.0616 * timerbar.Progress;
+            DrawRect(pbarX, pbarY, 0.0616, 0.0105, typeof timerbar.ProgressbarBgColor === 'number'
+                ? timerbar.ProgressbarBgColor
+                : timerbar.ProgressbarBgColor[0], typeof timerbar.ProgressbarBgColor === 'number'
+                ? timerbar.ProgressbarBgColor
+                : timerbar.ProgressbarBgColor[1], typeof timerbar.ProgressbarBgColor === 'number'
+                ? timerbar.ProgressbarBgColor
+                : timerbar.ProgressbarBgColor[2], typeof timerbar.ProgressbarBgColor === 'number'
+                ? timerbar.ProgressbarBgColor
+                : timerbar.ProgressbarBgColor[3]);
+            DrawRect(pbarX - 0.0616 / 2 + width / 2, pbarY, width, 0.0105, typeof timerbar.ProgressbarFgColor === 'number'
+                ? timerbar.ProgressbarFgColor
+                : timerbar.ProgressbarFgColor[0], typeof timerbar.ProgressbarFgColor === 'number'
+                ? timerbar.ProgressbarFgColor
+                : timerbar.ProgressbarFgColor[1], typeof timerbar.ProgressbarFgColor === 'number'
+                ? timerbar.ProgressbarFgColor
+                : timerbar.ProgressbarFgColor[2], typeof timerbar.ProgressbarFgColor === 'number'
+                ? timerbar.ProgressbarFgColor
+                : timerbar.ProgressbarFgColor[3]);
+        }
+        else {
+            drawText(timerbar.Text, [0.918 - safeZoneX + 0.0785, drawY + -0.0165], {
+                align: 2,
+                color: timerbar.TextColor,
+                font: 0,
+                outline: false,
+                scale: 0.425,
+                shadow: false,
+            });
+        }
+    });
+});

package/lib/client/ui/index.d.ts

@@ -0,0 +1,15 @@
+export * from './interfaces';
+export { Rectangle } from './Rectangle';
+export { Container } from './Container';
+export { Effects } from './Effects';
+export { Fading } from './Fading';
+export { Hud } from './Hud';
+export { InstructionalButtons } from './InstructionalButtons';
+export { LoadingPrompt } from './LoadingPrompt';
+export { Notification } from './Notification';
+export { Scaleform } from './Scaleform';
+export { Screen } from './Screen';
+export { Sprite } from './Sprite';
+export { Text } from './Text';
+export { Timerbar } from './Timerbar';
+export * from './menu';

package/lib/client/ui/index.js

@@ -0,0 +1,15 @@
+export * from './interfaces';
+export { Rectangle } from './Rectangle';
+export { Container } from './Container';
+export { Effects } from './Effects';
+export { Fading } from './Fading';
+export { Hud } from './Hud';
+export { InstructionalButtons } from './InstructionalButtons';
+export { LoadingPrompt } from './LoadingPrompt';
+export { Notification } from './Notification';
+export { Scaleform } from './Scaleform';
+export { Screen } from './Screen';
+export { Sprite } from './Sprite';
+export { Text } from './Text';
+export { Timerbar } from './Timerbar';
+export * from './menu';

package/lib/client/ui/interfaces/IButton.d.ts

@@ -0,0 +1,5 @@
+import { Control } from '../../enums';
+export interface IButton {
+    controls: Control[];
+    label: string;
+}

package/lib/client/ui/interfaces/IButton.js

@@ -0,0 +1 @@
+export {};

package/lib/client/ui/interfaces/IDrawable.d.ts

@@ -0,0 +1,7 @@
+import { Color, Point, Size } from '../../utils/';
+export interface IDrawable {
+    pos: Point;
+    size?: Size;
+    color?: Color;
+    draw(offset?: Size, resolution?: Size): void;
+}

package/lib/client/ui/interfaces/IDrawable.js

@@ -0,0 +1 @@
+export {};

package/lib/client/ui/interfaces/index.d.ts

@@ -0,0 +1,2 @@
+export { IDrawable } from './IDrawable';
+export { IButton } from './IButton';

package/lib/client/ui/interfaces/index.js

@@ -0,0 +1 @@
+export {};

package/lib/client/ui/menu/Menu.d.ts

@@ -0,0 +1,108 @@
+import { MenuControls, MenuSettings } from '../';
+import { Font, MenuAlignment } from '../../enums';
+import { Color, LiteEvent, Point, Size } from '../../utils';
+import { UIMenuItem } from './items';
+export declare class Menu {
+    static screenAspectRatio: number;
+    static screenHeight: number;
+    static screenWidth: number;
+    static screenResolution: Size;
+    readonly id: string;
+    visible: boolean;
+    parentMenu: Menu | undefined;
+    parentItem: UIMenuItem | undefined;
+    items: UIMenuItem[];
+    children: Map<string, Menu>;
+    readonly menuOpen: LiteEvent;
+    readonly menuClose: LiteEvent;
+    readonly menuChange: LiteEvent;
+    readonly indexChange: LiteEvent;
+    readonly listChange: LiteEvent;
+    readonly sliderChange: LiteEvent;
+    readonly checkboxChange: LiteEvent;
+    readonly listSelect: LiteEvent;
+    readonly sliderSelect: LiteEvent;
+    readonly itemSelect: LiteEvent;
+    readonly panelActivated: LiteEvent;
+    private _counterPretext;
+    private _counterOverride;
+    private _alignment;
+    private _offset;
+    private _navigationDelay;
+    private _lastUpDownNavigation;
+    private _lastLeftRightNavigation;
+    private _activeItem;
+    private _widthOffset;
+    private _drawOffset;
+    private _justOpened;
+    private _mousePressed;
+    private _minItem;
+    private _maxItem;
+    private _maxItemsOnScreen;
+    private _controls;
+    private _settings;
+    private readonly _title;
+    private readonly _subtitle;
+    private readonly _mainMenu;
+    private readonly _logo;
+    private readonly _upAndDownSprite;
+    private readonly _subtitleResRectangle;
+    private readonly _extraRectangleUp;
+    private readonly _extraRectangleDown;
+    private readonly _descriptionBar;
+    private readonly _descriptionRectangle;
+    private readonly _descriptionText;
+    private readonly _counterText;
+    private readonly _background;
+    constructor(title: string, subtitle: string, offset?: Point, spriteLibrary?: string, spriteName?: string);
+    set Title(text: string);
+    get Title(): string;
+    get TitleFont(): Font;
+    set TitleFont(font: Font);
+    set Subtitle(text: string);
+    get Subtitle(): string;
+    set SubtitleFont(font: Font);
+    get SubtitleFont(): Font;
+    set SubtitleForeColor(color: Color);
+    get SubtitleForeColor(): Color;
+    set SubtitleBackColor(color: Color);
+    get SubtitleBackColor(): Color;
+    get CurrentItem(): UIMenuItem;
+    set CurrentItem(value: UIMenuItem);
+    get CurrentSelection(): number;
+    set CurrentSelection(v: number);
+    get Alignment(): MenuAlignment;
+    set Alignment(alignment: MenuAlignment);
+    get WidthOffset(): number;
+    set WidthOffset(widthOffset: number);
+    get DrawOffset(): Point;
+    get Controls(): MenuControls;
+    get Settings(): MenuSettings;
+    addNewSubMenu(text: string, description?: string, inherit?: boolean): Menu;
+    addSubMenu(subMenuToAdd: Menu, text: string, description?: string, inherit?: boolean): Menu;
+    addItem(items: UIMenuItem | UIMenuItem[]): void;
+    removeItem(itemOrIndex: UIMenuItem | number): void;
+    bindMenuToItem(menuToBind: Menu, itemToBindTo: UIMenuItem): void;
+    releaseMenuFromItem(releaseFrom: UIMenuItem): boolean;
+    refreshIndex(): void;
+    clear(): void;
+    open(): void;
+    close(): void;
+    goLeft(): void;
+    goRight(): void;
+    selectItem(): void;
+    isMouseInBounds(pos: Point, size: Size, drawOffset?: boolean): boolean;
+    goUp(): void;
+    goDown(): void;
+    goBack(): void;
+    private _processMouse;
+    private _processControl;
+    private _isThereAnyItemExcludingSeparators;
+    private _playSoundAndReleaseId;
+    private _disEnableControls;
+    private _recalculateUpAndDown;
+    private _recalculateDescriptionPosition;
+    private _calculateItemHeight;
+    private _calculatePanelPosition;
+    private _render;
+}