@nativewrappers/common 0.0.64 → 0.0.65

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/GlobalData.js

@@ -4,4 +4,5 @@ export class GlobalData {
     static IS_CLIENT = !GlobalData.IS_SERVER;
     static NetworkTick = null;
     static NetworkedTicks = [];
+    static EnablePrettyPrint = true;
 }

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 {};

package/decors/Events.js

@@ -1,3 +1,4 @@
+import { GlobalData } from "../GlobalData";
 export var ConVarType;
 (function (ConVarType) {
     ConVarType[ConVarType["String"] = 0] = "String";
@@ -5,6 +6,10 @@ export var ConVarType;
     ConVarType[ConVarType["Float"] = 2] = "Float";
     ConVarType[ConVarType["Boolean"] = 3] = "Boolean";
 })(ConVarType || (ConVarType = {}));
+/**
+ * Disables pretty printing in error messages
+ */
+export const DisablePrettyPrint = () => (GlobalData.EnablePrettyPrint = false);
 // TODO: Have a way to clean all of this up (maybe hook Symbol.disposable
 // somehow?)
 /*
@@ -23,8 +28,14 @@ export function Exports(exportName) {
         });
     };
 }
-/*
- * Registers the Event call for {eventName} to this method
+/**
+ * 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 function Event(eventName) {
     return function actualDecorator(originalMethod, context) {
@@ -39,6 +50,8 @@ export function Event(eventName) {
                 }
                 catch (e) {
                     REMOVE_EVENT_LOG: {
+                        if (!GlobalData.EnablePrettyPrint)
+                            return;
                         console.error(`------- EVENT ERROR --------`);
                         console.error(`Call to ${eventName} errored`);
                         console.error(`Data: ${JSON.stringify(args)}`);
@@ -50,10 +63,18 @@ export function Event(eventName) {
         });
     };
 }
-/*
- * Registers the Net Event call for {eventName} to this method
+/**
+ * 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 function NetEvent(eventName, remoteOnly = false) {
+export function NetEvent(eventName, remoteOnly = true) {
     return function actualDecorator(originalMethod, context) {
         if (context.private) {
             throw new Error("NetEvent does not work on private methods, please mark the method as public");
@@ -72,6 +93,8 @@ export function NetEvent(eventName, remoteOnly = false) {
                 }
                 catch (e) {
                     REMOVE_NET_EVENT_LOG: {
+                        if (!GlobalData.EnablePrettyPrint)
+                            return;
                         console.error(`------- NET EVENT ERROR --------`);
                         console.error(`Call to ${eventName} errored`);
                         console.error(`Caller: ${src}`);
@@ -84,11 +107,12 @@ export function NetEvent(eventName, remoteOnly = false) {
         });
     };
 }
-/*
+/**
  * 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 '' if you don't want to send data back to
+ * 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 function NuiEvent(eventName) {
     return function actualDecorator(originalMethod, context) {
@@ -113,19 +137,21 @@ const get_convar_fn = (con_var_type) => {
             return GetConvarFloat;
         case ConVarType.Boolean:
             return GetConvarBool;
+        // needed so typescript wont complain about "unreachable code" for the error below
+        default:
     }
     // never guess people wont manage to hit this
     throw new Error("Got invalid ConVarType");
 };
-/*
- * Gets the specified `ConVar`s value, do note that if you *expect* the convar
- * to be a float you should explicitly set is_floating_point, otherwise some
- * bundlers will remove the float
+/**
+ * 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 function ConVar(name, is_floating_point, deserialize) {
     // the implementation shows that this will be _initialValue, but it doesn't
     // seem to actually be???
-    return function actualDecorator(_initialValue, context, ...args) {
+    return function actualDecorator(_initialValue, context, ..._args) {
         if (context.private) {
             throw new Error("ConVar does not work on private types, please mark the field as public");
         }
@@ -166,13 +192,13 @@ export function ConVar(name, is_floating_point, deserialize) {
                 return deserialize ? deserialize(data) : data;
             };
             Reflect.set(t, context.name, get_convar_value());
-            AddConvarChangeListener(name, (con_var_name) => {
+            AddConvarChangeListener(name, () => {
                 Reflect.set(t, context.name, get_convar_value());
             });
         });
     };
 }
-/*
+/**
  * 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.
  */

package/package.json

@@ -3,7 +3,7 @@
   "description": "Native wrappers and utilities for use with Cfx.re's scripting runtimes.",
   "license": "MIT",
   "type": "module",
-  "version": "0.0.64",
+  "version": "0.0.65",
   "repository": {
     "type": "git",
     "url": "https://github.com/nativewrappers/nativewrappers.git"