chore: add more descriptions for virtual entity API (#307)

altmp · Mar 14, 2024 · c860406 · c860406
1 parent bf4425c
commit c860406
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 5 deletions.
diff --git a/client/index.d.ts b/client/index.d.ts
@@ -594,17 +594,26 @@ declare module "alt-client" {
     public setMeta<V extends any, K extends string = string>(key: K, value: shared.InterfaceValueByKey<ICustomBaseObjectMeta, K, V>): void;
   }
 
+  /** [Documentation](https://docs.altv.mp/articles/virtualentity.html) */
   export class VirtualEntityGroup extends BaseObject {
-    /** Creates a new Virtual Entity Group */
+    /**
+     * Creates a new Virtual Entity Group
+     *
+     * @param maxEntitiesInStream Max number of entities per player stream. [More info](https://docs.altv.mp/articles/virtualentity.html#what-is-max-number-of-entities-per-player-stream).
+     */
     public constructor(maxEntitiesInStream: number);
 
     /** Returns all Virtual Entity Group instances */
     public static readonly all: readonly VirtualEntityGroup[];
 
-    /** Maximum streaming range of the Virtual Entity Group */
+    /**
+     * Max number of entities per player stream.
+     * [More info](https://docs.altv.mp/articles/virtualentity.html#what-is-max-number-of-entities-per-player-stream).
+     */
     public readonly maxEntitiesInStream: number;
   }
 
+  /** [Documentation](https://docs.altv.mp/articles/virtualentity.html) */
   export class VirtualEntity extends WorldObject {
     /** Creates a new Virtual Entity */
     public constructor(group: VirtualEntityGroup, position: shared.Vector3, streamingDistance: number, data?: Record<string, any>);

diff --git a/server/index.d.ts b/server/index.d.ts
@@ -727,21 +727,26 @@ declare module "alt-server" {
     public pos: shared.Vector3;
   }
 
-  /** https://docs.altv.mp/articles/virtualentity.html */
+  /** [Documentation](https://docs.altv.mp/articles/virtualentity.html) */
   export class VirtualEntityGroup extends BaseObject {
-    /** Creates a new Virtual Entity Group */
+    /**
+     * Creates a new Virtual Entity Group
+     *
+     * @param maxEntitiesInStream Max number of entities per player stream. [More info](https://docs.altv.mp/articles/virtualentity.html#what-is-max-number-of-entities-per-player-stream).
+     */
     public constructor(maxEntitiesInStream: number);
 
     /** Returns all Virtual Entity Group instances */
     public static readonly all: readonly VirtualEntityGroup[];
 
     /**
      * Max number of entities per player stream.
-     * More info: https://docs.altv.mp/articles/virtualentity.html#what-is-max-number-of-entities-per-player-stream
+     * [More info](https://docs.altv.mp/articles/virtualentity.html#what-is-max-number-of-entities-per-player-stream).
      */
     public readonly maxEntitiesInStream: number;
   }
 
+  /** [Documentation](https://docs.altv.mp/articles/virtualentity.html) */
   export class VirtualEntity extends WorldObject {
     /** Creates a new Virtual Entity */
     public constructor(group: VirtualEntityGroup, position: shared.Vector3, streamingDistance: number, data?: Record<string, any>);