@nativewrappers/fivem 0.0.64 → 0.0.72

package/ui/InstructionalButtons.js

@@ -1,54 +0,0 @@
-import { Scaleform } from "./Scaleform";
-/**
- * Draw native instructional buttons in the bottom left of the screen using scaleform
- *
- * Example:
- *
- * ```typescript
- * import { InstructionalButtons, Control } from '@nativewrappers/client';
- *
- * const buttons = new InstructionalButtons([
- *  {controls: [Control.Context], label: "Interact with Bob"},
- *  {controls: [Control.Detonate], label: "Say hello to Alice"}
- * ])
- *
- * setTick(() => {
- *   buttons.draw()
- * })
- * ```
- */
-export class InstructionalButtons {
-    scaleform;
-    /**
-     * Draws native instructional buttons
-     *
-     * @param buttons Array of instructional buttons to be drawn
-     */
-    constructor(buttons) {
-        this.scaleform = new Scaleform("INSTRUCTIONAL_BUTTONS");
-        this.scaleform.callFunction("CLEAR_ALL");
-        this.scaleform.callFunction("SET_CLEAR_SPACE", 200);
-        buttons.forEach((button, index) => {
-            this.pushButton(button, index);
-        });
-        this.scaleform.callFunction("DRAW_INSTRUCTIONAL_BUTTONS");
-        this.scaleform.callFunction("SET_BACKGROUND_COLOUR", 0, 0, 0, 80);
-    }
-    pushButton(button, index) {
-        BeginScaleformMovieMethod(this.scaleform.Handle, "SET_DATA_SLOT");
-        PushScaleformMovieFunctionParameterInt(index);
-        // Looping backwards here since scaleform is using a stack so the first control ends up being the last
-        // So looping backwards makes more sense here so that the controls are rendered in the order they're defined
-        for (let i = button.controls.length - 1; i >= 0; i--) {
-            PushScaleformMovieMethodParameterButtonName(GetControlInstructionalButton(2, button.controls[i], true));
-        }
-        PushScaleformMovieMethodParameterString(button.label);
-        EndScaleformMovieMethod();
-    }
-    /**
-     * Renders the instructional button scaleform
-     */
-    async draw() {
-        await this.scaleform.render2D();
-    }
-}

package/ui/LoadingPrompt.js

@@ -1,45 +0,0 @@
-import { LoadingSpinnerType } from "../enums";
-/**
- * Show and hide loading prompt on the bottom right of the screen.
- *
- * Example:
- *
- * ```typescript
- * import { LoadingPrompt } from '@nativewrappers/client/ui';
- *
- * LoadingPrompt.show("Hello World");
- *
- * setTimeout(() => {
- *  LoadingPrompt.hide();
- * }, 10000)'
- * ```
- */
-export class LoadingPrompt {
-    /**
-     * Shows a loading prompt.
-     *
-     * @param loadingText Text to be displayed inside loading prompt.
-     * @param spinnerType Type of spinner.
-     */
-    static show(loadingText = "", spinnerType = LoadingSpinnerType.RegularClockwise) {
-        if (this.IsActive) {
-            this.hide();
-        }
-        if (loadingText === "") {
-            BeginTextCommandBusyString("");
-        }
-        else {
-            BeginTextCommandBusyString("STRING");
-            AddTextComponentSubstringPlayerName(loadingText);
-        }
-        EndTextCommandBusyString(Number(spinnerType));
-    }
-    static hide() {
-        if (this.IsActive) {
-            RemoveLoadingPrompt();
-        }
-    }
-    static get IsActive() {
-        return IsLoadingPromptBeingDisplayed();
-    }
-}

package/ui/Notification.js

@@ -1,9 +0,0 @@
-export class Notification {
-    handle;
-    constructor(handle) {
-        this.handle = handle;
-    }
-    hide() {
-        RemoveNotification(this.handle);
-    }
-}

package/ui/Rectangle.js

