lenix 1.7.0 → 1.7.2

package/client/blip.ts

@@ -2,7 +2,6 @@
 
 import type { Vec4 } from '../shared/types.ts'
 
-
 export interface Blip {
 	/**
 	 * Blip world coordinates and heading.

package/client/client.ts

@@ -0,0 +1,137 @@
+import type { Vec3, Vec4 } from '../shared/types.ts'
+
+
+export const client: {
+	entity: {
+		handle: (entityNetId?: number) => number
+		netId: (entity?: number) => number
+		coords: {
+			(excludeH: true, entity?: number, isAlive?: boolean): Vec3;
+			(excludeH?: false, entity?: number, isAlive?: boolean): Vec4
+		}
+		teleport: (
+			x: number,
+			y: number,
+			z: number,
+			h?: number,
+			entity?: number,
+			clearArea?: boolean,
+			alive?: boolean,
+			deadDisable?: boolean,
+			ragdol?: boolean
+		) => void
+	}
+	player: {
+		serverId: (playerId?: number) => number
+		id: (serverId?: number) => number
+		storage: {
+			set: <T extends string>(key: T, value: string) => void
+			get: <T extends string>(key: T) => string
+			delete: <T extends string>(key: T) => void
+		}
+	}
+} = {
+	entity: {
+		/**
+		 * Gets the local entity handle from a network ID.
+		 *
+		 * Network IDs are shared, but entity handles are local.
+		 * The returned handle is only valid on the current machine.
+		 *
+		 * If no network ID is provided, this resolves your own player ped
+		 * by first getting its network ID.
+		 *
+		 * Examples:
+		 * - entity(vehicleNetId) -> local vehicle handle
+		 * - entity(pedNetId) -> local ped handle
+		 * - entity() -> your own player ped handle
+		 */
+		handle: (entityNetId = client.entity.netId()) => NetworkGetEntityFromNetworkId(entityNetId),
+
+		/**
+		 * Gets the network ID for an entity.
+		 *
+		 * Entity handles are local to the current machine.
+		 * Network IDs are shared references for networked entities.
+		 *
+		 * If no entity is provided, this uses your own player ped.
+		 *
+		 * Examples:
+		 * - netId(vehicle) -> network ID of that vehicle
+		 * - netId(targetPed) -> network ID of that ped
+		 * - netId() -> network ID of your own player ped
+		 */
+		netId: (entity = PlayerPedId()) => NetworkGetNetworkIdFromEntity(entity),
+
+		/**
+		 * Gets entity coordinates and heading.
+		 */
+		coords: (() => {
+			function coords(excludeH: true, entity?: number, isAlive?: boolean): Vec3
+			function coords(excludeH?: false, entity?: number, isAlive?: boolean): Vec4
+			function coords(excludeH = false, entity = client.entity.handle(), isAlive = true) {
+				const entityCoords = GetEntityCoords(entity, isAlive) as Vec3
+
+				if (excludeH) return entityCoords
+
+				return [
+					...entityCoords,
+					GetEntityHeading(entity)
+				]
+			}
+
+			return coords
+		})(),
+
+		teleport: (
+			x: number,
+			y: number,
+			z: number,
+			h?: number,
+			entity = client.entity.handle(),
+			clearArea = false,
+			alive = true,
+			deadDisable = false,
+			ragdol = false
+		) => {
+			SetEntityCoords(entity, x, y, z, alive, deadDisable, ragdol, clearArea)
+			SetEntityHeading(entity, h ?? client.entity.coords()[3])
+		}
+	},
+	player: {
+		/**
+		 * Gets a client player ID.
+		 *
+		 * If a server ID is provided, this converts that server ID into a client
+		 * player ID on the current client.
+		 *
+		 * If no server ID is provided, this returns your own client player ID.
+		 *
+		 * Examples:
+		 * - id(targetServerId) -> target player's client player ID
+		 * - id() -> your own client player ID
+		 */
+		id: (serverId?: number) => serverId ? GetPlayerFromServerId(serverId) : PlayerId(),
+
+		/**
+		 * Gets a player's server ID from their client player ID.
+		 *
+		 * Client player IDs are local to each client.
+		 * Server IDs, also called source IDs, identify connected players on the server.
+		 *
+		 * If no client player ID is provided, this uses your own client player ID.
+		 *
+		 * Examples:
+		 * - serverId(targetPlayerId) -> target player's server ID
+		 * - serverId() -> your own server ID
+		 */
+		serverId: (playerId = client.player.id()) => GetPlayerServerId(playerId),
+
+		storage: {
+			set: <T extends string>(key: T, value: string) => SetResourceKvp(key, value),
+			get: <T extends string>(key: T) => GetResourceKvpString(key),
+			delete: <T extends string>(key: T) => DeleteResourceKvp(key)
+		}
+	}
+}
+

