@nativewrappers/common 0.0.64 → 0.0.75

package/GlobalData.d.ts

@@ -4,4 +4,5 @@ export declare class GlobalData {
     static IS_CLIENT: boolean;
     static NetworkTick: number | null;
     static NetworkedTicks: any[];
+    static EnablePrettyPrint: boolean;
 }

package/README.md

@@ -0,0 +1,45 @@
+<h1 align="center">Monorepo for a FiveM server/client wrapper</h1>
+
+<p align="center">
+	<i>🔥 A Javascript/Typescript package for FiveM resource development 🎮</i>
+  <br>
+  <small>This project is in no way affiliated with FiveM or the Cfx.re Collective.</small>
+  </br></br>
+  <a href="https://github.com/nativewrappers/nativewrappers/blob/master/LICENSE">
+    <img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat" alt="License: MIT">
+  </a>
+  <a href="https://www.npmjs.com/package/@nativewrappers/fivem">
+    <img src="https://img.shields.io/npm/v/@nativewrappers/fivem?style=flat" alt="npm version">
+  </a>
+  <a href="https://www.npmjs.com/package/@nativewrappers/fivem">
+    <img src="https://img.shields.io/npm/dm/@nativewrappers/fivem?style=flat">
+  </a>
+  <a href="https://github.com/nativewrappers/nativewrappers/actions/workflows/config.yml">
+    <img src="https://github.com/nativewrappers/nativewrappers/actions/workflows/config.yml/badge.svg" alt="Workflow Status">
+  </a>
+  <a href="https://github.com/nativewrappers/nativewrappers/commits/master">
+    <img src="https://img.shields.io/github/last-commit/nativewrappers/fivem.svg?style=flat" alt="Last commit">
+  </a>
+</p>
+
+<h3 align="center">This project is currently iterating rapidly, there will be breaking changes.</h3>
+
+<p align="center">
+	<h2 align="center"><a href="https://github.com/nativewrappers/nativewrappers/tree/main/docs">Documentation</a></h2>
+	<!-- <a href="https://forum.fivem.net/t/fivem-js-v1-3-2-javascript-typescript-wrapper-now-with-menu-class-nativeui/268640">Forum</a> -->
+</p>
+
+## Features
+
+- No runtime dependencies
+- Entity management through class objects (i.e. `Vehicle` and `Ped` entities)
+- Server and Client side variants on wrapper
+
+
+## Download & Install
+```
+pnpm add @nativewrappers/redm # for redm,
+pnpm add @nativewrappers/fivem # for fivem
+pnpm add @nativewrappers/common # for any, should be game agnostic, provides Vector3, decors, kvps, helper functions, etc
+pnpm add @nativewrappers/server # for server
+```

package/decors/Events.d.ts

@@ -4,11 +4,51 @@ export declare enum ConVarType {
     Float = 2,
     Boolean = 3
 }
+/**
+ * Disables pretty printing in error messages
+ */
+export declare const DisablePrettyPrint: () => boolean;
 export declare function Exports(exportName: string): (originalMethod: any, context: ClassMethodDecoratorContext) => void;
+/**
+ * Registers the Event call for {@link eventName} to this method.
+ *
+ * This has internal pretty-printing to make errors easier to track, if
+ * you want to disable this you will need to call {@link DisablePrettyPrint}, or if you're
+ * using esbuild you can add `REMOVE_EVENT_LOG` to your drop label {@link https://esbuild.github.io/api/#drop-labels}
+ *
+ * @param eventName the event to bind to
+ */
 export declare function Event(eventName: string): (originalMethod: any, context: ClassMethodDecoratorContext) => void;
+/**
+ * Registers the Net Event call for {@link eventName} to this method
+ *
+ *
+ * This has internal pretty-printing to make errors easier to track, if
+ * you want to disable this you will need to call {@link DisablePrettyPrint}, or if you're
+ * using esbuild you can add `REMOVE_EVENT_LOG` to your drop label {@link https://esbuild.github.io/api/#drop-labels}
+ *
+ * @param eventName the event to bind this net event to
+ * @param remoteOnly if the event should only accept remote calls, if set to true it will ignore any local call via `emit`, defaults to true
+ */
 export declare function NetEvent(eventName: string, remoteOnly?: boolean): (originalMethod: any, context: ClassMethodDecoratorContext) => void;
+/**
+ * Registers the NUI Event call for {eventName} to this method, the function signature
+ * should be (data: unknown, cb: (data?: any) => void) => void
+ * You shoud always execute `cb` with 'ok' if you don't want to send data back to
+ * the UI, otherwise you'll cause a network error for the `fetch` request
+ * @param eventName the event this will listen for
+ */
 export declare function NuiEvent(eventName: string): (originalMethod: any, context: ClassMethodDecoratorContext) => void;
 type DeserializeFn<T> = (data: T) => unknown;
-export declare function ConVar<T>(name: string, is_floating_point?: boolean, deserialize?: DeserializeFn<T>): (_initialValue: any, context: ClassFieldDecoratorContext, ...args: any[]) => void;
+/**
+ * Gets the specified `ConVar`s value, this will bind to the param.
+ * @param name the convar name
+ * @param is_floating_point if the convar is floating point, this should be explicitly set to true if your convar will be a float
+ */
+export declare function ConVar<T>(name: string, is_floating_point?: boolean, deserialize?: DeserializeFn<T>): (_initialValue: any, context: ClassFieldDecoratorContext, ..._args: any[]) => void;
+/**
+ * Gets called per server/client tick, this is asyncronous though, if you await
+ * in it, it will not be called until whatever was being awaited resolves.
+ */
 export declare function SetTick(): (originalMethod: any, context: ClassMethodDecoratorContext) => void;
 export {};