lenix 1.8.14 → 1.8.16

package/README.md

@@ -0,0 +1 @@
+![NPM Downloads](https://img.shields.io/npm/d18m/lenix)

package/client/cam.ts

@@ -1,4 +1,4 @@
-import type { Vec4 } from '../shared/types.ts'
+import type { Vec2, Vec4 } from '../shared/types.ts'
 
 const cams = new Set<number>()
 
@@ -6,35 +6,36 @@ export interface BaseCamDetails {
 	/**
 	 * Fade-out duration in milliseconds.
 	 */
-	fadeOut?: number
+	fadeOut: number
 	/**
 	 * Fade-in duration in milliseconds.
 	 */
-	fadeIn?: number
+	fadeIn: number
 	/**
 	 * Delay before the camera state changes.
 	 */
-	delay?: number
+	delay: number
 }
 
 export interface CreateCamSettings {
 	/**
-	 * Camera coordinates and heading.
+	 * Camera coordinates and heading (0 - 180)!.
 	 */
 	coords: Vec4
+	/**
+	 * Camera offset from coordinates and heading (0 - 180)!.
+	 */
+	offset?: Vec4
 	/**
 	 * Camera vertical and horizontal rotation.
 	 */
-	rotation: {
-		vertical: number,
-		horizontal: number
-	}
+	rotation?: Vec2
 	/**
 	 * Optional camera field-of-view, rotation order, and fade settings.
 	 */
 	details?: {
-		fov?: number,
-		rotationOrder?: number
+		fov: number,
+		rotationOrder: number
 	} & BaseCamDetails
 }
 
@@ -75,27 +76,31 @@ const toggleCam = ({
  */
 const create = ({
 	coords,
-	rotation: {
-		vertical,
-		horizontal
-	},
-	details
-}: CreateCamSettings): number => {
-	const fov = details?.fov ?? 40.0,
-		fadeOut = details?.fadeOut ?? 0,
-		fadeIn = details?.fadeIn ?? 0,
-		delay = details?.delay ?? 0,
-		rotationOrder = details?.rotationOrder ?? 0
-
+	offset = [0, 0, 0, 0],
+	rotation = [0, 0],
+	details: {
+		fov,
+		fadeOut,
+		fadeIn,
+		delay,
+		rotationOrder
+	} = {
+		fov: 40.0,
+		fadeOut: 0,
+		fadeIn: 0,
+		delay: 0,
+		rotationOrder: 0
+	}
+}: CreateCamSettings): [() => void, number] => {
 	DoScreenFadeOut(fadeOut)
 	const cam = CreateCamWithParams(
 		'DEFAULT_SCRIPTED_CAMERA',
-		coords[0],
-		coords[1],
-		coords[2],
-		vertical,
-		horizontal,
-		coords[3],
+		coords[0] + offset[0],
+		coords[1] + offset[1],
+		coords[2] + offset[2],
+		rotation[0],
+		rotation[1],
+		coords[3] + offset[3],
 		fov,
 		false,
 		rotationOrder
@@ -110,7 +115,10 @@ const create = ({
 		fadeOut
 	})
 
-	return cam
+	return [
+		() => destroy({ cam, details: { delay, fadeIn, fadeOut } }),
+		cam
+	]
 }
 
 /**
@@ -118,11 +126,16 @@ const create = ({
  */
 const destroy = ({
 	cam,
-	details
+	details: {
+		fadeOut,
+		fadeIn,
+		delay
+	} = {
+		fadeOut: 0,
+		fadeIn: 0,
+		delay: 0
+	}
 }: DestroyCamSettings): void => {
-	const fadeOut = details?.fadeOut ?? 0,
-		fadeIn = details?.fadeIn ?? 0,
-		delay = details?.delay ?? 0
 
 	toggleCam({
 		cam,

package/client/client.ts

@@ -78,14 +78,14 @@ export const entity = {
 		blendIn = 2.0,
 		blendOut = 2.0,
 		duration = -1,
-		flag = 0,
+		flag = 1,
 		playbackFrom = 0.0,
 		x = false,
 		y = false,
 		z = false
 	) => {
 		RequestAnimDict(dict)
-		await repeat(() => HasAnimDictLoaded(dict), true)
+		await repeat(() => HasAnimDictLoaded(dict) ? 1 : null, 1)
 		TaskPlayAnim(ped, dict, name, blendIn, blendOut, duration, flag, playbackFrom, x, y, z)
 	},
 

package/client/event.ts

@@ -12,4 +12,8 @@ export const onEvent = <
 >(event: Event, cb: (...params: Params) => void) => {
 	addEventListener(event, cb)
 	return () => removeEventListener(event, cb)
-}
+}
+
+export const emitNetEvent = <Event extends string, Params extends unknown[]>(event: Event, ...params: Params) => emitNet(event, params)
+
+export const emitEvent = <Event extends string, Params extends unknown[]>(event: Event, ...params: Params) => emit(event, params)

package/client/nearest.ts

@@ -1,12 +1,13 @@
 import type { Vec3 } from '../shared/types.ts'
 import { entity } from './client.ts'
+import { player as client } from './client.ts'
 
 /**
  * Finds the nearest coordinates from a list.
  */
 const coords = (coords: Vec3, zones: Vec3[]): Vec3 | undefined => {
 	let closest: Vec3 | undefined
-	let closestDistance = Infinity
+	let radialSpace = Infinity
 
 	for (const zone of zones) {
 		const dx = zone[0] - coords[0]
@@ -14,8 +15,8 @@ const coords = (coords: Vec3, zones: Vec3[]): Vec3 | undefined => {
 		const dz = zone[2] - coords[2]
 		const distance = dx * dx + dy * dy + dz * dz
 
-		if (distance < closestDistance) {
-			closestDistance = distance
+		if (distance < radialSpace) {
+			radialSpace = distance
 			closest = zone
 		}
 	}
@@ -30,65 +31,44 @@ const player = (
 	coords: Vec3,
 	maxDistance = 2.0,
 	includePlayer = false
-): {
-	playerId?: number,
-	playerPed?: number,
-	playerCoords?: Vec3,
-	playerVehicle?: number
-} => {
-	const players = GetActivePlayers()
-
-	let closestId: number | undefined
-	let closestPed: number | undefined
-	let closestCoords: Vec3 | undefined
-	let closestVehicle: number | undefined
-
-	for (let i = 0; i < players.length; i++) {
-		const playerId = players[i]
-
-		if (playerId !== PlayerPedId() || includePlayer) {
+): number | null => {
+
+	let closestId
+
+	for (const playerId of GetActivePlayers() as number[]) {
+
+		if (playerId !== client.id() || includePlayer) {
 			const playerPed = GetPlayerPed(playerId)
 			const vehicle = GetVehiclePedIsIn(playerPed, false)
-			const playerCoords: Vec3 = vehicle === 0
+			const playerCoords: Vec3 =
+				vehicle === 0
 				? entity.coords(playerPed, true)
 				: GetWorldPositionOfEntityBone(playerPed, 0) as Vec3
 
-			const distance = Vdist(
-				coords[0],
-				coords[1],
-				coords[2],
-				playerCoords[0],
-				playerCoords[1],
-				playerCoords[2]
+			const distance = Math.sqrt(
+				(coords[0] - playerCoords[0]) ** 2 +
+				(coords[1] - playerCoords[1]) ** 2 +
+				(coords[2] - playerCoords[2]) ** 2
 			)
 
 			if (distance < maxDistance) {
 				maxDistance = distance
 				closestId = playerId
-				closestPed = playerPed
-				closestCoords = playerCoords
-				closestVehicle = vehicle
 			}
 		}
 	}
 
-	return {
-		playerId: closestId,
-		playerPed: closestPed,
-		playerCoords: closestCoords,
-		playerVehicle: closestVehicle
-	}
+	return closestId ?? null
 }
 
 /**
  * Finds the nearest vehicle around an entity.
  */
-const vehicle = (entityHandle: number, radialSpace: number): number | undefined => {
+const vehicle = (entityHandle: number, radialSpace: number): number | null => {
 	const coords: Vec3 = entity.coords(entityHandle, true)
 	const vehicles = GetGamePool('CVehicle') as number[]
 
-	let closest: number | undefined
-	let closestDistance = radialSpace
+	let closest: number | null = null
 
 	for (const vehicle of vehicles) {
 		const vehCoords: Vec3 = entity.coords(vehicle, true)
@@ -97,16 +77,16 @@ const vehicle = (entityHandle: number, radialSpace: number): number | undefined
 		const z = coords[2] - vehCoords[2]
 		const distance = Math.sqrt(x * x + y * y + z * z)
 
-		if (distance < closestDistance) {
-			closestDistance = distance
+		if (distance < radialSpace) {
+			radialSpace = distance
 			closest = vehicle
 		}
 	}
 
-	return closest
+	return closest ?? null
 }
 
-export const getNearest = {
+export const nearest = {
 	player,
 	vehicle,
 	coords

package/package.json

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

package/server/event.ts

@@ -13,4 +13,8 @@ export const onEvent = <
 >(event: Event, cb: (...params: Params) => void) => {
 	addEventListener(event, cb, false)
 	return () => removeEventListener(event, cb)
-}
+}
+
+export const emitNetEvent = <Event extends string, Params extends unknown[]>(event: Event, source: number, ...params: Params) => emitNet(event, source, params)
+
+export const emitEvent = <Event extends string, Params extends unknown[]>(event: Event, ...params: Params) => emit(event, params)

package/shared/timer.ts

@@ -1,16 +1,16 @@
 /**
  * Starts a client timer using FiveM game time.
  */
-export const useTimer = ({
+export const timer = ({
 	duration,
 	updateInterval,
-	onTick,
+	onInterval,
 	onEnd
 }: {
 	duration: number,
-	updateInterval: number,
-	onTick: (timeLeft: number) => void,
-	onEnd: () => void
+	updateInterval?: number,
+	onInterval: (timeLeft: number) => void,
+	onEnd?: () => void
 }): () => void => {
 	const start = GetGameTimer()
 
@@ -20,11 +20,19 @@ export const useTimer = ({
 
 		if (elapsed >= duration) {
 			clearInterval(interval)
-			onEnd()
+			try {
+				onEnd?.()
+			} catch(e) {
+				throw e
+			}
 			return
 		}
 
-		onTick(timeLeft)
+		try {
+			onInterval(timeLeft)
+		} catch(e) {
+			throw e
+		}
 	}, updateInterval)
 
 	return () => clearInterval(interval)

package/shared/types.ts

@@ -13,7 +13,7 @@ export type Vec3 = [number, number, number]
 /**
  * Two-dimensional coordinates.
  */
-export type Vec2 = [number, number, number]
+export type Vec2 = [number, number]
 
 /**
  * Typed event tuple containing an event id and positional parameters.