@@ -1,40 +0,0 @@
-import { Point, Size } from "../utils";
-import { Screen } from "./";
-export class Rectangle {
-    pos;
-    size;
-    color;
-    constructor(pos, size, color) {
-        this.pos = pos;
-        this.size = size;
-        this.color = color;
-    }
-    draw(arg1, arg2, color, resolution) {
-        resolution = color === undefined ? arg2 : resolution;
-        resolution = resolution || new Size(Screen.ScaledWidth, Screen.Height);
-        if (color === undefined) {
-            if (arg1 && arg1 instanceof Size) {
-                arg1 = new Point(this.pos.X + arg1.width, this.pos.Y + arg1.height);
-            }
-            else {
-                arg1 = this.pos;
-            }
-            arg2 = this.size;
-        }
-        else {
-            if (!arg1) {
-                arg1 = this.pos;
-            }
-            else {
-                arg1 = arg1;
-            }
-            arg2 = arg2 || this.size;
-        }
-        color = color || this.color;
-        const w = arg2.width / resolution.width;
-        const h = arg2.height / resolution.height;
-        const x = arg1.X / resolution.width + w * 0.5;
-        const y = arg1.Y / resolution.height + h * 0.5;
-        DrawRect(x, y, w, h, color.r, color.g, color.b, color.a);
-    }
-}

package/ui/Scaleform.js