package/client/index.ts

@@ -11,5 +11,5 @@ export * from './blip.ts'
 export * from './cam.ts'
 export * from './nearest.ts'
 export * from './pool.ts'
-export * from './entity.ts'
 export * from './timer.ts'
+export * from './client.ts'

package/client/nearest.ts

@@ -51,9 +51,9 @@ const player = (
 			const playerPed = GetPlayerPed(playerId)
 			// deno-lint-ignore no-boolean-literal-for-arguments
 			const vehicle = GetVehiclePedIsIn(playerPed, false)
-			const playerCoords: Vec3 = (
-				vehicle === 0 ? getEntity.coords(true, playerPed) : GetWorldPositionOfEntityBone(playerPed, 0) as Vec3
-			)
+			const playerCoords: Vec3 = vehicle === 0
+				? getEntity.coords(true, playerPed)
+				: GetWorldPositionOfEntityBone(playerPed, 0) as Vec3
 
 			const distance = Vdist(
 				coords[0],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lenix",
-  "version": "1.7.0",
+  "version": "1.7.2",
   "description": "Typed FiveM utilities for client, server, shared, and NUI scripts",
   "author": "Lenix",
   "license": "MIT",

package/server/index.ts

@@ -3,3 +3,5 @@
  *
  * FiveM server-side helpers.
  */
+
+export * from './server'

package/server/server.ts

@@ -0,0 +1,11 @@
+export const server: {
+	entity: {
+		handle: (netId: number) => number;
+		handleFromSource: (source: number) => number;
+	};
+} = {
+	entity: {
+		handle: (netId: number) => NetworkGetEntityFromNetworkId(netId),
+		handleFromSource: (source: number) => GetPlayerPed(source.toString())
+	}
+}

package/shared/types.ts

@@ -23,7 +23,6 @@ export type Request<
 > = Params extends readonly unknown[] ? never
 	: [Response, Id, Params]
 
-	
 /**
  * Internal NUI requests used by Lenix helpers. DO NOT USE
  */
@@ -33,4 +32,3 @@ export interface _InternalRequests {
 		cursor: boolean
 	}>
 }
-	

package/client/entity.ts

@@ -1,22 +0,0 @@
-// deno-lint-ignore-file no-undef
-import type { Vec3, Vec4 } from '../shared/types.ts'
-
-/**
- * Gets entity coordinates and heading.
- */
-function coords(excludeH: true, entity?: number, isAlive?: boolean): Vec3
-function coords(excludeH?: false, entity?: number, isAlive?: boolean): Vec4
-function coords(excludeH = false, entity = PlayerPedId(), isAlive = true): Vec3 | Vec4 {
-	const entityCoords = GetEntityCoords(entity, isAlive) as Vec3
-
-	if (excludeH) return entityCoords
-
-	return [
-		...entityCoords,
-		GetEntityHeading(entity)
-	]
-}
-
-export const getEntity = {
-	coords
-}