duff

Don's Utility Functions for FiveM

Description

Has you're script gone up the duff? 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.

Features

Package A recreation of the Lua package library in pure lua, allowing you to import and use modules in your scripts.
Array: A FP array class for the creation and manipulation of consecutive integer indexed arrays, similar to the Array class in JavaScript.
Await: A function that allows you to call and await a functions return values, using promises.
Bench: Benches the performance of a function, and returns the time taken to execute the function.
Bridge: Provides common functions between different frameworks and libraries for use in creating cross-framework scripts.
Interval: A class for creating and managing intervals, allowing you to start, pause, stop and resume timers on threads.
Locale: A localisation and translation module, based on the i18n.lua library by kikito.
Math: An addition to the lua math library, expanding of some of the functions and adding some new ones. Most notably, an improved math.random function.
Vector: A vector class for the creation and manipulation of vectors, as well as exposing functions to the server environment not normally available.
Blips: A blip helper class for managing blips, aiding in the retrieval and removal of blips.
Pools: A pool class for managing pools, aiding in the retrieval of peds, vehicles, objects and pickups.
Scaleform: A scaleform class for managing scaleforms, aiding in the creation and manipulation of scaleforms.
Streaming: A streaming class for loading various game assets, including animations, audio, collisions, ipls, models and ptfx.
Scope: A scope class for manipulating players scopes, allowing triggering events around a player and their scope.
Zone: A server-side zone class for GTA V's map zones, allowing you to check if a player is in a specific zone, and trigger events based on that.

duff
- Description
- Features
- Table of Contents
- Credits
- Installation
  - Dependencies (CBridge Users)
  - Initial Setup
- Documentation
  - Check Version
  - Importing CDuff
  - CArray
    - Importing CArray
    - Internal Methods
    - isarray
    - push
    - pusharray
    - peek
    - peekarray
    - pop
    - poparray
    - contains (array)
    - copy
    - find
    - foldleft
    - foldright
    - setenum
    - map
    - filter
    - foreach
    - reverse
  - await
    - Importing await
    - await (function)
  - bench
    - Importing bench
    - bench (function)
  - CBridge
  - CInterval
    - Importing CInterval
    - interval
    - create
    - start
    - pause
    - stop
    - resume
    - update
    - destroy
  - CKDTree
    - Importing CKDTree
    - new
    - build (kdtree)
    - insert
    - contains
    - remove
    - neighbour
    - neighbours
    - range
    - tofile
    - fromfile
  - CLocale
    - Importing CLocale
    - set
    - load
    - loadfile
    - translate
    - doeskeyexist
  - CMath
    - Importing the CMath
    - between
    - clamp
    - gcd
    - ishalf
    - isint
    - lerp
    - round
    - sign
    - seedrng
    - random
    - timer
    - tofloat
    - toint
    - toratio
  - CPackage
    - Importing CPackage
    - path
    - preload
    - loaded
    - loaders
    - searchpath
    - require
    - import
    - as
      - as - Example
  - CPools
  - CVector
  - trace
    - Importing trace
    - trace (function)
  - CBlips
    - Importing CBlips
    - getall
    - onscreen
    - bycoords
    - bysprite
    - bytype
    - getblips
    - getinfo
    - remove (blips)
  - CScaleform
  - CStreaming
  - CScopes
  - CMapZones

Credits

overextended
0xWaleed
negbook
VenomXNL
Swkeep
draobrehtom
[DurtyFrees' Data Dumps](https://github.com/Durty

Duff

Install / Use

README

duff

Description

Features

Table of Contents

Credits