@@ -1,236 +0,0 @@
-/**
- * Scaleforms will automatically load when calling any of the render functions.
- *
- * Example:
- *
- * ```typescript
- * import { Scaleform } from '@nativewrappers/client/ui';
- *
- * const scaleform = new Cfx.Scaleform("MIDSIZED_MESSAGE");
- *
- * scaleform.callFunction("SHOW_MIDSIZED_MESSAGE", ["Title", "Message"]);
- *
- * setTick(() => {
- *  await scaleform.render2D();
- * });
- * ```
- */
-export class Scaleform {
-    static render2DMasked(scaleform1, scaleform2) {
-        return new Promise(async (resolve) => {
-            if (scaleform1.IsLoaded && scaleform2.IsLoaded) {
-                DrawScaleformMovieFullscreenMasked(scaleform1.Handle, scaleform2.Handle, 255, 255, 255, 255);
-            }
-            else {
-                await scaleform1.load();
-                await scaleform2.load();
-            }
-            resolve();
-        });
-    }
-    handle;
-    name;
-    loaded = false;
-    constructor(name) {
-        this.name = name;
-        this.handle = RequestScaleformMovie(this.name);
-    }
-    /**
-     * Get the handle of the scaleform.
-     */
-    get Handle() {
-        return this.handle;
-    }
-    /**
-     * Get whether the handle is a valid handle.
-     */
-    get IsValid() {
-        return this.handle !== 0;
-    }
-    /**
-     * Get whether the scaleform is loaded.
-     */
-    get IsLoaded() {
-        if (!this.loaded) {
-            this.loaded = HasScaleformMovieLoaded(this.handle);
-        }
-        return this.loaded;
-    }
-    /**
-     * Dispose the scaleform allowing the GTA engine to free memory when wanted.
-     */
-    dispose() {
-        if (this.IsLoaded) {
-            SetScaleformMovieAsNoLongerNeeded(this.handle);
-            this.loaded = false;
-        }
-    }
-    /**
-     * Call a function on the scaleform.
-     *
-     * @param name Name of the function
-     * @param args Additional arguments
-     */
-    callFunction(name, ...args) {
-        BeginScaleformMovieMethod(this.handle, name);
-        args.forEach((arg) => {
-            switch (typeof arg) {
-                case "number":
-                    PushScaleformMovieFunctionParameterInt(arg);
-                    break;
-                case "string":
-                    PushScaleformMovieFunctionParameterString(arg);
-                    break;
-                case "boolean":
-                    PushScaleformMovieFunctionParameterBool(arg);
-                    break;
-                default:
-                    throw new Error(`Unknown argument type [${typeof arg}] passed to scaleform with handle [${this.handle}], had value of ${arg}`);
-            }
-        });
-        EndScaleformMovieMethod();
-    }
-    /**
-     * Calls a void method on the scaleform.
-     *
-     * @param name Name of the function
-     */
-    callVoidMethod(name) {
-        CallScaleformMovieMethod(this.handle, name);
-    }
-    /**
-     * Calls a string method on the scaleform.
-     *
-     * @param name Name of the function
-     * @param param1
-     * @param param2
-     * @param param3
-     * @param param4
-     * @param param5
-     */
-    callStringMethod(name, param1 = "", param2 = "", param3 = "", param4 = "", param5 = "") {
-        CallScaleformMovieMethodWithString(this.handle, name, param1, param2, param3, param4, param5);
-    }
-    /**
-     * Calls a number method on the scaleform.
-     *
-     * @param name Name of the function
-     * @param param1
-     * @param param2
-     * @param param3
-     * @param param4
-     * @param param5
-     */
-    callNumberMethod(name, param1 = -1.0, param2 = -1.0, param3 = -1.0, param4 = -1.0, param5 = -1.0) {
-        CallScaleformMovieMethodWithNumber(this.handle, name, param1, param2, param3, param4, param5);
-    }
-    /**
-     * Calls a number & string method on the scaleform.
-     *
-     * @param name Name of the function
-     * @param fParam1
-     * @param fParam2
-     * @param fParam3
-     * @param fParam4
-     * @param fParam5
-     * @param sParam1
-     * @param sParam2
-     * @param sParam3
-     * @param sParam4
-     * @param sParam5
-     */
-    callSharedMethod(name, fParam1 = -1.0, fParam2 = -1.0, fParam3 = -1.0, fParam4 = -1.0, fParam5 = -1.0, sParam1 = "", sParam2 = "", sParam3 = "", sParam4 = "", sParam5 = "") {
-        CallScaleformMovieMethodWithNumberAndString(this.handle, name, fParam1, fParam2, fParam3, fParam4, fParam5, sParam1, sParam2, sParam3, sParam4, sParam5);
-    }
-    /**
-     * Sets a duration the scaleform should be shown.
-     * Useful for showing a scaleform for a known amount of time, such as messages.
-     *
-     * This only works for any scaleform using {@linkcode render2D};
-     *
-     * @param duration Duration in milliseconds
-     */
-    setDuration(duration) {
-        if (duration <= 0) {
-            return;
-        }
-        const start = GetGameTimer();
-        const interval = setInterval(async () => {
-            if (GetGameTimer() - start < duration) {
-                await this.render2D();
-            }
-            else {
-                clearInterval(interval);
-            }
-        }, 0);
-    }
-    render2D() {
-        return new Promise(async (resolve) => {
-            if (this.IsLoaded) {
-                DrawScaleformMovieFullscreen(this.handle, 255, 255, 255, 255, 0);
-            }
-            else {
-                await this.load();
-            }
-            resolve();
-        });
-    }
-    render2DScreenSpace(location, size) {
-        return new Promise(async (resolve) => {
-            if (this.IsLoaded) {
-                const x = location.x; /* UI.Screen.Width*/
-                const y = location.y; /* UI.Screen.Height*/
-                const width = size.x; /* UI.Screen.Width*/
-                const height = size.y; /* UI.Screen.Height*/
-                DrawScaleformMovie(this.handle, x + width / 2, y + height / 2, width, height, 255, 255, 255, 255, 0);
-            }
-            else {
-                await this.load();
-            }
-            resolve();
-        });
-    }
-    render3D(position, rotation, scale) {
-        return new Promise(async (resolve) => {
-            if (this.IsLoaded) {
-                DrawScaleformMovie_3dNonAdditive(this.handle, position.x, position.y, position.z, rotation.x, rotation.y, rotation.z, 2, 2, 1, scale.x, scale.y, scale.z, 2);
-            }
-            else {
-                await this.load();
-            }
-            resolve();
-        });
-    }
-    render3DAdditive(position, rotation, scale) {
-        return new Promise(async (resolve) => {
-            if (this.IsLoaded) {
-                DrawScaleformMovie_3d(this.handle, position.x, position.y, position.z, rotation.x, rotation.y, rotation.z, 2, 2, 1, scale.x, scale.y, scale.z, 2);
-            }
-            else {
-                await this.load();
-            }
-            resolve();
-        });
-    }
-    load() {
-        return new Promise((resolve) => {
-            if (this.IsLoaded) {
-                resolve(true);
-            }
-            else {
-                const start = GetGameTimer();
-                const interval = setInterval(() => {
-                    if (this.IsLoaded) {
-                        clearInterval(interval);
-                        resolve(true);
-                    }
-                    else if (GetGameTimer() - start > 5000) {
-                        clearInterval(interval);
-                        console.log(`^1[fivemjs/client] Could not load scaleform ${this.name}!^7`);
-                        resolve(false);
-                    }
-                }, 0);
-            }
-        });
-    }
-}

package/ui/Screen.js

