starred/esx_core-esx-framework
1
0
Fork 0
mirror of https://github.com/esx-framework/esx_core.git synced 2026-09-04 16:23:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

build: new repos

Browse Source
This commit is contained in:
Benzo
2023-01-18 15:06:15 +01:00
parent 4267f1d915
commit cfb8e742e4
973 changed files with 1226 additions and 81196 deletions
Download Patch File Download Diff File Expand all files Collapse all files
esx_example/README.md
-51
View File
@@ -1,51 +0,0 @@
### ESX Imports
##### Similar to importing the ESX locale functions or MySQL-Async, there is now an import for ESX
- Define `shared_script '@es_extended/imports.lua'` above all other scripts in your fxmanifest
- This will define the ESX object for both the client and server
##### The following event handler will also be created on the client
```lua
AddEventHandler('esx:setPlayerData', function(key, val)
if GetInvokingResource() == 'es_extended' then
ESX.PlayerData[key] = val
if OnPlayerData ~= nil then OnPlayerData(key, val) end
end
end)
```
- You will now receive updated ESX.PlayerData values whenever they change
- This does not include inventory or loadout data and it should still be retrieved with `ESX.GetPlayerData()`
- You can add your own functions to the import if you believe they will be useful in your resources
- You can trigger certain events or functions based on the key and value received (example in client.lua)
- The idea of this function is ensuring up-to-date values for `job, accounts, ped, and dead`
- You can set any data this way if you want to share it between resources
- Using `ESX.SetPlayerData('cuffed', true)` will create and set a new value that you can now reference anywhere
- If you are using OneSync you could set certain values to set a state bag (useful for other players to reference)
### Replacement for ESX.GetPlayers()
##### Old resources would utilise the ESX.GetPlayers() function in a loop with ESX.GetPlayerFromId() to retrieve xPlayer data
- This can be referred to as an xPlayer loop, and has been the cause for server hitches in resources such as esx_society and esx_status
- It is commonly used in robbery scripts to get the active number of cops, or for determining the number of EMS in other places
##### This method is outdated and should be replaced if you are using ESX Legacy
```lua
local xPlayers = ESX.GetPlayers()
for i=1, #xPlayers, 1 do
local xPlayer = ESX.GetPlayerFromId(xPlayers[i])
if xPlayer.job.name == 'police' then
TriggerClientEvent('esx:showNotification', xPlayers[i], 'You are a cop!')
end
end
```
##### This new method retrieves all xPlayer data at once, reducing the number of function references being called
```lua
local xPlayers = ESX.GetExtendedPlayers() -- Returns all xPlayers
for _, xPlayer in pairs(xPlayers) do
if xPlayer.job.name == 'police' then
TriggerClientEvent('esx:showNotification', xPlayer.source, 'You are a cop!')
end
end
local xPlayers = ESX.GetExtendedPlayers('job', 'police') -- Returns xPlayers with the police job
for _, xPlayer in pairs(xPlayers) do
TriggerClientEvent('esx:showNotification', xPlayer.source, 'You are a cop!')
end
```