Skip to content

Commit 3ea3082

Browse files
committed
Update README.md
1 parent d6116ad commit 3ea3082

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,27 @@ Don's Utility Functions for FiveM
55
## Description
66

77
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`.
923

1024
## Table of Contents
1125

1226
- [duff](#duff)
1327
- [Description](#description)
28+
- [Features](#features)
1429
- [Table of Contents](#table-of-contents)
1530
- [Credits](#credits)
1631
- [Installation](#installation)
@@ -131,7 +146,8 @@ Well, this is the solution for you! This is a collection of *optimised utility f
131146
- [Support](#support)
132147
- [Changelog](#changelog)
133148

134-
<!-- [x] Document Various Function Calls -->
149+
<!-- [x] Update #Description & Add #Features -->
150+
<!-- [ ] Add descriptions to Methods & Notes Needed -->
135151

136152
## Credits
137153

0 commit comments

Comments
 (0)