@@ -1,72 +0,0 @@
-import { Audio } from "../Audio";
-import { HudColor, NotificationType } from "../enums";
-import { Color, Size, String } from "../utils";
-import { Notification } from "./";
-export class Screen {
-    static get Resolution() {
-        const [width, height] = GetScreenActiveResolution();
-        return new Size(width, height);
-    }
-    static get ScaledResolution() {
-        const height = this.Height;
-        return new Size(height * this.AspectRatio, height);
-    }
-    static get Width() {
-        return this.Resolution.width;
-    }
-    static get ScaledWidth() {
-        return this.Height * this.AspectRatio;
-    }
-    static get Height() {
-        return this.Resolution.height;
-    }
-    static get AspectRatio() {
-        return GetAspectRatio(false);
-    }
-    static showSubtitle(message, duration = 2500) {
-        const strings = String.stringToArray(message);
-        BeginTextCommandPrint("CELL_EMAIL_BCON");
-        strings.forEach((element) => {
-            AddTextComponentSubstringPlayerName(element);
-        });
-        EndTextCommandPrint(duration, true);
-    }
-    static displayHelpTextThisFrame(message) {
-        const strings = String.stringToArray(message);
-        BeginTextCommandDisplayHelp("CELL_EMAIL_BCON");
-        strings.forEach((element) => {
-            AddTextComponentSubstringPlayerName(element);
-        });
-        EndTextCommandDisplayHelp(0, false, false, -1);
-    }
-    static showNotification(message, blinking = false) {
-        const strings = String.stringToArray(message);
-        SetNotificationTextEntry("CELL_EMAIL_BCON");
-        strings.forEach((element) => {
-            AddTextComponentSubstringPlayerName(element);
-        });
-        return new Notification(DrawNotification(blinking, true));
-    }
-    static showAdvancedNotification(message, title, subtitle, iconSet, icon, bgColor = HudColor.NONE, flashColor = Color.Transparent, blinking = false, type = NotificationType.Default, showInBrief = true, sound = true) {
-        const strings = String.stringToArray(message);
-        SetNotificationTextEntry("CELL_EMAIL_BCON");
-        strings.forEach((element) => {
-            AddTextComponentSubstringPlayerName(element);
-        });
-        if (bgColor !== HudColor.NONE) {
-            SetNotificationBackgroundColor(Number(bgColor));
-        }
-        if (flashColor !== Color.Transparent && blinking) {
-            SetNotificationFlashColor(flashColor.r, flashColor.g, flashColor.b, flashColor.a);
-        }
-        if (sound) {
-            Audio.playSoundFrontEnd("DELETE", "HUD_DEATHMATCH_SOUNDSET");
-        }
-        SetNotificationMessage(iconSet, icon, true, Number(type), title, subtitle);
-        return new Notification(DrawNotification(blinking, showInBrief));
-    }
-    static worldToScreen(position, scaleWidth = false) {
-        const coords = GetScreenCoordFromWorldCoord(position.x, position.y, position.z);
-        return new Size(coords[1] * (scaleWidth ? this.ScaledWidth : this.Width), coords[2] * this.Height);
-    }
-}

package/ui/Sprite.js

@@ -1,60 +0,0 @@
-import { Color, Point, Size } from "../utils";
-import { Screen } from "./";
-export class Sprite {
-    textureName;
-    pos;
-    size;
-    heading;
-    color;
-    visible;
-    _textureDict;
-    constructor(textureDict, textureName, pos, size, heading = 0, color = Color.White) {
-        this._textureDict = textureDict;
-        this.textureName = textureName;
-        this.pos = pos || new Point();
-        this.size = size || new Size();
-        this.heading = heading || 0;
-        this.color = color || Color.White;
-        this.visible = true;
-    }
-    loadTextureDictionary() {
-        RequestStreamedTextureDict(this._textureDict, true);
-        const interval = setInterval(() => {
-            if (this.IsTextureDictionaryLoaded) {
-                clearInterval(interval);
-            }
-        }, 0);
-    }
-    set TextureDict(v) {
-        this._textureDict = v;
-        if (!this.IsTextureDictionaryLoaded) {
-            this.loadTextureDictionary();
-        }
-    }
-    get TextureDict() {
-        return this._textureDict;
-    }
-    get IsTextureDictionaryLoaded() {
-        return HasStreamedTextureDictLoaded(this._textureDict);
-    }
-    draw(arg1, textureName, pos, size, heading, color, loadTexture = true, resolution) {
-        const textureDictionary = arg1 && typeof arg1 === "string" ? arg1 : this.TextureDict;
-        textureName = textureName || this.textureName;
-        pos = pos || this.pos;
-        size = size || this.size;
-        heading = heading || this.heading;
-        color = color || this.color;
-        if (loadTexture) {
-            if (!HasStreamedTextureDictLoaded(textureDictionary)) {
-                RequestStreamedTextureDict(textureDictionary, false);
-            }
-        }
-        resolution = arg1 instanceof Size ? arg1 : resolution;
-        resolution = resolution || new Size(Screen.ScaledWidth, Screen.Height);
-        const w = size.width / resolution.width;
-        const h = size.height / resolution.height;
-        const x = pos.X / resolution.width + w * 0.5;
-        const y = pos.Y / resolution.height + h * 0.5;
-        DrawSprite(textureDictionary, textureName, x, y, w, h, heading, color.r, color.g, color.b, color.a);
-    }
-}

