You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-2Lines changed: 18 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -5,12 +5,27 @@ Don's Utility Functions for FiveM
5
5
## Description
6
6
7
7
Has you're script gone up the *[duff](https://www.urbandictionary.com/define.php?term=Up%20The%20Duff)*?
8
-
Well, this is the solution for you! This is a collection of *optimised utility functions* that are exports for you to use in your scripts.
8
+
Well, this is the solution for you! This is a collection of *optimised utility modules* for FiveM, to be imported and used in your scripts. It's designed to be lightweight, and easy to use, with a focus on performance and efficiency.
9
+
10
+
## Features
11
+
12
+
-**Require:** Emulates Lua's default require function, using package.path, package.preload and package.loaded. Also precaches all modules labled as `file` in the `fxmanifest.lua` and any modules that are imported using the `require` function.
13
+
-**Array:** A class for the creation and manipulation of consecutive integer indexed arrays, providing a number of Functional Programming methods.
14
+
-**Bridge:** Provides common functions between different frameworks and libraries for use in creating cross-framework scripts.
15
+
-**Locale:** Contains functions for localisation and translation, based on the i18n.lua library by kikito.
16
+
-**Math:** Contains some useful math functions, including a `seedrng` function which generates a random seed based on the current time, and an improvement to the default lua `random` function.
17
+
-**Vector:** Contains some useful vector functions, including a `getclosest` function which finds the closest vector3 in an array to a given vector3.
18
+
-**Blips:** Contains functions for managing blips, including `getall`, `onscreen`, `bycoords`, `bysprite`, `bytype`, `getinfo` and `remove`.
19
+
-**Pools:** Contains functions for managing entity pools, including `getpeds`, `getvehicles`, `getobjects`, `getpickups`, `getclosestped`, `getclosestvehicle`, `getclosestobject` and `getclosestpickup`.
20
+
-**Streaming:** Contains functions for managing streaming, including `loadanimdict`, `loadanimset`, `loadcollision`, `loadipl`, `loadmodel` and `loadptfx`.
21
+
-**Scope:** Contains functions for managing scope, including `getplayerscope`, `triggerscopeevent`, `createsyncedscopeevent` and `removesyncedscopeevent`.
22
+
-**Zone:** Contains functions for management of map zones similar to PolyZone but is server-side only, including `contains`, `getzone`, `getzonename`, `getzoneindex`, `addzoneevent` and `removezoneevent`.
9
23
10
24
## Table of Contents
11
25
12
26
-[duff](#duff)
13
27
-[Description](#description)
28
+
-[Features](#features)
14
29
-[Table of Contents](#table-of-contents)
15
30
-[Credits](#credits)
16
31
-[Installation](#installation)
@@ -131,7 +146,8 @@ Well, this is the solution for you! This is a collection of *optimised utility f
0 commit comments