pma-locals 1.0.7 → 1.0.9

package/README.md

@@ -1,19 +1,13 @@
-# pma-locals
-
-Modern TypeScript library for managing RedM ped spawning and animations.
-
-## Installation
-
 ```bash
 npm install pma-locals
 # or
 pnpm add pma-locals
 ```
 
-## Usage
+## Quick Start
 
 ```typescript
-import { registerPed, processSpawning } from "pma-locals";
+import { registerPed, processSpawning, cleanupPeds } from "pma-locals";
 import { Vector3, Delay } from "@nativewrappers/redm";
 
 // Register a ped with animation
@@ -22,6 +16,7 @@ registerPed(
 	new Vector3(-297.74, 791.1, 118.4), // spawn coords
 	180.0, // heading
 	50.0, // spawn distance (optional, default: 100.0)
+	true, // disable collisions
 	{
 		dict: "amb_wander@world_human_smoke@male@male_a@idle_a",
 		anim: "idle_a",
@@ -31,47 +26,86 @@ registerPed(
 
 // In your game loop
 setTick(async () => {
-	const playerPed = PlayerPedId();
-	if (!playerPed) return;
+	const playerPed = Game.PlayerPed;
 
-	const coords = GetEntityCoords(playerPed, true, true);
-	const playerPos = new Vector3(coords[0], coords[1], coords[2]);
-
-	await processSpawning(playerPos);
+	await processSpawning(playerPed.Position);
 	await Delay(500);
 });
+
+// Cleanup on resource stop
+on("onResourceStop", (resourceName: string) => {
+	if (resourceName === GetCurrentResourceName()) {
+		cleanupPeds();
+	}
+});
 ```
 
-## API
+## API Reference
 
 ### `registerPed(modelName, coords, heading, spawnDistance?, animation?, propData?)`
 
-Register a ped to spawn when players approach.
+Register a ped to spawn when players are within range.
 
 **Parameters:**
 
 -   `modelName` (number): Model hash
 -   `coords` (Vector3): Spawn coordinates
--   `heading` (number): Ped heading direction
--   `spawnDistance` (number): Distance threshold (default: 100.0)
--   `animation` (Animation): Optional animation data
--   `propData` (Props): Optional prop attachment
+-   `heading` (number): Ped heading direction (0-360)
+-   `spawnDistance?` (number): Distance threshold (default: 100.0)
+-   `collisions?` (boolean): Optional collision handler
+-   `animation?` (Animation): Optional animation config
+    -   `dict` (string): Animation dictionary
+    -   `anim` (string): Animation name
+-   `propData?` (Props): Optional prop attachment
+    -   `model` (string): Prop model hash
+    -   `boneId` (number): Bone to attach to
+    -   `offset` (number[]): Position offset [x, y, z]
+    -   `rotation` (number[]): Rotation [x, y, z]
 
 ### `processSpawning(playerPos: Vector3)`
 
-Update ped spawning based on player position. Call this in your game loop.
+Process ped spawning/despawning based on player position. Call this regularly in your game loop (e.g., every 500ms).
 
 ### `cleanupPeds()`
 
-Delete all spawned peds (useful for resource cleanup).
+Delete all spawned peds. Use this when your resource stops to clean up entities.
+
+## TypeScript Support
+
+Full type definitions are included. Import types as needed:
 
-## Types
+```typescript
+import type { PedConfig, Animation, Props } from "pma-locals";
+```
+
+**Exported Types:**
+
+-   `PedConfig` - Complete ped configuration
+-   `Animation` - Animation data structure
+-   `Props` - Prop attachment configuration
+
+## Development
+
+```bash
+# Install dependencies
+pnpm install
+
+# Build package (creates dist/ with .js and .d.ts files)
+pnpm build:package
+
+# RedM development mode (watch)
+pnpm watch
+
+# Publish to npm
+npm version patch
+pnpm publish
+```
 
-Full TypeScript support with exported types:
+**Built with:**
 
--   `PedConfig`
--   `Animation`
--   `Props`
+-   [tsup](https://tsup.egoist.dev/) - TypeScript bundler
+-   [esbuild](https://esbuild.github.io/) - Fast JavaScript bundler
+-   [@nativewrappers/redm](https://www.npmjs.com/package/@nativewrappers/redm) - RedM type definitions
 
 ## License
 

package/dist/index.d.ts

@@ -17,10 +17,11 @@ interface PedConfig {
     coords: Vector3;
     heading: number;
     spawnDistance: number;
+    collisions?: boolean;
     animation?: Animation;
     propData?: Props;
 }
-declare function registerPed(modelName: string, coords: Vector3, heading: number, spawnDistance?: number, animation?: Animation, propData?: Props): void;
+declare function registerPed(modelName: string, coords: Vector3, heading: number, spawnDistance?: number, collisions?: boolean, animation?: Animation, propData?: Props): void;
 declare function processSpawning(playerPos: Vector3): Promise<void>;
 declare function cleanupPeds(): void;
 

package/dist/index.js

@@ -3,12 +3,13 @@ import { createPed, Model, IkControlFlags, createProp } from '@nativewrappers/re
 // client/ped-handler.ts
 var pedConfigs = [];
 var activePeds = /* @__PURE__ */ new Map();
-function registerPed(modelName, coords, heading, spawnDistance = 100, animation, propData) {
+function registerPed(modelName, coords, heading, spawnDistance = 100, collisions, animation, propData) {
   pedConfigs.push({
     modelName,
     coords,
     heading,
     spawnDistance,
+    collisions,
     animation,
     propData
   });
@@ -40,7 +41,9 @@ async function spawnPed(config, key) {
   SetRandomOutfitVariation(ped.Handle, true);
   ped.IsPositionFrozen = true;
   SetEntityInvincible(ped.Handle, true);
-  SetEntityCollision(ped.Handle, false, false);
+  if (config.collisions) {
+    SetEntityCollision(ped.Handle, false, false);
+  }
   SetBlockingOfNonTemporaryEvents(ped.Handle, true);
   if (config.heading) {
     ped.Heading = config.heading;
@@ -59,7 +62,7 @@ async function spawnPed(config, key) {
   }
   let prop = null;
   if (config.propData) {
-    prop = await createProp(new Model(config.propData.model), ped.Position, 0, true, true);
+    prop = await createProp(new Model(config.propData.model), ped.Position, 0, false, true);
     if (prop) {
       AttachEntityToEntity(
         prop.Handle,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pma-locals",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "RedM ped spawning and management library with TypeScript support",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",