package/ui/Text.js

@@ -1,115 +0,0 @@
-import { Alignment, Font } from "../enums";
-import { Color, Point, Size } from "../utils";
-import { Screen } from "./";
-export class Text {
-    static draw(caption, pos, scale = 1, color = Color.White, font = Font.ChaletLondon, alignment = Alignment.Left, dropShadow = false, outline = false, wordWrap, resolution) {
-        resolution = resolution || new Size(Screen.ScaledWidth, Screen.Height);
-        const x = pos.X / resolution.width;
-        const y = pos.Y / resolution.height;
-        SetTextFont(Number(font));
-        SetTextScale(1.0, scale);
-        SetTextColour(color.r, color.g, color.b, color.a);
-        if (dropShadow) {
-            SetTextDropshadow(2, 0, 0, 0, 0);
-        }
-        if (outline) {
-            SetTextOutline();
-        }
-        switch (alignment) {
-            case Alignment.Centered:
-                SetTextCentre(true);
-                break;
-            case Alignment.Right:
-                SetTextRightJustify(true);
-                if (!wordWrap) {
-                    SetTextWrap(0.0, x);
-                }
-                break;
-        }
-        if (wordWrap) {
-            SetTextWrap(x, (pos.X + wordWrap.width) / resolution.width);
-        }
-        SetTextEntry("STRING");
-        Text.addLongString(caption);
-        DrawText(x, y);
-    }
-    static addLongString(str) {
-        const strLen = 99;
-        for (let i = 0; i < str.length; i += strLen) {
-            // TODO: Fix deprecation warning
-            const substr = str.substr(i, Math.min(strLen, str.length - i));
-            AddTextComponentSubstringPlayerName(substr);
-        }
-    }
-    caption;
-    pos;
-    scale;
-    color;
-    font;
-    alignment;
-    dropShadow;
-    outline;
-    wordWrap;
-    /**
-     *
-     * @param caption Text to display
-     * @param pos Position of text relative to alignment. In pixels.
-     * @param scale Size of text. Default 1.0
-     * @param color Color of text. Default black.
-     * @param font Font of text. Default Chalet London.
-     * @param alignment Alignment of text. Default Left.
-     * @param dropShadow
-     * @param outline
-     * @param wordWrap
-     */
-    constructor(caption, pos, scale = 1, color = Color.White, font = Font.ChaletLondon, alignment = Alignment.Left, dropShadow = false, outline = false, wordWrap = new Size(500, 300)) {
-        this.caption = caption;
-        this.pos = pos;
-        this.scale = scale;
-        this.color = color;
-        this.font = font;
-        this.alignment = alignment;
-        this.dropShadow = dropShadow;
-        this.outline = outline;
-        this.wordWrap = wordWrap;
-    }
-    draw(arg1, arg2, scale, color, font, alignment, dropShadow, outline, wordWrap, resolution) {
-        resolution = arg2 instanceof Size ? arg2 : resolution;
-        if (scale === undefined) {
-            if (arg1 && arg1 instanceof Size) {
-                arg2 = new Point(this.pos.X + arg1.width, this.pos.Y + arg1.height);
-            }
-            else {
-                arg2 = this.pos;
-            }
-            arg1 = this.caption;
-            scale = this.scale;
-            color = this.color;
-            font = this.font;
-            alignment = this.alignment;
-            dropShadow = this.dropShadow;
-            outline = this.outline;
-            wordWrap = this.wordWrap;
-        }
-        else {
-            arg1 = arg1 || this.caption;
-            if (!arg2) {
-                arg2 = this.pos;
-            }
-            else {
-                arg2 = arg2;
-            }
-            scale = scale !== undefined && scale !== null ? scale : this.scale;
-            color = color || this.color;
-            font = font !== undefined && font !== null ? font : this.font;
-            alignment =
-                alignment !== undefined && alignment !== null
-                    ? alignment
-                    : this.alignment;
-            dropShadow = typeof dropShadow === "boolean" ? dropShadow : dropShadow;
-            outline = typeof outline === "boolean" ? outline : outline;
-            wordWrap = wordWrap || this.wordWrap;
-        }
-        Text.draw(arg1, arg2, scale, color, font, alignment, dropShadow, outline, wordWrap, resolution);
-    }
-}