comunidadmancos / es_extended

ESX Legacy fork, for use with Ox Inventory only.

ESX Legacy - Overextended

A fork of ESX Legacy for compatibility with Ox Inventory, and built-in support for NPWD

This is likely to break compatibility with some resources if they rely on removed features (i.e. loadouts, the standard inventory menu), or directly access ESX tables that have been removed from the exported ESX object. I'm also not really concerned with the general cleanliness/organisation of the repo, and did move some functions around arbitarily for the fraction of an improvement to memory and CPU usage.

We don't intend on actively updating or adding new features, but are always open to non-breaking pull requests and fixes.

Compatibility issues

• Loadouts do not exist, and inventory data-structure is altered
• Player inventory is not stored as an array, but rather key-value pairs based on slot
  • you will need to use pairs over ipairs and for loops
• ESX.Items no longer exists, and such information should be retrieved with exports.ox_inventory:Items()
• If you encounter an issue then post the relevant information.

Non-breaking changes

• Upgrade to oxmysql MySQL syntax and functions
• Agressive use of prepared statements when loading and saving players
• Remove dependency on the async resource (it's awful)
• Removed several internal functions and tables from the ESX table

client: CurrentRequestId, ServerCallbacks, TimeoutCallbacks
server: RegisteredCommands, SavePlayer, SavePlayers
server: UsableItemsCallbacks, TimeoutCount, CancelledTimeouts
server: ServerCallbacks, TriggerServerCallback

• Added a few OneSync RPC functions, which should operate somewhat similarly to the client versions
• Remove the exploitable spawnVehicle and deleteVehicle events from the client (updated commands to use RPC)
• Added new functions to the shared object

ESX.GetJobs
ESX.GetUsableItems

• Integrated support for New Phone Who Dis (you still need to change config)
• Overcomplicated convars, to get people used to the idea
• Adds principal permissions for a players job
• Removes the functionality of several xPlayer functions (placeholders left for compatibility)

self.getLoadout
self.addWeapon
self.addWeaponComponent
self.addWeaponAmmo
self.updateWeaponAmmo
self.setWeaponTint
self.getWeaponTint
self.removeWeapon
self.removeWeaponComponent
self.removeWeaponAmmo
self.hasWeaponComponent
self.hasWeapon
self.getWeapon

ESX Legacy

ESX is the most popular framework for creating economy-based roleplay servers on FiveM, with many official and community resources designed to utilise the tools provided here. For a taste of what's available:

esx_identity: Enables character registration defining a players name, sex, height, and date of birth

esx_society: Allows job resources to register a society, gaining employee management, society funds, and more

esx_billing: Allows members of some societies to send fines or bills to other players

esx_vehicleshop: Allow players to purchase vehicles from a dealership, or setup society support for a player-managed dealership

esx_ambulancejob: Adds a death and respawn system while allowing players to work as EMS to heal and revive others

Many more resources are included in this repository, or you can browse the ESX Community Github or Cfx.re Releases board for more.

Information

Legacy provides some necessary bug-fixes and improvements to optimise the framework before reaching the end of official support by the development team.

Most resources designed for 1.2 will have no issues with Legacy, notable exceptions are those which modify spawning/loading behaviour. There are several minor feature updates which do not impact compatibility with old resources.

Optimisation

• Utilise compile-time jenkins hashing over the GetHashKey native
• Update old MySQL queries to use MySQL.store to improve performance, especially during player saving
• Several loops will now sleep when their tasks are not necessary to perform
• Improved support when using ESX Identity to reduce events and queries during player login
• Support for the latest weapons and components

Features

• Integrated support for identity data
• Integrated commands from esx_adminplus
• All players will be saved immediately before a txAdmin scheduled restart
• Detect if a player is new and send the result to the playerLoaded event
• Support for players logging out when using multicharacter resources
• Cache the players ped id and death state in ESX.PlayerData
• Added an imports file (similar to locales.lua) for setting up events and functions in other resources
  • Before defining all manifest script files, add shared_script '@es_extended/imports.lua'
  • Automatically retrieve the ESX object, removing the need to send a callback event on both the client and server
  • Ensures current information is always returned when using ESX.PlayerData (except loadout and inventory)
• Spawnmanager is being utilised to correctly handle player spawns
  • Potential conflicts with some third-party resources that do not expect spawnmanager
• Added an improved function when performing xPlayer loops to prevent large server hitches
  • Using ESX.GetExtendedPlayers() instead of ESX.GetPlayers()
  • You can use arguments with the new function as well, such as
    • ESX.GetExtendedPlayers('job', 'police')
    • ESX.GetExtendedPlayers('group', 'admin')

Fixes

• ESX.Jobs table is populated after all jobs are setup, allowing other resources to retrieve it if needed
• All weapons are properly removed when using the clearloadout command

For creating or updating resources refer to the updated boilerplate.

1.2 Features

• Weight based inventory system
• Weapons support, including support for attachments and tints
• Supports different money accounts (defaulted with cash, bank and black money)
• Many official resources available in our GitHub
• Job system, with grades and clothes support
• Supports multiple languages, most strings are localized
• Easy to use API for developers to easily integrate ESX to their projects
• Register your own commands easily, with argument validation, chat suggestion and using FXServer ACL

Requirements

• All resources from the core folder
• spawnmanager
• mysql-async

Installation

• Download files to the resources folder and, if desired, prepare directories for organisation (i.e. resources/[core]/es_extended)
• Import es_extended.sql in your database
• Import any other sql files for the resources you are using
• Ensure all resources config files have been adjusted for your preferences
• Use or refer to the included server.cfg for start order and settings

Conflicts

• The following resources should not be used with ESX Legacy
  • essentialmode
  • basic-gamemode
  • fivem-map-skater
  • fivem-map-hipster
  • default_spawnpoint

Information

ESX was initially developed by Gizz back in 2017 for his friend as the were creating an FiveM server and there wasn't any economy roleplaying frameworks available. The original code was written within a week or two and later open sourced, it has ever since been improved and parts been rewritten to further improve on it.

• ESX Documentation
• FiveM Native Reference

Legal

License

es_extended - ESX framework for FiveM

Copyright (C) 2015-2021 Jérémie N'gadi

This program Is free software: you can redistribute it And/Or modify it under the terms Of the GNU General Public License As published by the Free Software Foundation, either version 3 Of the License, Or (at your option) any later version.

This program Is distributed In the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty Of MERCHANTABILITY Or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License For more details.

You should have received a copy Of the GNU General Public License along with this program. If Not, see http://www.gnu.org/licenses/.